pub struct UpdateClusterFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to UpdateCluster.
The UpdateCluster API allows you to modify both single-Region and multi-Region cluster configurations. With the multiRegionProperties parameter, you can add or modify witness Region support and manage peer relationships with clusters in other Regions.
Note that updating multi-region clusters requires additional IAM permissions beyond those needed for standard cluster updates, as detailed in the Permissions section.
Required permissions
- dsql:UpdateCluster
-
Permission to update a DSQL cluster.
Resources:
arn:aws:dsql:region:account-id:cluster/cluster-id
- dsql:PutMultiRegionProperties
-
Permission to configure multi-Region properties for a cluster.
Resources:
arn:aws:dsql:region:account-id:cluster/cluster-id
- dsql:GetCluster
-
Permission to retrieve cluster information.
Resources:
arn:aws:dsql:region:account-id:cluster/cluster-id - dsql:AddPeerCluster
-
Permission to add peer clusters.
Resources:
-
Local cluster:
arn:aws:dsql:region:account-id:cluster/cluster-id -
Each peer cluster: exact ARN of each specified peer cluster
-
- dsql:RemovePeerCluster
-
Permission to remove peer clusters. The dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates.
Resources:
arn:aws:dsql:*:account-id:cluster/*
- dsql:PutWitnessRegion
-
Permission to set a witness Region.
Resources:
arn:aws:dsql:region:account-id:cluster/cluster-idCondition Keys: dsql:WitnessRegion (matching the specified witness Region)
This permission is checked both in the cluster Region and in the witness Region.
-
The witness region specified in
multiRegionProperties.witnessRegioncannot be the same as the cluster's Region. -
When updating clusters with peer relationships, permissions are checked for both adding and removing peers.
-
The
dsql:RemovePeerClusterpermission uses a wildcard ARN pattern to simplify permission management during updates.
Implementations§
Source§impl UpdateClusterFluentBuilder
impl UpdateClusterFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateClusterInputBuilder
pub fn as_input(&self) -> &UpdateClusterInputBuilder
Access the UpdateCluster as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateClusterOutput, SdkError<UpdateClusterError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateClusterOutput, SdkError<UpdateClusterError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<UpdateClusterOutput, UpdateClusterError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateClusterOutput, UpdateClusterError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn identifier(self, input: impl Into<String>) -> Self
pub fn identifier(self, input: impl Into<String>) -> Self
The ID of the cluster you want to update.
Sourcepub fn set_identifier(self, input: Option<String>) -> Self
pub fn set_identifier(self, input: Option<String>) -> Self
The ID of the cluster you want to update.
Sourcepub fn get_identifier(&self) -> &Option<String>
pub fn get_identifier(&self) -> &Option<String>
The ID of the cluster you want to update.
Sourcepub fn deletion_protection_enabled(self, input: bool) -> Self
pub fn deletion_protection_enabled(self, input: bool) -> Self
Specifies whether to enable deletion protection in your cluster.
Sourcepub fn set_deletion_protection_enabled(self, input: Option<bool>) -> Self
pub fn set_deletion_protection_enabled(self, input: Option<bool>) -> Self
Specifies whether to enable deletion protection in your cluster.
Sourcepub fn get_deletion_protection_enabled(&self) -> &Option<bool>
pub fn get_deletion_protection_enabled(&self) -> &Option<bool>
Specifies whether to enable deletion protection in your cluster.
Sourcepub fn kms_encryption_key(self, input: impl Into<String>) -> Self
pub fn kms_encryption_key(self, input: impl Into<String>) -> Self
The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.
Sourcepub fn set_kms_encryption_key(self, input: Option<String>) -> Self
pub fn set_kms_encryption_key(self, input: Option<String>) -> Self
The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.
Sourcepub fn get_kms_encryption_key(&self) -> &Option<String>
pub fn get_kms_encryption_key(&self) -> &Option<String>
The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.
If you don't specify a client token, the Amazon Web Services SDK automatically generates one.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.
If you don't specify a client token, the Amazon Web Services SDK automatically generates one.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.
If you don't specify a client token, the Amazon Web Services SDK automatically generates one.
Sourcepub fn multi_region_properties(self, input: MultiRegionProperties) -> Self
pub fn multi_region_properties(self, input: MultiRegionProperties) -> Self
The new multi-Region cluster configuration settings to be applied during an update operation.
Sourcepub fn set_multi_region_properties(
self,
input: Option<MultiRegionProperties>,
) -> Self
pub fn set_multi_region_properties( self, input: Option<MultiRegionProperties>, ) -> Self
The new multi-Region cluster configuration settings to be applied during an update operation.
Sourcepub fn get_multi_region_properties(&self) -> &Option<MultiRegionProperties>
pub fn get_multi_region_properties(&self) -> &Option<MultiRegionProperties>
The new multi-Region cluster configuration settings to be applied during an update operation.
Trait Implementations§
Source§impl Clone for UpdateClusterFluentBuilder
impl Clone for UpdateClusterFluentBuilder
Source§fn clone(&self) -> UpdateClusterFluentBuilder
fn clone(&self) -> UpdateClusterFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for UpdateClusterFluentBuilder
impl !RefUnwindSafe for UpdateClusterFluentBuilder
impl Send for UpdateClusterFluentBuilder
impl Sync for UpdateClusterFluentBuilder
impl Unpin for UpdateClusterFluentBuilder
impl !UnwindSafe for UpdateClusterFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);