Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DynamoDB.Types.ReplicaDescription

Description

Synopsis

Documentation

data ReplicaDescription Source #

Contains the details of the replica.

See: newReplicaDescription smart constructor.

Constructors

ReplicaDescription'

Fields

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

Instances

Instances details

FromJSON ReplicaDescription Source #
Instance details Defined in Amazonka.DynamoDB.Types.ReplicaDescription Methods parseJSON :: Value -> Parser ReplicaDescription # parseJSONList :: Value -> Parser [ReplicaDescription] #
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 #
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 #
NFData ReplicaDescription Source #
Instance details Defined in Amazonka.DynamoDB.Types.ReplicaDescription Methods rnf :: ReplicaDescription -> () #
Eq ReplicaDescription Source #
Instance details Defined in Amazonka.DynamoDB.Types.ReplicaDescription Methods (==) :: ReplicaDescription -> ReplicaDescription -> Bool # (/=) :: ReplicaDescription -> ReplicaDescription -> Bool #
Hashable ReplicaDescription Source #
Instance details Defined in Amazonka.DynamoDB.Types.ReplicaDescription Methods hashWithSalt :: Int -> ReplicaDescription -> Int # hash :: ReplicaDescription -> Int #
type Rep ReplicaDescription Source #
Instance details Defined in Amazonka.DynamoDB.Types.ReplicaDescription type Rep ReplicaDescription = D1 ('MetaData "ReplicaDescription" "Amazonka.DynamoDB.Types.ReplicaDescription" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "ReplicaDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "globalSecondaryIndexes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReplicaGlobalSecondaryIndexDescription])) :: S1 ('MetaSel ('Just "kmsMasterKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "provisionedThroughputOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProvisionedThroughputOverride)) :: S1 ('MetaSel ('Just "regionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "replicaInaccessibleDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "replicaStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicaStatus))) :: (S1 ('MetaSel ('Just "replicaStatusDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "replicaStatusPercentProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "replicaTableClassSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TableClassSummary)))))))

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:globalSecondaryIndexes:ReplicaDescription', replicaDescription_globalSecondaryIndexes - Replica-specific global secondary index settings.

$sel:kmsMasterKeyId:ReplicaDescription', replicaDescription_kmsMasterKeyId - The KMS key of the replica that will be used for KMS encryption.

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

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

$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: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 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.

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

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

$sel:replicaTableClassSummary:ReplicaDescription', replicaDescription_replicaTableClassSummary - Undocumented member.

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

Replica-specific global secondary index settings.

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

The KMS key of the replica that will be used for 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_regionName :: Lens' ReplicaDescription (Maybe Text) Source #

The name of the Region.

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

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

Detailed information about the replica status.

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

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

replicaDescription_replicaTableClassSummary :: Lens' ReplicaDescription (Maybe TableClassSummary) Source #

Undocumented member.