Package software.amazon.awssdk.services.rds.model

Class CopyDBClusterSnapshotRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.rds.model.CopyDBClusterSnapshotRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CopyDBClusterSnapshotRequest.Builder,CopyDBClusterSnapshotRequest>

@Generated("software.amazon.awssdk:codegen")
public class CopyDBClusterSnapshotRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<CopyDBClusterSnapshotRequest.Builder,CopyDBClusterSnapshotRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CopyDBClusterSnapshotRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static CopyDBClusterSnapshotRequest.Builder	builder()
Boolean	copyTags()	True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot; otherwise false.
boolean	equals(Object obj)
int	hashCode()
String	kmsKeyId()	The AWS KMS key ID for an encrypted DB cluster snapshot.
String	preSignedUrl()	The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS region that contains the source DB cluster snapshot to copy.
static Class<? extends CopyDBClusterSnapshotRequest.Builder>	serializableBuilderClass()
String	sourceDBClusterSnapshotIdentifier()	The identifier of the DB cluster snapshot to copy.
List<Tag>	tags()
String	targetDBClusterSnapshotIdentifier()	The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot.
CopyDBClusterSnapshotRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

sourceDBClusterSnapshotIdentifier

public String sourceDBClusterSnapshotIdentifier()

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

You cannot copy an encrypted, shared DB cluster snapshot from one AWS region to another.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens.

• First character must be a letter.

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

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

• If the source snapshot is in the same region as the copy, specify a valid DB snapshot identifier.

• If the source snapshot is in a different region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying a DB Snapshot or DB Cluster Snapshot.

Example: my-cluster-snapshot1

Returns:

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

You cannot copy an encrypted, shared DB cluster snapshot from one AWS region to another.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens.

• First character must be a letter.

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

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

• If the source snapshot is in the same region as the copy, specify a valid DB snapshot identifier.

• If the source snapshot is in a different region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying a DB Snapshot or DB Cluster Snapshot.

Example: my-cluster-snapshot1

targetDBClusterSnapshotIdentifier

public 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 alphanumeric characters 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 alphanumeric characters or hyphens.

• First character must be a letter.

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

Example: my-cluster-snapshot2

kmsKeyId

public String kmsKeyId()

The AWS 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 unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target DB cluster snapshot using the specified KMS encryption key.

If you copy an encrypted DB cluster snapshot from your AWS 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 AWS account, then you must specify a value for KmsKeyId.

To copy an encrypted DB cluster snapshot to another region, you must set KmsKeyId to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination region. KMS encryption keys are specific to the region that they are created in, and you cannot use encryption keys from one region in another region.

Returns:

The AWS 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 unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target DB cluster snapshot using the specified KMS encryption key.

If you copy an encrypted DB cluster snapshot from your AWS 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 AWS account, then you must specify a value for KmsKeyId.

To copy an encrypted DB cluster snapshot to another region, you must set KmsKeyId to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination region. KMS encryption keys are specific to the region that they are created in, and you cannot use encryption keys from one region in another region.

preSignedUrl

public String preSignedUrl()

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another AWS region.

The pre-signed URL must be a valid request for the CopyDBSClusterSnapshot API action that can be executed in the source region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:

• KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination region, and the action contained in the pre-signed URL.

• DestinationRegion - The name of the region that the DB cluster snapshot will be created in.

• SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

Returns:

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another AWS region.

The pre-signed URL must be a valid request for the CopyDBSClusterSnapshot API action that can be executed in the source region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:

• KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination region, and the action contained in the pre-signed URL.

• DestinationRegion - The name of the region that the DB cluster snapshot will be created in.

• SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

copyTags

public Boolean copyTags()

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

Returns:

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

tags

public List<Tag> tags()

Returns:

toBuilder

public CopyDBClusterSnapshotRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CopyDBClusterSnapshotRequest.Builder,CopyDBClusterSnapshotRequest>

Returns:

a builder for type T

builder

public static CopyDBClusterSnapshotRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CopyDBClusterSnapshotRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object