Class ReplicaDescription
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ReplicaDescription.Builder,
ReplicaDescription>
Contains the details of the replica.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ReplicaDescription.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Replica-specific global secondary index settings.final boolean
For responses, this returns true if the service returned a value for the GlobalSecondaryIndexes property.final int
hashCode()
final String
The KMS key of the replica that will be used for KMS encryption.Replica-specific provisioned throughput.final String
The name of the Region.final Instant
The time at which the replica was first detected as inaccessible.final ReplicaStatus
The current state of the replica:final String
The current state of the replica:final String
Detailed information about the replica status.final String
Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.final TableClassSummary
Returns the value of the ReplicaTableClassSummary property for this object.static Class
<? extends ReplicaDescription.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
regionName
The name of the Region.
- Returns:
- The name of the Region.
-
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.
If the service returns an enum value that is not available in the current SDK version,
replicaStatus
will returnReplicaStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreplicaStatusAsString()
.- Returns:
- 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.
-
- See Also:
-
-
replicaStatusAsString
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.
If the service returns an enum value that is not available in the current SDK version,
replicaStatus
will returnReplicaStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreplicaStatusAsString()
.- Returns:
- 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.
-
- See Also:
-
-
replicaStatusDescription
Detailed information about the replica status.
- Returns:
- Detailed information about the replica status.
-
replicaStatusPercentProgress
Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
- Returns:
- Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
-
kmsMasterKeyId
The KMS key of the replica that will be used for KMS encryption.
- Returns:
- The KMS key of the replica that will be used for KMS encryption.
-
provisionedThroughputOverride
Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
- Returns:
- Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
-
hasGlobalSecondaryIndexes
public final boolean hasGlobalSecondaryIndexes()For responses, this returns true if the service returned a value for the GlobalSecondaryIndexes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
globalSecondaryIndexes
Replica-specific global secondary index settings.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasGlobalSecondaryIndexes()
method.- Returns:
- Replica-specific global secondary index settings.
-
replicaInaccessibleDateTime
The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the
ReplicaStatus
property.- Returns:
- The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility
check the
ReplicaStatus
property.
-
replicaTableClassSummary
Returns the value of the ReplicaTableClassSummary property for this object.- Returns:
- The value of the ReplicaTableClassSummary property for this object.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ReplicaDescription.Builder,
ReplicaDescription> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-