com.amazonaws.services.neptune.model

Class CopyDBClusterSnapshotRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.neptune.model.CopyDBClusterSnapshotRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CopyDBClusterSnapshotRequest
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
CopyDBClusterSnapshotRequest()

Method Summary

Modifier and Type	Method and Description
CopyDBClusterSnapshotRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getCopyTags() True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false.
String	getKmsKeyId() The Amazon Amazon KMS key ID for an encrypted DB cluster snapshot.
String	getPreSignedUrl() Not currently supported.
String	getSourceDBClusterSnapshotIdentifier() The identifier of the DB cluster snapshot to copy.
String	getSourceRegion() The region where the source instance is located.
List<Tag>	getTags() The tags to assign to the new DB cluster snapshot copy.
String	getTargetDBClusterSnapshotIdentifier() The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot.
int	hashCode()
Boolean	isCopyTags() True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false.
void	setCopyTags(Boolean copyTags) True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false.
void	setKmsKeyId(String kmsKeyId) The Amazon Amazon KMS key ID for an encrypted DB cluster snapshot.
void	setPreSignedUrl(String preSignedUrl) Not currently supported.
void	setSourceDBClusterSnapshotIdentifier(String sourceDBClusterSnapshotIdentifier) The identifier of the DB cluster snapshot to copy.
void	setSourceRegion(String sourceRegion) The region where the source instance is located.
void	setTags(Collection<Tag> tags) The tags to assign to the new DB cluster snapshot copy.
void	setTargetDBClusterSnapshotIdentifier(String targetDBClusterSnapshotIdentifier) The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot.
String	toString() Returns a string representation of this object.
CopyDBClusterSnapshotRequest	withCopyTags(Boolean copyTags) True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false.
CopyDBClusterSnapshotRequest	withKmsKeyId(String kmsKeyId) The Amazon Amazon KMS key ID for an encrypted DB cluster snapshot.
CopyDBClusterSnapshotRequest	withPreSignedUrl(String preSignedUrl) Not currently supported.
CopyDBClusterSnapshotRequest	withSourceDBClusterSnapshotIdentifier(String sourceDBClusterSnapshotIdentifier) The identifier of the DB cluster snapshot to copy.
CopyDBClusterSnapshotRequest	withSourceRegion(String sourceRegion) The region where the source instance is located.
CopyDBClusterSnapshotRequest	withTags(Collection<Tag> tags) The tags to assign to the new DB cluster snapshot copy.
CopyDBClusterSnapshotRequest	withTags(Tag... tags) The tags to assign to the new DB cluster snapshot copy.
CopyDBClusterSnapshotRequest	withTargetDBClusterSnapshotIdentifier(String targetDBClusterSnapshotIdentifier) The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot.

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

CopyDBClusterSnapshotRequest

public CopyDBClusterSnapshotRequest()

Method Detail

setSourceDBClusterSnapshotIdentifier

public void setSourceDBClusterSnapshotIdentifier(String sourceDBClusterSnapshotIdentifier)

The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.

Constraints:

• Must specify a valid system snapshot in the "available" state.

• Specify a valid DB snapshot identifier.

Example: my-cluster-snapshot1

Parameters:

sourceDBClusterSnapshotIdentifier - The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.

Constraints:

• Must specify a valid system snapshot in the "available" state.

• Specify a valid DB snapshot identifier.

Example: my-cluster-snapshot1

getSourceDBClusterSnapshotIdentifier

public String getSourceDBClusterSnapshotIdentifier()

The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.

Constraints:

• Must specify a valid system snapshot in the "available" state.

• Specify a valid DB snapshot identifier.

Example: my-cluster-snapshot1

Returns:

The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.

Constraints:

• Must specify a valid system snapshot in the "available" state.

• Specify a valid DB snapshot identifier.

Example: my-cluster-snapshot1

withSourceDBClusterSnapshotIdentifier

public CopyDBClusterSnapshotRequest withSourceDBClusterSnapshotIdentifier(String sourceDBClusterSnapshotIdentifier)

The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.

Constraints:

• Must specify a valid system snapshot in the "available" state.

• Specify a valid DB snapshot identifier.

Example: my-cluster-snapshot1

Parameters:

sourceDBClusterSnapshotIdentifier - The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.

Constraints:

• Must specify a valid system snapshot in the "available" state.

• Specify a valid DB snapshot identifier.

Example: my-cluster-snapshot1

Returns:

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

setTargetDBClusterSnapshotIdentifier

public void setTargetDBClusterSnapshotIdentifier(String targetDBClusterSnapshotIdentifier)

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• First character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

Parameters:

targetDBClusterSnapshotIdentifier - The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• First character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

getTargetDBClusterSnapshotIdentifier

public String getTargetDBClusterSnapshotIdentifier()

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• First character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

Returns:

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• First character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

withTargetDBClusterSnapshotIdentifier

