Struct aws_sdk_dynamodb::types::ReplicaDescription

#[non_exhaustive]
pub struct ReplicaDescription {
    pub region_name: Option<String>,
    pub replica_status: Option<ReplicaStatus>,
    pub replica_status_description: Option<String>,
    pub replica_status_percent_progress: Option<String>,
    pub kms_master_key_id: Option<String>,
    pub provisioned_throughput_override: Option<ProvisionedThroughputOverride>,
    pub on_demand_throughput_override: Option<OnDemandThroughputOverride>,
    pub warm_throughput: Option<TableWarmThroughputDescription>,
    pub global_secondary_indexes: Option<Vec<ReplicaGlobalSecondaryIndexDescription>>,
    pub replica_inaccessible_date_time: Option<DateTime>,
    pub replica_table_class_summary: Option<TableClassSummary>,
}

Contains the details of the replica.

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.

region_name: Option<String>

The name of the Region.

replica_status: Option<ReplicaStatus>

The current state of the replica:

• CREATING - The replica is being created.

• UPDATING - The replica is being updated.

• DELETING - The replica is being deleted.

• ACTIVE - The replica is ready for use.

• REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.

  If the Amazon Web Services Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.

• INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.

  If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.

replica_status_description: Option<String>

Detailed information about the replica status.

replica_status_percent_progress: Option<String>

Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.

kms_master_key_id: Option<String>

The KMS key of the replica that will be used for KMS encryption.

provisioned_throughput_override: Option<ProvisionedThroughputOverride>

Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.

on_demand_throughput_override: Option<OnDemandThroughputOverride>

Overrides the maximum on-demand throughput settings for the specified replica table.

warm_throughput: Option<TableWarmThroughputDescription>

Represents the warm throughput value for this replica.

global_secondary_indexes: Option<Vec<ReplicaGlobalSecondaryIndexDescription>>

Replica-specific global secondary index settings.

replica_inaccessible_date_time: Option<DateTime>

The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.

replica_table_class_summary: Option<TableClassSummary>

Contains details of the table class.

Implementations

impl ReplicaDescription

pub fn region_name(&self) -> Option<&str>

The name of the Region.

pub fn replica_status(&self) -> Option<&ReplicaStatus>

The current state of the replica:

• CREATING - The replica is being created.

• UPDATING - The replica is being updated.

• DELETING - The replica is being deleted.

• ACTIVE - The replica is ready for use.

• REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.

  If the Amazon Web Services Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.

• INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.

  If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.

pub fn replica_status_description(&self) -> Option<&str>

Detailed information about the replica status.

pub fn replica_status_percent_progress(&self) -> Option<&str>

Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.

pub fn kms_master_key_id(&self) -> Option<&str>

The KMS key of the replica that will be used for KMS encryption.

pub fn provisioned_throughput_override( &self, ) -> Option<&ProvisionedThroughputOverride>

Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.

pub fn on_demand_throughput_override( &self, ) -> Option<&OnDemandThroughputOverride>

Overrides the maximum on-demand throughput settings for the specified replica table.

pub fn warm_throughput(&self) -> Option<&TableWarmThroughputDescription>

Represents the warm throughput value for this replica.

pub fn global_secondary_indexes( &self, ) -> &[ReplicaGlobalSecondaryIndexDescription]

Replica-specific global secondary index settings.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .global_secondary_indexes.is_none().

pub fn replica_inaccessible_date_time(&self) -> Option<&DateTime>

The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.

pub fn replica_table_class_summary(&self) -> Option<&TableClassSummary>

Contains details of the table class.

impl ReplicaDescription

pub fn builder() -> ReplicaDescriptionBuilder

Creates a new builder-style object to manufacture ReplicaDescription.

Trait Implementations

impl Clone for ReplicaDescription

fn clone(&self) -> ReplicaDescription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReplicaDescription

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

Formats the value using the given formatter.

impl PartialEq for ReplicaDescription

fn eq(&self, other: &ReplicaDescription) -> 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 ReplicaDescription