AWSDynamoDBReplicaDescription

Objective-C

@interface AWSDynamoDBReplicaDescription

Swift

class AWSDynamoDBReplicaDescription

Contains the details of the replica.

  • Replica-specific global secondary index settings.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSDynamoDBReplicaGlobalSecondaryIndexDescription *> *_Nullable globalSecondaryIndexes;

    Swift

    var globalSecondaryIndexes: [AWSDynamoDBReplicaGlobalSecondaryIndexDescription]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable KMSMasterKeyId;

    Swift

    var kmsMasterKeyId: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSDynamoDBOnDemandThroughputOverride *_Nullable onDemandThroughputOverride;

    Swift

    var onDemandThroughputOverride: AWSDynamoDBOnDemandThroughputOverride? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSDynamoDBProvisionedThroughputOverride *_Nullable provisionedThroughputOverride;

    Swift

    var provisionedThroughputOverride: AWSDynamoDBProvisionedThroughputOverride? { get set }

  • The name of the Region.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable regionName;

    Swift

    var regionName: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable replicaInaccessibleDateTime;

    Swift

    var replicaInaccessibleDateTime: Date? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSDynamoDBReplicaStatus replicaStatus;

    Swift

    var replicaStatus: AWSDynamoDBReplicaStatus { get set }

  • Detailed information about the replica status.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable replicaStatusDescription;

    Swift

    var replicaStatusDescription: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable replicaStatusPercentProgress;

    Swift

    var replicaStatusPercentProgress: String? { get set }

  • Contains details of the table class.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSDynamoDBTableClassSummary *_Nullable replicaTableClassSummary;

    Swift

    var replicaTableClassSummary: AWSDynamoDBTableClassSummary? { get set }