AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::DynamoDB::Types::ReplicaDescription

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb

Overview

Contains the details of the replica.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#global_secondary_indexesArray<Types::ReplicaGlobalSecondaryIndexDescription>

Replica-specific global secondary index settings.



6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 6287

class ReplicaDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_status_description,
  :replica_status_percent_progress,
  :kms_master_key_id,
  :provisioned_throughput_override,
  :global_secondary_indexes)
  SENSITIVE = []
  include Aws::Structure
end

#kms_master_key_idString

The AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS encryption.

Returns:

  • (String)


6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 6287

class ReplicaDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_status_description,
  :replica_status_percent_progress,
  :kms_master_key_id,
  :provisioned_throughput_override,
  :global_secondary_indexes)
  SENSITIVE = []
  include Aws::Structure
end

#provisioned_throughput_overrideTypes::ProvisionedThroughputOverride

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



6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 6287

class ReplicaDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_status_description,
  :replica_status_percent_progress,
  :kms_master_key_id,
  :provisioned_throughput_override,
  :global_secondary_indexes)
  SENSITIVE = []
  include Aws::Structure
end

#region_nameString

The name of the Region.

Returns:

  • (String)


6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 6287

class ReplicaDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_status_description,
  :replica_status_percent_progress,
  :kms_master_key_id,
  :provisioned_throughput_override,
  :global_secondary_indexes)
  SENSITIVE = []
  include Aws::Structure
end

#replica_statusString

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.

Returns:

  • (String)


6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 6287

class ReplicaDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_status_description,
  :replica_status_percent_progress,
  :kms_master_key_id,
  :provisioned_throughput_override,
  :global_secondary_indexes)
  SENSITIVE = []
  include Aws::Structure
end

#replica_status_descriptionString

Detailed information about the replica status.

Returns:

  • (String)


6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 6287

class ReplicaDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_status_description,
  :replica_status_percent_progress,
  :kms_master_key_id,
  :provisioned_throughput_override,
  :global_secondary_indexes)
  SENSITIVE = []
  include Aws::Structure
end

#replica_status_percent_progressString

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

Returns:

  • (String)


6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 6287

class ReplicaDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_status_description,
  :replica_status_percent_progress,
  :kms_master_key_id,
  :provisioned_throughput_override,
  :global_secondary_indexes)
  SENSITIVE = []
  include Aws::Structure
end