pub struct UpdateTableFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateTable
.
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
You can only perform one of the following operations at once:
-
Modify the provisioned throughput settings of the table.
-
Remove a global secondary index from the table.
-
Create a new global secondary index on the table. After the index begins backfilling, you can use
UpdateTable
to perform other operations.
UpdateTable
is an asynchronous operation; while it's executing, the table status changes from ACTIVE
to UPDATING
. While it's UPDATING
, you can't issue another UpdateTable
request. When the table returns to the ACTIVE
state, the UpdateTable
operation is complete.
Implementations§
source§impl UpdateTableFluentBuilder
impl UpdateTableFluentBuilder
sourcepub fn as_input(&self) -> &UpdateTableInputBuilder
pub fn as_input(&self) -> &UpdateTableInputBuilder
Access the UpdateTable as a reference.
sourcepub async fn send(
self,
) -> Result<UpdateTableOutput, SdkError<UpdateTableError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateTableOutput, SdkError<UpdateTableError, 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<UpdateTableOutput, UpdateTableError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateTableOutput, UpdateTableError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn attribute_definitions(self, input: AttributeDefinition) -> Self
pub fn attribute_definitions(self, input: AttributeDefinition) -> Self
Appends an item to AttributeDefinitions
.
To override the contents of this collection use set_attribute_definitions
.
An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions
must include the key element(s) of the new index.
sourcepub fn set_attribute_definitions(
self,
input: Option<Vec<AttributeDefinition>>,
) -> Self
pub fn set_attribute_definitions( self, input: Option<Vec<AttributeDefinition>>, ) -> Self
An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions
must include the key element(s) of the new index.
sourcepub fn get_attribute_definitions(&self) -> &Option<Vec<AttributeDefinition>>
pub fn get_attribute_definitions(&self) -> &Option<Vec<AttributeDefinition>>
An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions
must include the key element(s) of the new index.
sourcepub fn table_name(self, input: impl Into<String>) -> Self
pub fn table_name(self, input: impl Into<String>) -> Self
The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
sourcepub fn set_table_name(self, input: Option<String>) -> Self
pub fn set_table_name(self, input: Option<String>) -> Self
The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
sourcepub fn get_table_name(&self) -> &Option<String>
pub fn get_table_name(&self) -> &Option<String>
The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
sourcepub fn billing_mode(self, input: BillingMode) -> Self
pub fn billing_mode(self, input: BillingMode) -> Self
Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.
-
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned capacity mode. -
PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-demand capacity mode.
sourcepub fn set_billing_mode(self, input: Option<BillingMode>) -> Self
pub fn set_billing_mode(self, input: Option<BillingMode>) -> Self
Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.
-
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned capacity mode. -
PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-demand capacity mode.
sourcepub fn get_billing_mode(&self) -> &Option<BillingMode>
pub fn get_billing_mode(&self) -> &Option<BillingMode>
Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.
-
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned capacity mode. -
PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-demand capacity mode.
sourcepub fn provisioned_throughput(self, input: ProvisionedThroughput) -> Self
pub fn provisioned_throughput(self, input: ProvisionedThroughput) -> Self
The new provisioned throughput settings for the specified table or index.
sourcepub fn set_provisioned_throughput(
self,
input: Option<ProvisionedThroughput>,
) -> Self
pub fn set_provisioned_throughput( self, input: Option<ProvisionedThroughput>, ) -> Self
The new provisioned throughput settings for the specified table or index.
sourcepub fn get_provisioned_throughput(&self) -> &Option<ProvisionedThroughput>
pub fn get_provisioned_throughput(&self) -> &Option<ProvisionedThroughput>
The new provisioned throughput settings for the specified table or index.
sourcepub fn global_secondary_index_updates(
self,
input: GlobalSecondaryIndexUpdate,
) -> Self
pub fn global_secondary_index_updates( self, input: GlobalSecondaryIndexUpdate, ) -> Self
Appends an item to GlobalSecondaryIndexUpdates
.
To override the contents of this collection use set_global_secondary_index_updates
.
An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:
-
Create
- add a new global secondary index to the table. -
Update
- modify the provisioned throughput settings of an existing global secondary index. -
Delete
- remove a global secondary index from the table.
You can create or delete only one global secondary index per UpdateTable
operation.
For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
sourcepub fn set_global_secondary_index_updates(
self,
input: Option<Vec<GlobalSecondaryIndexUpdate>>,
) -> Self
pub fn set_global_secondary_index_updates( self, input: Option<Vec<GlobalSecondaryIndexUpdate>>, ) -> Self
An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:
-
Create
- add a new global secondary index to the table. -
Update
- modify the provisioned throughput settings of an existing global secondary index. -
Delete
- remove a global secondary index from the table.
You can create or delete only one global secondary index per UpdateTable
operation.
For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
sourcepub fn get_global_secondary_index_updates(
&self,
) -> &Option<Vec<GlobalSecondaryIndexUpdate>>
pub fn get_global_secondary_index_updates( &self, ) -> &Option<Vec<GlobalSecondaryIndexUpdate>>
An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:
-
Create
- add a new global secondary index to the table. -
Update
- modify the provisioned throughput settings of an existing global secondary index. -
Delete
- remove a global secondary index from the table.
You can create or delete only one global secondary index per UpdateTable
operation.
For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
sourcepub fn stream_specification(self, input: StreamSpecification) -> Self
pub fn stream_specification(self, input: StreamSpecification) -> Self
Represents the DynamoDB Streams configuration for the table.
You receive a ValidationException
if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.
sourcepub fn set_stream_specification(
self,
input: Option<StreamSpecification>,
) -> Self
pub fn set_stream_specification( self, input: Option<StreamSpecification>, ) -> Self
Represents the DynamoDB Streams configuration for the table.
You receive a ValidationException
if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.
sourcepub fn get_stream_specification(&self) -> &Option<StreamSpecification>
pub fn get_stream_specification(&self) -> &Option<StreamSpecification>
Represents the DynamoDB Streams configuration for the table.
You receive a ValidationException
if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.
sourcepub fn sse_specification(self, input: SseSpecification) -> Self
pub fn sse_specification(self, input: SseSpecification) -> Self
The new server-side encryption settings for the specified table.
sourcepub fn set_sse_specification(self, input: Option<SseSpecification>) -> Self
pub fn set_sse_specification(self, input: Option<SseSpecification>) -> Self
The new server-side encryption settings for the specified table.
sourcepub fn get_sse_specification(&self) -> &Option<SseSpecification>
pub fn get_sse_specification(&self) -> &Option<SseSpecification>
The new server-side encryption settings for the specified table.
sourcepub fn replica_updates(self, input: ReplicationGroupUpdate) -> Self
pub fn replica_updates(self, input: ReplicationGroupUpdate) -> Self
Appends an item to ReplicaUpdates
.
To override the contents of this collection use set_replica_updates
.
A list of replica update actions (create, delete, or update) for the table.
For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).
sourcepub fn set_replica_updates(
self,
input: Option<Vec<ReplicationGroupUpdate>>,
) -> Self
pub fn set_replica_updates( self, input: Option<Vec<ReplicationGroupUpdate>>, ) -> Self
A list of replica update actions (create, delete, or update) for the table.
For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).
sourcepub fn get_replica_updates(&self) -> &Option<Vec<ReplicationGroupUpdate>>
pub fn get_replica_updates(&self) -> &Option<Vec<ReplicationGroupUpdate>>
A list of replica update actions (create, delete, or update) for the table.
For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).
sourcepub fn table_class(self, input: TableClass) -> Self
pub fn table_class(self, input: TableClass) -> Self
The table class of the table to be updated. Valid values are STANDARD
and STANDARD_INFREQUENT_ACCESS
.
sourcepub fn set_table_class(self, input: Option<TableClass>) -> Self
pub fn set_table_class(self, input: Option<TableClass>) -> Self
The table class of the table to be updated. Valid values are STANDARD
and STANDARD_INFREQUENT_ACCESS
.
sourcepub fn get_table_class(&self) -> &Option<TableClass>
pub fn get_table_class(&self) -> &Option<TableClass>
The table class of the table to be updated. Valid values are STANDARD
and STANDARD_INFREQUENT_ACCESS
.
sourcepub fn deletion_protection_enabled(self, input: bool) -> Self
pub fn deletion_protection_enabled(self, input: bool) -> Self
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
sourcepub fn set_deletion_protection_enabled(self, input: Option<bool>) -> Self
pub fn set_deletion_protection_enabled(self, input: Option<bool>) -> Self
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
sourcepub fn get_deletion_protection_enabled(&self) -> &Option<bool>
pub fn get_deletion_protection_enabled(&self) -> &Option<bool>
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
sourcepub fn on_demand_throughput(self, input: OnDemandThroughput) -> Self
pub fn on_demand_throughput(self, input: OnDemandThroughput) -> Self
Updates the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits
, MaxWriteRequestUnits
, or both.
sourcepub fn set_on_demand_throughput(self, input: Option<OnDemandThroughput>) -> Self
pub fn set_on_demand_throughput(self, input: Option<OnDemandThroughput>) -> Self
Updates the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits
, MaxWriteRequestUnits
, or both.
sourcepub fn get_on_demand_throughput(&self) -> &Option<OnDemandThroughput>
pub fn get_on_demand_throughput(&self) -> &Option<OnDemandThroughput>
Updates the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits
, MaxWriteRequestUnits
, or both.
Trait Implementations§
source§impl Clone for UpdateTableFluentBuilder
impl Clone for UpdateTableFluentBuilder
source§fn clone(&self) -> UpdateTableFluentBuilder
fn clone(&self) -> UpdateTableFluentBuilder
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 UpdateTableFluentBuilder
impl !RefUnwindSafe for UpdateTableFluentBuilder
impl Send for UpdateTableFluentBuilder
impl Sync for UpdateTableFluentBuilder
impl Unpin for UpdateTableFluentBuilder
impl !UnwindSafe for UpdateTableFluentBuilder
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§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§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 more§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§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();
§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§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();
§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§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();
§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§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();
§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.§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);