class Amazonite::DynamoDB::ReplicaDescription

Overview

Contains the details of the replica.

Included Modules

Defined in:

dynamodb/replica_description.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(region_name : String | Nil = nil, replica_status : ReplicaStatus | Nil = nil, replica_arn : String | Nil = nil, replica_status_description : String | Nil = nil, replica_status_percent_progress : String | Nil = nil, kms_master_key_id : String | Nil = nil, provisioned_throughput_override : ProvisionedThroughputOverride | Nil = nil, on_demand_throughput_override : OnDemandThroughputOverride | Nil = nil, warm_throughput : TableWarmThroughputDescription | Nil = nil, global_secondary_indexes : Array(ReplicaGlobalSecondaryIndexDescription) | Nil = nil, replica_inaccessible_date_time : Time | Nil = nil, replica_table_class_summary : TableClassSummary | Nil = nil, global_table_settings_replication_mode : GlobalTableSettingsReplicationMode | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def global_secondary_indexes : Array(ReplicaGlobalSecondaryIndexDescription) | Nil #

Replica-specific global secondary index settings.


[View source]
def global_secondary_indexes=(global_secondary_indexes : Array(ReplicaGlobalSecondaryIndexDescription) | Nil) #

Replica-specific global secondary index settings.


[View source]
def global_table_settings_replication_mode : GlobalTableSettingsReplicationMode | Nil #

Indicates one of the settings synchronization modes for the global table replica:

  • ENABLED: Indicates that the settings synchronization mode for the global table replica is enabled.

  • DISABLED: Indicates that the settings synchronization mode for the global table replica is disabled.

  • ENABLED_WITH_OVERRIDES: This mode is set by default for a same account global table. Indicates that certain global table settings can be overridden.


[View source]
def global_table_settings_replication_mode=(global_table_settings_replication_mode : GlobalTableSettingsReplicationMode | Nil) #

Indicates one of the settings synchronization modes for the global table replica:

  • ENABLED: Indicates that the settings synchronization mode for the global table replica is enabled.

  • DISABLED: Indicates that the settings synchronization mode for the global table replica is disabled.

  • ENABLED_WITH_OVERRIDES: This mode is set by default for a same account global table. Indicates that certain global table settings can be overridden.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def kms_master_key_id : String | Nil #

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


[View source]
def kms_master_key_id=(kms_master_key_id : String | Nil) #

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


[View source]
def on_demand_throughput_override : OnDemandThroughputOverride | Nil #

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


[View source]
def on_demand_throughput_override=(on_demand_throughput_override : OnDemandThroughputOverride | Nil) #

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


[View source]
def provisioned_throughput_override : ProvisionedThroughputOverride | Nil #

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


[View source]
def provisioned_throughput_override=(provisioned_throughput_override : ProvisionedThroughputOverride | Nil) #

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


[View source]
def region_name : String | Nil #

The name of the Region.


[View source]
def region_name=(region_name : String | Nil) #

The name of the Region.


[View source]
def replica_arn : String | Nil #

The Amazon Resource Name (ARN) of the global table replica.


[View source]
def replica_arn=(replica_arn : String | Nil) #

The Amazon Resource Name (ARN) of the global table replica.


[View source]
def replica_inaccessible_date_time : Time | Nil #

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


[View source]
def replica_inaccessible_date_time=(replica_inaccessible_date_time : Time | Nil) #

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


[View source]
def replica_status : ReplicaStatus | Nil #

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.


[View source]
def replica_status=(replica_status : ReplicaStatus | Nil) #

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.


[View source]
def replica_status_description : String | Nil #

Detailed information about the replica status.


[View source]
def replica_status_description=(replica_status_description : String | Nil) #

Detailed information about the replica status.


[View source]
def replica_status_percent_progress : String | Nil #

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


[View source]
def replica_status_percent_progress=(replica_status_percent_progress : String | Nil) #

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


[View source]
def replica_table_class_summary : TableClassSummary | Nil #

[View source]
def replica_table_class_summary=(replica_table_class_summary : TableClassSummary | Nil) #

[View source]
def validate! : Nil #

[View source]
def warm_throughput : TableWarmThroughputDescription | Nil #

Represents the warm throughput value for this replica.


[View source]
def warm_throughput=(warm_throughput : TableWarmThroughputDescription | Nil) #

Represents the warm throughput value for this replica.


[View source]