Struct aws_sdk_dynamodb::types::ReplicaGlobalSecondaryIndexSettingsDescription

#[non_exhaustive]
pub struct ReplicaGlobalSecondaryIndexSettingsDescription {
    pub index_name: String,
    pub index_status: Option<IndexStatus>,
    pub provisioned_read_capacity_units: Option<i64>,
    pub provisioned_read_capacity_auto_scaling_settings: Option<AutoScalingSettingsDescription>,
    pub provisioned_write_capacity_units: Option<i64>,
    pub provisioned_write_capacity_auto_scaling_settings: Option<AutoScalingSettingsDescription>,
}

Represents the properties of a global secondary index.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

index_name: String

The name of the global secondary index. The name must be unique among all other indexes on this table.

index_status: Option<IndexStatus>

The current status of the global secondary index:

• CREATING - The global secondary index is being created.

• UPDATING - The global secondary index is being updated.

• DELETING - The global secondary index is being deleted.

• ACTIVE - The global secondary index is ready for use.

provisioned_read_capacity_units: Option<i64>

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

provisioned_read_capacity_auto_scaling_settings: Option<AutoScalingSettingsDescription>

Auto scaling settings for a global secondary index replica's read capacity units.

provisioned_write_capacity_units: Option<i64>

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

provisioned_write_capacity_auto_scaling_settings: Option<AutoScalingSettingsDescription>

Auto scaling settings for a global secondary index replica's write capacity units.

Implementations

impl ReplicaGlobalSecondaryIndexSettingsDescription

pub fn index_name(&self) -> &str

The name of the global secondary index. The name must be unique among all other indexes on this table.

pub fn index_status(&self) -> Option<&IndexStatus>

The current status of the global secondary index:

• CREATING - The global secondary index is being created.

• UPDATING - The global secondary index is being updated.

• DELETING - The global secondary index is being deleted.

• ACTIVE - The global secondary index is ready for use.

pub fn provisioned_read_capacity_units(&self) -> Option<i64>

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

pub fn provisioned_read_capacity_auto_scaling_settings( &self, ) -> Option<&AutoScalingSettingsDescription>

Auto scaling settings for a global secondary index replica's read capacity units.

pub fn provisioned_write_capacity_units(&self) -> Option<i64>

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

pub fn provisioned_write_capacity_auto_scaling_settings( &self, ) -> Option<&AutoScalingSettingsDescription>

Auto scaling settings for a global secondary index replica's write capacity units.

impl ReplicaGlobalSecondaryIndexSettingsDescription

pub fn builder() -> ReplicaGlobalSecondaryIndexSettingsDescriptionBuilder

Creates a new builder-style object to manufacture ReplicaGlobalSecondaryIndexSettingsDescription.

Trait Implementations

impl Clone for ReplicaGlobalSecondaryIndexSettingsDescription

fn clone(&self) -> ReplicaGlobalSecondaryIndexSettingsDescription

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReplicaGlobalSecondaryIndexSettingsDescription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ReplicaGlobalSecondaryIndexSettingsDescription

fn eq(&self, other: &ReplicaGlobalSecondaryIndexSettingsDescription) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ReplicaGlobalSecondaryIndexSettingsDescription