com.amazonaws.services.dynamodbv2.model

Class ReplicaDescription

java.lang.Object

com.amazonaws.services.dynamodbv2.model.ReplicaDescription

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ReplicaDescription
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains the details of the replica.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReplicaDescription()

Method Summary

Modifier and Type	Method and Description
ReplicaDescription	clone()
boolean	equals(Object obj)
List<ReplicaGlobalSecondaryIndexDescription>	getGlobalSecondaryIndexes() Replica-specific global secondary index settings.
String	getKMSMasterKeyId() The KMS key of the replica that will be used for KMS encryption.
ProvisionedThroughputOverride	getProvisionedThroughputOverride() Replica-specific provisioned throughput.
String	getRegionName() The name of the Region.
Date	getReplicaInaccessibleDateTime() The time at which the replica was first detected as inaccessible.
String	getReplicaStatus() The current state of the replica:
String	getReplicaStatusDescription() Detailed information about the replica status.
String	getReplicaStatusPercentProgress() Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
TableClassSummary	getReplicaTableClassSummary()
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setGlobalSecondaryIndexes(Collection<ReplicaGlobalSecondaryIndexDescription> globalSecondaryIndexes) Replica-specific global secondary index settings.
void	setKMSMasterKeyId(String kMSMasterKeyId) The KMS key of the replica that will be used for KMS encryption.
void	setProvisionedThroughputOverride(ProvisionedThroughputOverride provisionedThroughputOverride) Replica-specific provisioned throughput.
void	setRegionName(String regionName) The name of the Region.
void	setReplicaInaccessibleDateTime(Date replicaInaccessibleDateTime) The time at which the replica was first detected as inaccessible.
void	setReplicaStatus(String replicaStatus) The current state of the replica:
void	setReplicaStatusDescription(String replicaStatusDescription) Detailed information about the replica status.
void	setReplicaStatusPercentProgress(String replicaStatusPercentProgress) Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
void	setReplicaTableClassSummary(TableClassSummary replicaTableClassSummary)
String	toString() Returns a string representation of this object.
ReplicaDescription	withGlobalSecondaryIndexes(Collection<ReplicaGlobalSecondaryIndexDescription> globalSecondaryIndexes) Replica-specific global secondary index settings.
ReplicaDescription	withGlobalSecondaryIndexes(ReplicaGlobalSecondaryIndexDescription... globalSecondaryIndexes) Replica-specific global secondary index settings.
ReplicaDescription	withKMSMasterKeyId(String kMSMasterKeyId) The KMS key of the replica that will be used for KMS encryption.
ReplicaDescription	withProvisionedThroughputOverride(ProvisionedThroughputOverride provisionedThroughputOverride) Replica-specific provisioned throughput.
ReplicaDescription	withRegionName(String regionName) The name of the Region.
ReplicaDescription	withReplicaInaccessibleDateTime(Date replicaInaccessibleDateTime) The time at which the replica was first detected as inaccessible.
ReplicaDescription	withReplicaStatus(ReplicaStatus replicaStatus) The current state of the replica:
ReplicaDescription	withReplicaStatus(String replicaStatus) The current state of the replica:
ReplicaDescription	withReplicaStatusDescription(String replicaStatusDescription) Detailed information about the replica status.
ReplicaDescription	withReplicaStatusPercentProgress(String replicaStatusPercentProgress) Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
ReplicaDescription	withReplicaTableClassSummary(TableClassSummary replicaTableClassSummary)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReplicaDescription

public ReplicaDescription()

Method Detail

setRegionName

public void setRegionName(String regionName)

The name of the Region.

Parameters:

regionName - The name of the Region.

getRegionName

public String getRegionName()

The name of the Region.

Returns:

The name of the Region.

withRegionName

public ReplicaDescription withRegionName(String regionName)

The name of the Region.

Parameters:

regionName - The name of the Region.

Returns:

Returns a reference to this object so that method calls can be chained together.

setReplicaStatus

