com.amazonaws.services.docdbelastic.model

Class RestoreClusterFromSnapshotRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.docdbelastic.model.RestoreClusterFromSnapshotRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RestoreClusterFromSnapshotRequest()

Method Summary

Modifier and Type	Method and Description
RestoreClusterFromSnapshotRequest	addTagsEntry(String key, String value) Add a single Tags entry
RestoreClusterFromSnapshotRequest	clearTagsEntries() Removes all the entries added into Tags.
RestoreClusterFromSnapshotRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClusterName() The name of the elastic cluster.
String	getKmsKeyId() The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters cluster.
Integer	getShardCapacity() The capacity of each shard in the new restored elastic cluster.
Integer	getShardInstanceCount() The number of replica instances applying to all shards in the elastic cluster.
String	getSnapshotArn() The ARN identifier of the elastic cluster snapshot.
List<String>	getSubnetIds() The Amazon EC2 subnet IDs for the elastic cluster.
Map<String,String>	getTags() A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.
List<String>	getVpcSecurityGroupIds() A list of EC2 VPC security groups to associate with the elastic cluster.
int	hashCode()
void	setClusterName(String clusterName) The name of the elastic cluster.
void	setKmsKeyId(String kmsKeyId) The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters cluster.
void	setShardCapacity(Integer shardCapacity) The capacity of each shard in the new restored elastic cluster.
void	setShardInstanceCount(Integer shardInstanceCount) The number of replica instances applying to all shards in the elastic cluster.
void	setSnapshotArn(String snapshotArn) The ARN identifier of the elastic cluster snapshot.
void	setSubnetIds(Collection<String> subnetIds) The Amazon EC2 subnet IDs for the elastic cluster.
void	setTags(Map<String,String> tags) A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.
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.
RestoreClusterFromSnapshotRequest	withClusterName(String clusterName) The name of the elastic cluster.
RestoreClusterFromSnapshotRequest	withKmsKeyId(String kmsKeyId) The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters cluster.
RestoreClusterFromSnapshotRequest	withShardCapacity(Integer shardCapacity) The capacity of each shard in the new restored elastic cluster.
RestoreClusterFromSnapshotRequest	withShardInstanceCount(Integer shardInstanceCount) The number of replica instances applying to all shards in the elastic cluster.
RestoreClusterFromSnapshotRequest	withSnapshotArn(String snapshotArn) The ARN identifier of the elastic cluster snapshot.
RestoreClusterFromSnapshotRequest	withSubnetIds(Collection<String> subnetIds) The Amazon EC2 subnet IDs for the elastic cluster.
RestoreClusterFromSnapshotRequest	withSubnetIds(String... subnetIds) The Amazon EC2 subnet IDs for the elastic cluster.
RestoreClusterFromSnapshotRequest	withTags(Map<String,String> tags) A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.
RestoreClusterFromSnapshotRequest	withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) A list of EC2 VPC security groups to associate with the elastic cluster.
RestoreClusterFromSnapshotRequest	withVpcSecurityGroupIds(String... vpcSecurityGroupIds) A list of EC2 VPC security groups to associate with the elastic cluster.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RestoreClusterFromSnapshotRequest

public RestoreClusterFromSnapshotRequest()

Method Detail

setClusterName

public void setClusterName(String clusterName)

The name of the elastic cluster.

Parameters:

clusterName - The name of the elastic cluster.

getClusterName

public String getClusterName()

The name of the elastic cluster.

Returns:

The name of the elastic cluster.

withClusterName

public RestoreClusterFromSnapshotRequest withClusterName(String clusterName)

The name of the elastic cluster.

Parameters:

clusterName - The name of the elastic cluster.

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 new Amazon DocumentDB elastic clusters cluster.

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 to use to encrypt the new Amazon DocumentDB elastic clusters cluster.

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 to use to encrypt the new Amazon DocumentDB elastic clusters cluster.

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 to use to encrypt the new Amazon DocumentDB elastic clusters cluster.

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 RestoreClusterFromSnapshotRequest withKmsKeyId(String kmsKeyId)

The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters cluster.

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 to use to encrypt the new Amazon DocumentDB elastic clusters cluster.

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.

setShardCapacity

public void setShardCapacity(Integer shardCapacity)

The capacity of each shard in the new restored elastic cluster.

Parameters:

shardCapacity - The capacity of each shard in the new restored elastic cluster.

getShardCapacity

public Integer getShardCapacity()

The capacity of each shard in the new restored elastic cluster.

Returns:

The capacity of each shard in the new restored elastic cluster.

withShardCapacity

public RestoreClusterFromSnapshotRequest withShardCapacity(Integer shardCapacity)

The capacity of each shard in the new restored elastic cluster.

Parameters:

shardCapacity - The capacity of each shard in the new restored elastic cluster.

Returns:

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

setShardInstanceCount

public void setShardInstanceCount(Integer shardInstanceCount)

The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

Parameters:

shardInstanceCount - The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

getShardInstanceCount

public Integer getShardInstanceCount()

The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

Returns:

The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

withShardInstanceCount

public RestoreClusterFromSnapshotRequest withShardInstanceCount(Integer shardInstanceCount)

The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

Parameters:

shardInstanceCount - The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

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

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

getTags

public Map<String,String> getTags()

A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.

Returns:

A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.

setTags

public void setTags(Map<String,String> tags)

A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.

Parameters:

tags - A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.

withTags

public RestoreClusterFromSnapshotRequest withTags(Map<String,String> tags)

A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.

Parameters:

tags - A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.

Returns:

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

addTagsEntry

public RestoreClusterFromSnapshotRequest addTagsEntry(String key,
                                                      String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public RestoreClusterFromSnapshotRequest clearTagsEntries()

Removes all the entries added into Tags.

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 RestoreClusterFromSnapshotRequest 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 RestoreClusterFromSnapshotRequest 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 RestoreClusterFromSnapshotRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()