pub struct Builder { /* private fields */ }
Expand description
A builder for GlobalSecondaryIndexDescription
.
Implementations§
source§impl Builder
impl Builder
sourcepub fn index_name(self, input: impl Into<String>) -> Self
pub fn index_name(self, input: impl Into<String>) -> Self
The name of the global secondary index.
sourcepub fn set_index_name(self, input: Option<String>) -> Self
pub fn set_index_name(self, input: Option<String>) -> Self
The name of the global secondary index.
sourcepub fn key_schema(self, input: KeySchemaElement) -> Self
pub fn key_schema(self, input: KeySchemaElement) -> Self
Appends an item to key_schema
.
To override the contents of this collection use set_key_schema
.
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
-
HASH
- partition key -
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
sourcepub fn set_key_schema(self, input: Option<Vec<KeySchemaElement>>) -> Self
pub fn set_key_schema(self, input: Option<Vec<KeySchemaElement>>) -> Self
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
-
HASH
- partition key -
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
sourcepub fn projection(self, input: Projection) -> Self
pub fn projection(self, input: Projection) -> Self
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
sourcepub fn set_projection(self, input: Option<Projection>) -> Self
pub fn set_projection(self, input: Option<Projection>) -> Self
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
sourcepub fn index_status(self, input: IndexStatus) -> Self
pub fn index_status(self, input: IndexStatus) -> Self
The current state of the global secondary index:
-
CREATING
- The index is being created. -
UPDATING
- The index is being updated. -
DELETING
- The index is being deleted. -
ACTIVE
- The index is ready for use.
sourcepub fn set_index_status(self, input: Option<IndexStatus>) -> Self
pub fn set_index_status(self, input: Option<IndexStatus>) -> Self
The current state of the global secondary index:
-
CREATING
- The index is being created. -
UPDATING
- The index is being updated. -
DELETING
- The index is being deleted. -
ACTIVE
- The index is ready for use.
sourcepub fn backfilling(self, input: bool) -> Self
pub fn backfilling(self, input: bool) -> Self
Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling
is false.
You can delete an index that is being created during the Backfilling
phase when IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the index that is being created when IndexStatus
is set to CREATING and Backfilling
is false.
For indexes that were created during a CreateTable
operation, the Backfilling
attribute does not appear in the DescribeTable
output.
sourcepub fn set_backfilling(self, input: Option<bool>) -> Self
pub fn set_backfilling(self, input: Option<bool>) -> Self
Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling
is false.
You can delete an index that is being created during the Backfilling
phase when IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the index that is being created when IndexStatus
is set to CREATING and Backfilling
is false.
For indexes that were created during a CreateTable
operation, the Backfilling
attribute does not appear in the DescribeTable
output.
sourcepub fn provisioned_throughput(
self,
input: ProvisionedThroughputDescription
) -> Self
pub fn provisioned_throughput(
self,
input: ProvisionedThroughputDescription
) -> Self
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
sourcepub fn set_provisioned_throughput(
self,
input: Option<ProvisionedThroughputDescription>
) -> Self
pub fn set_provisioned_throughput(
self,
input: Option<ProvisionedThroughputDescription>
) -> Self
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
sourcepub fn index_size_bytes(self, input: i64) -> Self
pub fn index_size_bytes(self, input: i64) -> Self
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
sourcepub fn set_index_size_bytes(self, input: Option<i64>) -> Self
pub fn set_index_size_bytes(self, input: Option<i64>) -> Self
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
sourcepub fn item_count(self, input: i64) -> Self
pub fn item_count(self, input: i64) -> Self
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
sourcepub fn set_item_count(self, input: Option<i64>) -> Self
pub fn set_item_count(self, input: Option<i64>) -> Self
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
sourcepub fn index_arn(self, input: impl Into<String>) -> Self
pub fn index_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) that uniquely identifies the index.
sourcepub fn set_index_arn(self, input: Option<String>) -> Self
pub fn set_index_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) that uniquely identifies the index.
sourcepub fn build(self) -> GlobalSecondaryIndexDescription
pub fn build(self) -> GlobalSecondaryIndexDescription
Consumes the builder and constructs a GlobalSecondaryIndexDescription
.