public void setReplicaStatus(String 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.

Parameters:

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.

See Also:

ReplicaStatus

getReplicaStatus

public String getReplicaStatus()

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.

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:

ReplicaStatus

withReplicaStatus

public ReplicaDescription withReplicaStatus(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ReplicaStatus

withReplicaStatus

public ReplicaDescription withReplicaStatus(ReplicaStatus 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ReplicaStatus

setReplicaStatusDescription

public void setReplicaStatusDescription(String replicaStatusDescription)

Detailed information about the replica status.

Parameters:

replicaStatusDescription - Detailed information about the replica status.

getReplicaStatusDescription

public String getReplicaStatusDescription()

Detailed information about the replica status.

Returns:

Detailed information about the replica status.

withReplicaStatusDescription

public ReplicaDescription withReplicaStatusDescription(String replicaStatusDescription)

Detailed information about the replica status.

Parameters:

replicaStatusDescription - Detailed information about the replica status.

Returns:

Returns a reference to this object so that method calls can be chained together.

setReplicaStatusPercentProgress

public void setReplicaStatusPercentProgress(String replicaStatusPercentProgress)

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

Parameters:

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

getReplicaStatusPercentProgress

public String getReplicaStatusPercentProgress()

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.

withReplicaStatusPercentProgress

public ReplicaDescription withReplicaStatusPercentProgress(String replicaStatusPercentProgress)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setKMSMasterKeyId

public void setKMSMasterKeyId(String kMSMasterKeyId)

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

Parameters:

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

getKMSMasterKeyId

public String getKMSMasterKeyId()

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.

withKMSMasterKeyId

public ReplicaDescription withKMSMasterKeyId(String kMSMasterKeyId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setProvisionedThroughputOverride

public void setProvisionedThroughputOverride(ProvisionedThroughputOverride provisionedThroughputOverride)

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

Parameters:

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

getProvisionedThroughputOverride

public ProvisionedThroughputOverride getProvisionedThroughputOverride()

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.

withProvisionedThroughputOverride

public ReplicaDescription withProvisionedThroughputOverride(ProvisionedThroughputOverride provisionedThroughputOverride)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getGlobalSecondaryIndexes

public List<ReplicaGlobalSecondaryIndexDescription> getGlobalSecondaryIndexes()

Replica-specific global secondary index settings.

Returns:

Replica-specific global secondary index settings.

setGlobalSecondaryIndexes

public void setGlobalSecondaryIndexes(Collection<ReplicaGlobalSecondaryIndexDescription> globalSecondaryIndexes)

Replica-specific global secondary index settings.

Parameters:

globalSecondaryIndexes - Replica-specific global secondary index settings.

withGlobalSecondaryIndexes

public ReplicaDescription withGlobalSecondaryIndexes(ReplicaGlobalSecondaryIndexDescription... globalSecondaryIndexes)

Replica-specific global secondary index settings.

NOTE: This method appends the values to the existing list (if any). Use setGlobalSecondaryIndexes(java.util.Collection) or withGlobalSecondaryIndexes(java.util.Collection) if you want to override the existing values.

Parameters:

globalSecondaryIndexes - Replica-specific global secondary index settings.

Returns:

Returns a reference to this object so that method calls can be chained together.

withGlobalSecondaryIndexes

public ReplicaDescription withGlobalSecondaryIndexes(Collection<ReplicaGlobalSecondaryIndexDescription> globalSecondaryIndexes)

Replica-specific global secondary index settings.

Parameters:

globalSecondaryIndexes - Replica-specific global secondary index settings.

Returns:

Returns a reference to this object so that method calls can be chained together.

setReplicaInaccessibleDateTime

public void setReplicaInaccessibleDateTime(Date replicaInaccessibleDateTime)

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

Parameters:

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

getReplicaInaccessibleDateTime

public Date getReplicaInaccessibleDateTime()

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.

withReplicaInaccessibleDateTime

public ReplicaDescription withReplicaInaccessibleDateTime(Date replicaInaccessibleDateTime)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setReplicaTableClassSummary

public void setReplicaTableClassSummary(TableClassSummary replicaTableClassSummary)

Parameters:

replicaTableClassSummary -

getReplicaTableClassSummary

public TableClassSummary getReplicaTableClassSummary()

Returns:

withReplicaTableClassSummary

public ReplicaDescription withReplicaTableClassSummary(TableClassSummary replicaTableClassSummary)

Parameters:

replicaTableClassSummary -

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String 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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ReplicaDescription clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo