ClusterSnapshot (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.docdbelastic.model.ClusterSnapshot

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ClusterSnapshot
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Returns information about a specific elastic cluster snapshot.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ClusterSnapshot()

Constructors
Constructor and Description
`ClusterSnapshot()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClusterSnapshot`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAdminUserName()` The name of the elastic cluster administrator.
`String`	`getClusterArn()` The ARN identifier of the elastic cluster.
`String`	`getClusterCreationTime()` The time when the elastic cluster was created in Universal Coordinated Time (UTC).
`String`	`getKmsKeyId()` The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key.
`String`	`getSnapshotArn()` The ARN identifier of the elastic cluster snapshot.
`String`	`getSnapshotCreationTime()` The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).
`String`	`getSnapshotName()` The name of the elastic cluster snapshot.
`String`	`getSnapshotType()` The type of cluster snapshots to be returned.
`String`	`getStatus()` The status of the elastic cluster snapshot.
`List<String>`	`getSubnetIds()` The Amazon EC2 subnet IDs for the elastic cluster.
`List<String>`	`getVpcSecurityGroupIds()` A list of EC2 VPC security groups to associate with the elastic cluster.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdminUserName(String adminUserName)` The name of the elastic cluster administrator.
`void`	`setClusterArn(String clusterArn)` The ARN identifier of the elastic cluster.
`void`	`setClusterCreationTime(String clusterCreationTime)` The time when the elastic cluster was created in Universal Coordinated Time (UTC).
`void`	`setKmsKeyId(String kmsKeyId)` The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key.
`void`	`setSnapshotArn(String snapshotArn)` The ARN identifier of the elastic cluster snapshot.
`void`	`setSnapshotCreationTime(String snapshotCreationTime)` The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).
`void`	`setSnapshotName(String snapshotName)` The name of the elastic cluster snapshot.
`void`	`setSnapshotType(String snapshotType)` The type of cluster snapshots to be returned.
`void`	`setStatus(String status)` The status of the elastic cluster snapshot.
`void`	`setSubnetIds(Collection<String> subnetIds)` The Amazon EC2 subnet IDs for the elastic cluster.
`void`	`setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)` A list of EC2 VPC security groups to associate with the elastic cluster.
`String`	`toString()` Returns a string representation of this object.
`ClusterSnapshot`	`withAdminUserName(String adminUserName)` The name of the elastic cluster administrator.
`ClusterSnapshot`	`withClusterArn(String clusterArn)` The ARN identifier of the elastic cluster.
`ClusterSnapshot`	`withClusterCreationTime(String clusterCreationTime)` The time when the elastic cluster was created in Universal Coordinated Time (UTC).
`ClusterSnapshot`	`withKmsKeyId(String kmsKeyId)` The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key.
`ClusterSnapshot`	`withSnapshotArn(String snapshotArn)` The ARN identifier of the elastic cluster snapshot.
`ClusterSnapshot`	`withSnapshotCreationTime(String snapshotCreationTime)` The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).
`ClusterSnapshot`	`withSnapshotName(String snapshotName)` The name of the elastic cluster snapshot.
`ClusterSnapshot`	`withSnapshotType(SnapshotType snapshotType)` The type of cluster snapshots to be returned.
`ClusterSnapshot`	`withSnapshotType(String snapshotType)` The type of cluster snapshots to be returned.
`ClusterSnapshot`	`withStatus(Status status)` The status of the elastic cluster snapshot.
`ClusterSnapshot`	`withStatus(String status)` The status of the elastic cluster snapshot.
`ClusterSnapshot`	`withSubnetIds(Collection<String> subnetIds)` The Amazon EC2 subnet IDs for the elastic cluster.
`ClusterSnapshot`	`withSubnetIds(String... subnetIds)` The Amazon EC2 subnet IDs for the elastic cluster.
`ClusterSnapshot`	`withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)` A list of EC2 VPC security groups to associate with the elastic cluster.
`ClusterSnapshot`	`withVpcSecurityGroupIds(String... vpcSecurityGroupIds)` A list of EC2 VPC security groups to associate with the elastic cluster.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ClusterSnapshot
```
public ClusterSnapshot()
```
- Method Detail
  - setAdminUserName
```
public void setAdminUserName(String adminUserName)
```
    The name of the elastic cluster administrator.
    
    Parameters:
    
    adminUserName - The name of the elastic cluster administrator.
  - getAdminUserName
```
public String getAdminUserName()
```
    The name of the elastic cluster administrator.
    
    Returns:
    
    The name of the elastic cluster administrator.
  - withAdminUserName
```
public ClusterSnapshot withAdminUserName(String adminUserName)
```
    The name of the elastic cluster administrator.
    
    Parameters:
    
    adminUserName - The name of the elastic cluster administrator.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClusterArn
```
public void setClusterArn(String clusterArn)
```
    The ARN identifier of the elastic cluster.
    
    Parameters:
    
    clusterArn - The ARN identifier of the elastic cluster.
  - getClusterArn
```
public String getClusterArn()
```
    The ARN identifier of the elastic cluster.
    
    Returns:
    
    The ARN identifier of the elastic cluster.
  - withClusterArn
```
public ClusterSnapshot withClusterArn(String clusterArn)
```
    The ARN identifier of the elastic cluster.
    
    Parameters:
    
    clusterArn - The ARN identifier of the elastic cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClusterCreationTime
```
public void setClusterCreationTime(String clusterCreationTime)
```
    The time when the elastic cluster was created in Universal Coordinated Time (UTC).
    
    Parameters:
    
    clusterCreationTime - The time when the elastic cluster was created in Universal Coordinated Time (UTC).
  - getClusterCreationTime
```
public String getClusterCreationTime()
```
    The time when the elastic cluster was created in Universal Coordinated Time (UTC).
    
    Returns:
    
    The time when the elastic cluster was created in Universal Coordinated Time (UTC).
  - withClusterCreationTime
```
public ClusterSnapshot withClusterCreationTime(String clusterCreationTime)
```
    The time when the elastic cluster was created in Universal Coordinated Time (UTC).
    
    Parameters:
    
    clusterCreationTime - The time when the elastic cluster was created in Universal Coordinated Time (UTC).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
    
    Parameters:
    
    kmsKeyId - The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
    
    Returns:
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
  - withKmsKeyId
```
public ClusterSnapshot withKmsKeyId(String kmsKeyId)
```
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
    
    Parameters:
    
    kmsKeyId - The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSnapshotArn
```
public void setSnapshotArn(String snapshotArn)
```
    The ARN identifier of the elastic cluster snapshot.
    
    Parameters:
    
    snapshotArn - The ARN identifier of the elastic cluster snapshot.
  - getSnapshotArn
```
public String getSnapshotArn()
```
    The ARN identifier of the elastic cluster snapshot.
    
    Returns:
    
    The ARN identifier of the elastic cluster snapshot.
  - withSnapshotArn
```
public ClusterSnapshot withSnapshotArn(String snapshotArn)
```
    The ARN identifier of the elastic cluster snapshot.
    
    Parameters:
    
    snapshotArn - The ARN identifier of the elastic cluster snapshot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSnapshotCreationTime
```
public void setSnapshotCreationTime(String snapshotCreationTime)
```
    The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).
    
    Parameters:
    
    snapshotCreationTime - The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).
  - getSnapshotCreationTime
```
public String getSnapshotCreationTime()
```
    The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).
    
    Returns:
    
    The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).
  - withSnapshotCreationTime
```
public ClusterSnapshot withSnapshotCreationTime(String snapshotCreationTime)
```
    The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).
    
    Parameters:
    
    snapshotCreationTime - The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSnapshotName
```
public void setSnapshotName(String snapshotName)
```
    The name of the elastic cluster snapshot.
    
    Parameters:
    
    snapshotName - The name of the elastic cluster snapshot.
  - getSnapshotName
```
public String getSnapshotName()
```
    The name of the elastic cluster snapshot.
    
    Returns:
    
    The name of the elastic cluster snapshot.
  - withSnapshotName
```
public ClusterSnapshot withSnapshotName(String snapshotName)
```
    The name of the elastic cluster snapshot.
    
    Parameters:
    
    snapshotName - The name of the elastic cluster snapshot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSnapshotType
```
public void setSnapshotType(String snapshotType)
```
    The type of cluster snapshots to be returned. You can specify one of the following values:
    - automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
    - manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
    Parameters:
    snapshotType - The type of cluster snapshots to be returned. You can specify one of the following values:
    
    automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
    
    manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
    See Also:
    
    SnapshotType
  - getSnapshotType
```
public String getSnapshotType()
```
    The type of cluster snapshots to be returned. You can specify one of the following values:
    - automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
    - manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
    Returns:
    The type of cluster snapshots to be returned. You can specify one of the following values:
    
    automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
    
    manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
    See Also:
    
    SnapshotType
  - withSnapshotType
```
public ClusterSnapshot withSnapshotType(String snapshotType)
```
    The type of cluster snapshots to be returned. You can specify one of the following values:
    - automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
    - manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
    Parameters:
    snapshotType - The type of cluster snapshots to be returned. You can specify one of the following values:
    
    automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
    
    manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SnapshotType
  - withSnapshotType
```
public ClusterSnapshot withSnapshotType(SnapshotType snapshotType)
```
    The type of cluster snapshots to be returned. You can specify one of the following values:
    - automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
    - manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
    Parameters:
    snapshotType - The type of cluster snapshots to be returned. You can specify one of the following values:
    
    automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
    
    manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SnapshotType
  - setStatus
```
public void setStatus(String status)
```
    The status of the elastic cluster snapshot.
    
    Parameters:
    
    status - The status of the elastic cluster snapshot.
    
    See Also:
    
    Status
  - getStatus
```
public String getStatus()
```
    The status of the elastic cluster snapshot.
    
    Returns:
    
    The status of the elastic cluster snapshot.
    
    See Also:
    
    Status
  - withStatus
```
public ClusterSnapshot withStatus(String status)
```
    The status of the elastic cluster snapshot.
    
    Parameters:
    
    status - The status of the elastic cluster snapshot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Status
  - withStatus
```
public ClusterSnapshot withStatus(Status status)
```
    The status of the elastic cluster snapshot.
    
    Parameters:
    
    status - The status of the elastic cluster snapshot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Status
  - getSubnetIds
```
public List<String> getSubnetIds()
```
    The Amazon EC2 subnet IDs for the elastic cluster.
    
    Returns:
    
    The Amazon EC2 subnet IDs for the elastic cluster.
  - setSubnetIds
```
public void setSubnetIds(Collection<String> subnetIds)
```
    The Amazon EC2 subnet IDs for the elastic cluster.
    
    Parameters:
    
    subnetIds - The Amazon EC2 subnet IDs for the elastic cluster.
  - withSubnetIds
```
public ClusterSnapshot withSubnetIds(String... subnetIds)
```
    The Amazon EC2 subnet IDs for the elastic cluster.
    
    NOTE: This method appends the values to the existing list (if any). Use setSubnetIds(java.util.Collection) or withSubnetIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    subnetIds - The Amazon EC2 subnet IDs for the elastic cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSubnetIds
```
public ClusterSnapshot withSubnetIds(Collection<String> subnetIds)
```
    The Amazon EC2 subnet IDs for the elastic cluster.
    
    Parameters:
    
    subnetIds - The Amazon EC2 subnet IDs for the elastic cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getVpcSecurityGroupIds
```
public List<String> getVpcSecurityGroupIds()
```
    A list of EC2 VPC security groups to associate with the elastic cluster.
    
    Returns:
    
    A list of EC2 VPC security groups to associate with the elastic cluster.
  - setVpcSecurityGroupIds
```
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
```
    A list of EC2 VPC security groups to associate with the elastic cluster.
    
    Parameters:
    
    vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with the elastic cluster.
  - withVpcSecurityGroupIds
```
public ClusterSnapshot withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
```
    A list of EC2 VPC security groups to associate with the elastic cluster.
    
    NOTE: This method appends the values to the existing list (if any). Use setVpcSecurityGroupIds(java.util.Collection) or withVpcSecurityGroupIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with the elastic cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withVpcSecurityGroupIds
```
public ClusterSnapshot withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
```
    A list of EC2 VPC security groups to associate with the elastic cluster.
    
    Parameters:
    
    vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with the elastic cluster.
    
    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 ClusterSnapshot clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.772

Class ClusterSnapshot

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClusterSnapshot

Method Detail

setAdminUserName

getAdminUserName

withAdminUserName

setClusterArn

getClusterArn

withClusterArn

setClusterCreationTime

getClusterCreationTime

withClusterCreationTime

setKmsKeyId

getKmsKeyId

withKmsKeyId

setSnapshotArn

getSnapshotArn

withSnapshotArn

setSnapshotCreationTime

getSnapshotCreationTime

withSnapshotCreationTime

setSnapshotName

getSnapshotName

withSnapshotName

setSnapshotType

getSnapshotType

withSnapshotType

withSnapshotType

setStatus

getStatus

withStatus

withStatus

getSubnetIds

setSubnetIds

withSubnetIds

withSubnetIds

getVpcSecurityGroupIds

setVpcSecurityGroupIds

withVpcSecurityGroupIds

withVpcSecurityGroupIds

toString

equals

hashCode

clone

marshall