public CopyDBClusterSnapshotRequest withTargetDBClusterSnapshotIdentifier(String targetDBClusterSnapshotIdentifier)

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• First character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

Parameters:

targetDBClusterSnapshotIdentifier - The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• First character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

Returns:

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

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

The Amazon Amazon KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted DB cluster snapshot from your Amazon account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

If you copy an encrypted DB cluster snapshot that is shared from another Amazon account, then you must specify a value for KmsKeyId.

KMS encryption keys are specific to the Amazon Region that they are created in, and you can't use encryption keys from one Amazon Region in another Amazon Region.

You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

Parameters:

kmsKeyId - The Amazon Amazon KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted DB cluster snapshot from your Amazon account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

If you copy an encrypted DB cluster snapshot that is shared from another Amazon account, then you must specify a value for KmsKeyId.

KMS encryption keys are specific to the Amazon Region that they are created in, and you can't use encryption keys from one Amazon Region in another Amazon Region.

You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

getKmsKeyId

public String getKmsKeyId()

The Amazon Amazon KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted DB cluster snapshot from your Amazon account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

If you copy an encrypted DB cluster snapshot that is shared from another Amazon account, then you must specify a value for KmsKeyId.

KMS encryption keys are specific to the Amazon Region that they are created in, and you can't use encryption keys from one Amazon Region in another Amazon Region.

You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

Returns:

The Amazon Amazon KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted DB cluster snapshot from your Amazon account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

If you copy an encrypted DB cluster snapshot that is shared from another Amazon account, then you must specify a value for KmsKeyId.

KMS encryption keys are specific to the Amazon Region that they are created in, and you can't use encryption keys from one Amazon Region in another Amazon Region.

You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

withKmsKeyId

public CopyDBClusterSnapshotRequest withKmsKeyId(String kmsKeyId)

The Amazon Amazon KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted DB cluster snapshot from your Amazon account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

If you copy an encrypted DB cluster snapshot that is shared from another Amazon account, then you must specify a value for KmsKeyId.

KMS encryption keys are specific to the Amazon Region that they are created in, and you can't use encryption keys from one Amazon Region in another Amazon Region.

You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

Parameters:

kmsKeyId - The Amazon Amazon KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted DB cluster snapshot from your Amazon account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

If you copy an encrypted DB cluster snapshot that is shared from another Amazon account, then you must specify a value for KmsKeyId.

KMS encryption keys are specific to the Amazon Region that they are created in, and you can't use encryption keys from one Amazon Region in another Amazon Region.

You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

Returns:

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

setPreSignedUrl

public void setPreSignedUrl(String preSignedUrl)

Not currently supported.

Parameters:

preSignedUrl - Not currently supported.

getPreSignedUrl

public String getPreSignedUrl()

Not currently supported.

Returns:

Not currently supported.

withPreSignedUrl

public CopyDBClusterSnapshotRequest withPreSignedUrl(String preSignedUrl)

Not currently supported.

Parameters:

preSignedUrl - Not currently supported.

Returns:

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

setCopyTags

public void setCopyTags(Boolean copyTags)

True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.

Parameters:

copyTags - True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.

getCopyTags

public Boolean getCopyTags()

True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.

Returns:

True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.

withCopyTags

public CopyDBClusterSnapshotRequest withCopyTags(Boolean copyTags)

True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.

Parameters:

copyTags - True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.

Returns:

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

isCopyTags

public Boolean isCopyTags()

True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.

Returns:

True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.

getTags

public List<Tag> getTags()

The tags to assign to the new DB cluster snapshot copy.

Returns:

The tags to assign to the new DB cluster snapshot copy.

setTags

public void setTags(Collection<Tag> tags)

The tags to assign to the new DB cluster snapshot copy.

Parameters:

tags - The tags to assign to the new DB cluster snapshot copy.

withTags

public CopyDBClusterSnapshotRequest withTags(Tag... tags)

The tags to assign to the new DB cluster snapshot copy.

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

Parameters:

tags - The tags to assign to the new DB cluster snapshot copy.

Returns:

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

withTags

public CopyDBClusterSnapshotRequest withTags(Collection<Tag> tags)

The tags to assign to the new DB cluster snapshot copy.

Parameters:

tags - The tags to assign to the new DB cluster snapshot copy.

Returns:

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

setSourceRegion

public void setSourceRegion(String sourceRegion)

The region where the source instance is located.

Parameters:

sourceRegion - The region where the source instance is located.

getSourceRegion

public String getSourceRegion()

The region where the source instance is located.

Returns:

The region where the source instance is located.

withSourceRegion

public CopyDBClusterSnapshotRequest withSourceRegion(String sourceRegion)

The region where the source instance is located.

Parameters:

sourceRegion - The region where the source instance is located.

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 CopyDBClusterSnapshotRequest 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()