Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DynamoDB.Types.ReplicaDescription

Description

Synopsis

Documentation

data ReplicaDescription Source #

Contains the details of the replica.

See: newReplicaDescription smart constructor.

Constructors

ReplicaDescription'

Fields

replicaStatus :: Maybe 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 AWS Region has been disabled.
  If the AWS 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 AWS KMS key used to encrypt the table is inaccessible.
  If the AWS 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.
regionName :: Maybe Text
The name of the Region.
replicaStatusPercentProgress :: Maybe Text
Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
replicaStatusDescription :: Maybe Text
Detailed information about the replica status.
replicaInaccessibleDateTime :: Maybe POSIX
The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.
kmsMasterKeyId :: Maybe Text
The AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS encryption.
provisionedThroughputOverride :: Maybe ProvisionedThroughputOverride
Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
globalSecondaryIndexes :: Maybe [ReplicaGlobalSecondaryIndexDescription]
Replica-specific global secondary index settings.

Instances

Instances details

Eq ReplicaDescription Source #
Instance details Defined in Amazonka.DynamoDB.Types.ReplicaDescription Methods (==) :: ReplicaDescription -> ReplicaDescription -> Bool # (/=) :: ReplicaDescription -> ReplicaDescription -> Bool #
Read ReplicaDescription Source #
Instance details Defined in Amazonka.DynamoDB.Types.ReplicaDescription Methods readsPrec :: Int -> ReadS ReplicaDescription # readList :: ReadS [ReplicaDescription] # readPrec :: ReadPrec ReplicaDescription # readListPrec :: ReadPrec [ReplicaDescription] #
Show ReplicaDescription Source #
Instance details Defined in Amazonka.DynamoDB.Types.ReplicaDescription Methods showsPrec :: Int -> ReplicaDescription -> ShowS # show :: ReplicaDescription -> String # showList :: [ReplicaDescription] -> ShowS #
Generic ReplicaDescription Source #
Instance details Defined in Amazonka.DynamoDB.Types.ReplicaDescription Associated Types type Rep ReplicaDescription :: Type -> Type # Methods from :: ReplicaDescription -> Rep ReplicaDescription x # to :: Rep ReplicaDescription x -> ReplicaDescription #
NFData ReplicaDescription Source #
Instance details Defined in Amazonka.DynamoDB.Types.ReplicaDescription Methods rnf :: ReplicaDescription -> () #
Hashable ReplicaDescription Source #
Instance details Defined in Amazonka.DynamoDB.Types.ReplicaDescription Methods hashWithSalt :: Int -> ReplicaDescription -> Int # hash :: ReplicaDescription -> Int #
FromJSON ReplicaDescription Source #
Instance details Defined in Amazonka.DynamoDB.Types.ReplicaDescription Methods parseJSON :: Value -> Parser ReplicaDescription # parseJSONList :: Value -> Parser [ReplicaDescription] #
type Rep ReplicaDescription Source #
Instance details Defined in Amazonka.DynamoDB.Types.ReplicaDescription type Rep ReplicaDescription = D1 ('MetaData "ReplicaDescription" "Amazonka.DynamoDB.Types.ReplicaDescription" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "ReplicaDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "replicaStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicaStatus)) :: S1 ('MetaSel ('Just "regionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "replicaStatusPercentProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "replicaStatusDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "replicaInaccessibleDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "kmsMasterKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "provisionedThroughputOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProvisionedThroughputOverride)) :*: S1 ('MetaSel ('Just "globalSecondaryIndexes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReplicaGlobalSecondaryIndexDescription]))))))

newReplicaDescription :: ReplicaDescription Source #

Create a value of ReplicaDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:replicaStatus:ReplicaDescription', replicaDescription_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 AWS Region has been disabled.
If the AWS 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 AWS KMS key used to encrypt the table is inaccessible.
If the AWS 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.

$sel:regionName:ReplicaDescription', replicaDescription_regionName - The name of the Region.

$sel:replicaStatusPercentProgress:ReplicaDescription', replicaDescription_replicaStatusPercentProgress - Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.

$sel:replicaStatusDescription:ReplicaDescription', replicaDescription_replicaStatusDescription - Detailed information about the replica status.

$sel:replicaInaccessibleDateTime:ReplicaDescription', replicaDescription_replicaInaccessibleDateTime - The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.

$sel:kmsMasterKeyId:ReplicaDescription', replicaDescription_kmsMasterKeyId - The AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS encryption.

$sel:provisionedThroughputOverride:ReplicaDescription', replicaDescription_provisionedThroughputOverride - Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.

$sel:globalSecondaryIndexes:ReplicaDescription', replicaDescription_globalSecondaryIndexes - Replica-specific global secondary index settings.

replicaDescription_replicaStatus :: Lens' ReplicaDescription (Maybe ReplicaStatus) Source #

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 AWS Region has been disabled.
If the AWS 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 AWS KMS key used to encrypt the table is inaccessible.
If the AWS 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.

replicaDescription_regionName :: Lens' ReplicaDescription (Maybe Text) Source #

The name of the Region.

replicaDescription_replicaStatusPercentProgress :: Lens' ReplicaDescription (Maybe Text) Source #

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

replicaDescription_replicaStatusDescription :: Lens' ReplicaDescription (Maybe Text) Source #

Detailed information about the replica status.

replicaDescription_replicaInaccessibleDateTime :: Lens' ReplicaDescription (Maybe UTCTime) Source #

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

replicaDescription_kmsMasterKeyId :: Lens' ReplicaDescription (Maybe Text) Source #

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

replicaDescription_provisionedThroughputOverride :: Lens' ReplicaDescription (Maybe ProvisionedThroughputOverride) Source #

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

replicaDescription_globalSecondaryIndexes :: Lens' ReplicaDescription (Maybe [ReplicaGlobalSecondaryIndexDescription]) Source #

Replica-specific global secondary index settings.