pub struct UpdateKeyspaceFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateKeyspace
.
Adds a new Amazon Web Services Region to the keyspace. You can add a new Region to a keyspace that is either a single or a multi-Region keyspace. Amazon Keyspaces is going to replicate all tables in the keyspace to the new Region. To successfully replicate all tables to the new Region, they must use client-side timestamps for conflict resolution. To enable client-side timestamps, specify clientSideTimestamps.status = enabled
when invoking the API. For more information about client-side timestamps, see Client-side timestamps in Amazon Keyspaces in the Amazon Keyspaces Developer Guide.
To add a Region to a keyspace using the UpdateKeyspace
API, the IAM principal needs permissions for the following IAM actions:
-
cassandra:Alter
-
cassandra:AlterMultiRegionResource
-
cassandra:Create
-
cassandra:CreateMultiRegionResource
-
cassandra:Select
-
cassandra:SelectMultiRegionResource
-
cassandra:Modify
-
cassandra:ModifyMultiRegionResource
If the keyspace contains a table that is configured in provisioned mode with auto scaling enabled, the following additional IAM actions need to be allowed.
-
application-autoscaling:RegisterScalableTarget
-
application-autoscaling:DeregisterScalableTarget
-
application-autoscaling:DescribeScalableTargets
-
application-autoscaling:PutScalingPolicy
-
application-autoscaling:DescribeScalingPolicies
To use the UpdateKeyspace
API, the IAM principal also needs permissions to create a service-linked role with the following elements:
-
iam:CreateServiceLinkedRole
- The action the principal can perform. -
arn:aws:iam::*:role/aws-service-role/replication.cassandra.amazonaws.com/AWSServiceRoleForKeyspacesReplication
- The resource that the action can be performed on. -
iam:AWSServiceName: replication.cassandra.amazonaws.com
- The only Amazon Web Services service that this role can be attached to is Amazon Keyspaces.
For more information, see Configure the IAM permissions required to add an Amazon Web Services Region to a keyspace in the Amazon Keyspaces Developer Guide.
Implementations§
Source§impl UpdateKeyspaceFluentBuilder
impl UpdateKeyspaceFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateKeyspaceInputBuilder
pub fn as_input(&self) -> &UpdateKeyspaceInputBuilder
Access the UpdateKeyspace as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateKeyspaceOutput, SdkError<UpdateKeyspaceError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateKeyspaceOutput, SdkError<UpdateKeyspaceError, 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<UpdateKeyspaceOutput, UpdateKeyspaceError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateKeyspaceOutput, UpdateKeyspaceError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn keyspace_name(self, input: impl Into<String>) -> Self
pub fn keyspace_name(self, input: impl Into<String>) -> Self
The name of the keyspace.
Sourcepub fn set_keyspace_name(self, input: Option<String>) -> Self
pub fn set_keyspace_name(self, input: Option<String>) -> Self
The name of the keyspace.
Sourcepub fn get_keyspace_name(&self) -> &Option<String>
pub fn get_keyspace_name(&self) -> &Option<String>
The name of the keyspace.
Sourcepub fn replication_specification(self, input: ReplicationSpecification) -> Self
pub fn replication_specification(self, input: ReplicationSpecification) -> Self
The replication specification of the keyspace includes:
-
regionList
- the Amazon Web Services Regions where the keyspace is replicated in. -
replicationStrategy
- the required value isSINGLE_REGION
orMULTI_REGION
.
Sourcepub fn set_replication_specification(
self,
input: Option<ReplicationSpecification>,
) -> Self
pub fn set_replication_specification( self, input: Option<ReplicationSpecification>, ) -> Self
The replication specification of the keyspace includes:
-
regionList
- the Amazon Web Services Regions where the keyspace is replicated in. -
replicationStrategy
- the required value isSINGLE_REGION
orMULTI_REGION
.
Sourcepub fn get_replication_specification(&self) -> &Option<ReplicationSpecification>
pub fn get_replication_specification(&self) -> &Option<ReplicationSpecification>
The replication specification of the keyspace includes:
-
regionList
- the Amazon Web Services Regions where the keyspace is replicated in. -
replicationStrategy
- the required value isSINGLE_REGION
orMULTI_REGION
.
Sourcepub fn client_side_timestamps(self, input: ClientSideTimestamps) -> Self
pub fn client_side_timestamps(self, input: ClientSideTimestamps) -> Self
The client-side timestamp setting of the table.
For more information, see How it works: Amazon Keyspaces client-side timestamps in the Amazon Keyspaces Developer Guide.
Sourcepub fn set_client_side_timestamps(
self,
input: Option<ClientSideTimestamps>,
) -> Self
pub fn set_client_side_timestamps( self, input: Option<ClientSideTimestamps>, ) -> Self
The client-side timestamp setting of the table.
For more information, see How it works: Amazon Keyspaces client-side timestamps in the Amazon Keyspaces Developer Guide.
Sourcepub fn get_client_side_timestamps(&self) -> &Option<ClientSideTimestamps>
pub fn get_client_side_timestamps(&self) -> &Option<ClientSideTimestamps>
The client-side timestamp setting of the table.
For more information, see How it works: Amazon Keyspaces client-side timestamps in the Amazon Keyspaces Developer Guide.
Trait Implementations§
Source§impl Clone for UpdateKeyspaceFluentBuilder
impl Clone for UpdateKeyspaceFluentBuilder
Source§fn clone(&self) -> UpdateKeyspaceFluentBuilder
fn clone(&self) -> UpdateKeyspaceFluentBuilder
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 UpdateKeyspaceFluentBuilder
impl !RefUnwindSafe for UpdateKeyspaceFluentBuilder
impl Send for UpdateKeyspaceFluentBuilder
impl Sync for UpdateKeyspaceFluentBuilder
impl Unpin for UpdateKeyspaceFluentBuilder
impl !UnwindSafe for UpdateKeyspaceFluentBuilder
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);