software.amazon.awssdk.services.docdb.model

Class CopyDbClusterSnapshotRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.docdb.model.DocDbRequest

software.amazon.awssdk.services.docdb.model.CopyDbClusterSnapshotRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CopyDbClusterSnapshotRequest.Builder,CopyDbClusterSnapshotRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CopyDbClusterSnapshotRequest
extends DocDbRequest
implements ToCopyableBuilder<CopyDbClusterSnapshotRequest.Builder,CopyDbClusterSnapshotRequest>

Represents the input to CopyDBClusterSnapshot.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CopyDbClusterSnapshotRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CopyDbClusterSnapshotRequest.Builder	builder()
Boolean	copyTags() Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	kmsKeyId() The KMS key ID for an encrypted cluster snapshot.
String	preSignedUrl() The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Region that contains the source cluster snapshot to copy.
List<SdkField<?>>	sdkFields()
static Class<? extends CopyDbClusterSnapshotRequest.Builder>	serializableBuilderClass()
String	sourceDBClusterSnapshotIdentifier() The identifier of the cluster snapshot to copy.
String	sourceRegion() If PreSignedUrl is not specified, this is the region where the source snapshot is located.
List<Tag>	tags() The tags to be assigned to the cluster snapshot.
String	targetDBClusterSnapshotIdentifier() The identifier of the new cluster snapshot to create from the source cluster snapshot.
CopyDbClusterSnapshotRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

sourceDBClusterSnapshotIdentifier

public final String sourceDBClusterSnapshotIdentifier()

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

Constraints:

• 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 snapshot identifier.

• If the source snapshot is in a different Region than the copy, specify a valid cluster snapshot ARN.

Example: my-cluster-snapshot1

Returns:

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

Constraints:

• 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 snapshot identifier.

• If the source snapshot is in a different Region than the copy, specify a valid cluster snapshot ARN.

Example: my-cluster-snapshot1

targetDBClusterSnapshotIdentifier

public final String targetDBClusterSnapshotIdentifier()

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

Constraints:

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

• The 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 cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

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

• The first character must be a letter.

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

Example: my-cluster-snapshot2

kmsKeyId

public final String kmsKeyId()

The KMS key ID for an encrypted 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 cluster snapshot from your 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 cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.

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

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

If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

Returns:

The KMS key ID for an encrypted 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 cluster snapshot from your 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 cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.

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

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

If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

preSignedUrl

public final String preSignedUrl()

The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Region.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

• SourceRegion - The ID of the region that contains the snapshot to be copied.

• SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted 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 cluster snapshot from the us-east-1 Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.

• TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.

Returns:

The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Region.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

• SourceRegion - The ID of the region that contains the snapshot to be copied.

• SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted 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 cluster snapshot from the us-east-1 Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.

• TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.

copyTags

public final Boolean copyTags()

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

Returns:

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

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

The tags to be assigned to the cluster snapshot.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

The tags to be assigned to the cluster snapshot.

sourceRegion

public final String sourceRegion()

If PreSignedUrl is not specified, this is the region where the source snapshot is located. A PreSignedUrl will be generated automatically by the SDK.

Returns:

If PreSignedUrl is not specified, this is the region where the source snapshot is located. A PreSignedUrl will be generated automatically by the SDK.

toBuilder

public CopyDbClusterSnapshotRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CopyDbClusterSnapshotRequest.Builder,CopyDbClusterSnapshotRequest>

Specified by:

toBuilder in class DocDbRequest

builder

public static CopyDbClusterSnapshotRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo