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 DocumentDB 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 DocumentDB cluster administrator.
`String`	`getClusterArn()` The arn of the Elastic DocumentDB cluster.
`String`	`getClusterCreationTime()` The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
`String`	`getKmsKeyId()` The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
`String`	`getSnapshotArn()` The arn of the Elastic DocumentDB snapshot
`String`	`getSnapshotCreationTime()` The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).
`String`	`getSnapshotName()` The name of the Elastic DocumentDB snapshot.
`String`	`getStatus()` The status of the Elastic DocumentDB snapshot.
`List<String>`	`getSubnetIds()` A list of the IDs of subnets associated with the DB cluster snapshot.
`List<String>`	`getVpcSecurityGroupIds()` A list of the IDs of the VPC security groups associated with the cluster snapshot.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdminUserName(String adminUserName)` The name of the Elastic DocumentDB cluster administrator.
`void`	`setClusterArn(String clusterArn)` The arn of the Elastic DocumentDB cluster.
`void`	`setClusterCreationTime(String clusterCreationTime)` The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
`void`	`setKmsKeyId(String kmsKeyId)` The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
`void`	`setSnapshotArn(String snapshotArn)` The arn of the Elastic DocumentDB snapshot
`void`	`setSnapshotCreationTime(String snapshotCreationTime)` The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).
`void`	`setSnapshotName(String snapshotName)` The name of the Elastic DocumentDB snapshot.
`void`	`setStatus(String status)` The status of the Elastic DocumentDB snapshot.
`void`	`setSubnetIds(Collection<String> subnetIds)` A list of the IDs of subnets associated with the DB cluster snapshot.
`void`	`setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)` A list of the IDs of the VPC security groups associated with the cluster snapshot.
`String`	`toString()` Returns a string representation of this object.
`ClusterSnapshot`	`withAdminUserName(String adminUserName)` The name of the Elastic DocumentDB cluster administrator.
`ClusterSnapshot`	`withClusterArn(String clusterArn)` The arn of the Elastic DocumentDB cluster.
`ClusterSnapshot`	`withClusterCreationTime(String clusterCreationTime)` The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
`ClusterSnapshot`	`withKmsKeyId(String kmsKeyId)` The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
`ClusterSnapshot`	`withSnapshotArn(String snapshotArn)` The arn of the Elastic DocumentDB snapshot
`ClusterSnapshot`	`withSnapshotCreationTime(String snapshotCreationTime)` The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).
`ClusterSnapshot`	`withSnapshotName(String snapshotName)` The name of the Elastic DocumentDB snapshot.
`ClusterSnapshot`	`withStatus(Status status)` The status of the Elastic DocumentDB snapshot.
`ClusterSnapshot`	`withStatus(String status)` The status of the Elastic DocumentDB snapshot.
`ClusterSnapshot`	`withSubnetIds(Collection<String> subnetIds)` A list of the IDs of subnets associated with the DB cluster snapshot.
`ClusterSnapshot`	`withSubnetIds(String... subnetIds)` A list of the IDs of subnets associated with the DB cluster snapshot.
`ClusterSnapshot`	`withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)` A list of the IDs of the VPC security groups associated with the cluster snapshot.
`ClusterSnapshot`	`withVpcSecurityGroupIds(String... vpcSecurityGroupIds)` A list of the IDs of the VPC security groups associated with the cluster snapshot.

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 DocumentDB cluster administrator.
    
    Parameters:
    
    adminUserName - The name of the Elastic DocumentDB cluster administrator.
  - getAdminUserName
```
public String getAdminUserName()
```
    The name of the Elastic DocumentDB cluster administrator.
    
    Returns:
    
    The name of the Elastic DocumentDB cluster administrator.
  - withAdminUserName
```
public ClusterSnapshot withAdminUserName(String adminUserName)
```
    The name of the Elastic DocumentDB cluster administrator.
    
    Parameters:
    
    adminUserName - The name of the Elastic DocumentDB 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 of the Elastic DocumentDB cluster.
    
    Parameters:
    
    clusterArn - The arn of the Elastic DocumentDB cluster.
  - getClusterArn
```
public String getClusterArn()
```
    The arn of the Elastic DocumentDB cluster.
    
    Returns:
    
    The arn of the Elastic DocumentDB cluster.
  - withClusterArn
```
public ClusterSnapshot withClusterArn(String clusterArn)
```
    The arn of the Elastic DocumentDB cluster.
    
    Parameters:
    
    clusterArn - The arn of the Elastic DocumentDB 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 DocumentDB cluster was created in Universal Coordinated Time (UTC).
    
    Parameters:
    
    clusterCreationTime - The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
  - getClusterCreationTime
```
public String getClusterCreationTime()
```
    The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
    
    Returns:
    
    The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
  - withClusterCreationTime
```
public ClusterSnapshot withClusterCreationTime(String clusterCreationTime)
```
    The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
    
    Parameters:
    
    clusterCreationTime - The time when the Elastic DocumentDB 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 to use to encrypt the Elastic DocumentDB cluster.
    
    Parameters:
    
    kmsKeyId - The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
    
    Returns:
    
    The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
  - withKmsKeyId
```
public ClusterSnapshot withKmsKeyId(String kmsKeyId)
```
    The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
    
    Parameters:
    
    kmsKeyId - The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSnapshotArn
```
public void setSnapshotArn(String snapshotArn)
```
    The arn of the Elastic DocumentDB snapshot
    
    Parameters:
    
    snapshotArn - The arn of the Elastic DocumentDB snapshot
  - getSnapshotArn
```
public String getSnapshotArn()
```
    The arn of the Elastic DocumentDB snapshot
    
    Returns:
    
    The arn of the Elastic DocumentDB snapshot
  - withSnapshotArn
```
public ClusterSnapshot withSnapshotArn(String snapshotArn)
```
    The arn of the Elastic DocumentDB snapshot
    
    Parameters:
    
    snapshotArn - The arn of the Elastic DocumentDB 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 DocumentDB snapshot was created in Universal Coordinated Time (UTC).
    
    Parameters:
    
    snapshotCreationTime - The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).
  - getSnapshotCreationTime
```
public String getSnapshotCreationTime()
```
    The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).
    
    Returns:
    
    The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).
  - withSnapshotCreationTime
```
public ClusterSnapshot withSnapshotCreationTime(String snapshotCreationTime)
```
    The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).
    
    Parameters:
    
    snapshotCreationTime - The time when the Elastic DocumentDB 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 DocumentDB snapshot.
    
    Parameters:
    
    snapshotName - The name of the Elastic DocumentDB snapshot.
  - getSnapshotName
```
public String getSnapshotName()
```
    The name of the Elastic DocumentDB snapshot.
    
    Returns:
    
    The name of the Elastic DocumentDB snapshot.
  - withSnapshotName
```
public ClusterSnapshot withSnapshotName(String snapshotName)
```
    The name of the Elastic DocumentDB snapshot.
    
    Parameters:
    
    snapshotName - The name of the Elastic DocumentDB snapshot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the Elastic DocumentDB snapshot.
    
    Parameters:
    
    status - The status of the Elastic DocumentDB snapshot.
    
    See Also:
    
    Status
  - getStatus
```
public String getStatus()
```
    The status of the Elastic DocumentDB snapshot.
    
    Returns:
    
    The status of the Elastic DocumentDB snapshot.
    
    See Also:
    
    Status
  - withStatus
```
public ClusterSnapshot withStatus(String status)
```
    The status of the Elastic DocumentDB snapshot.
    
    Parameters:
    
    status - The status of the Elastic DocumentDB 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 DocumentDB snapshot.
    
    Parameters:
    
    status - The status of the Elastic DocumentDB snapshot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Status
  - getSubnetIds
```
public List<String> getSubnetIds()
```
    A list of the IDs of subnets associated with the DB cluster snapshot.
    
    Returns:
    
    A list of the IDs of subnets associated with the DB cluster snapshot.
  - setSubnetIds
```
public void setSubnetIds(Collection<String> subnetIds)
```
    A list of the IDs of subnets associated with the DB cluster snapshot.
    
    Parameters:
    
    subnetIds - A list of the IDs of subnets associated with the DB cluster snapshot.
  - withSubnetIds
```
public ClusterSnapshot withSubnetIds(String... subnetIds)
```
    A list of the IDs of subnets associated with the DB cluster snapshot.
    
    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 - A list of the IDs of subnets associated with the DB cluster snapshot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSubnetIds
```
public ClusterSnapshot withSubnetIds(Collection<String> subnetIds)
```
    A list of the IDs of subnets associated with the DB cluster snapshot.
    
    Parameters:
    
    subnetIds - A list of the IDs of subnets associated with the DB cluster snapshot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getVpcSecurityGroupIds
```
public List<String> getVpcSecurityGroupIds()
```
    A list of the IDs of the VPC security groups associated with the cluster snapshot.
    
    Returns:
    
    A list of the IDs of the VPC security groups associated with the cluster snapshot.
  - setVpcSecurityGroupIds
```
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
```
    A list of the IDs of the VPC security groups associated with the cluster snapshot.
    
    Parameters:
    
    vpcSecurityGroupIds - A list of the IDs of the VPC security groups associated with the cluster snapshot.
  - withVpcSecurityGroupIds
```
public ClusterSnapshot withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
```
    A list of the IDs of the VPC security groups associated with the cluster snapshot.
    
    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 the IDs of the VPC security groups associated with the cluster snapshot.
    
    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 the IDs of the VPC security groups associated with the cluster snapshot.
    
    Parameters:
    
    vpcSecurityGroupIds - A list of the IDs of the VPC security groups associated with the cluster snapshot.
    
    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.

Did this page help you?

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

setStatus

getStatus

withStatus

withStatus

getSubnetIds

setSubnetIds

withSubnetIds

withSubnetIds

getVpcSecurityGroupIds

setVpcSecurityGroupIds

withVpcSecurityGroupIds

withVpcSecurityGroupIds

toString

equals

hashCode

clone

marshall