Package software.amazon.awssdk.services.docdbelastic.model

Class CopyClusterSnapshotRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.docdbelastic.model.DocDbElasticRequest

software.amazon.awssdk.services.docdbelastic.model.CopyClusterSnapshotRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CopyClusterSnapshotRequest.Builder,CopyClusterSnapshotRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CopyClusterSnapshotRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CopyClusterSnapshotRequest.Builder	builder()
Boolean	copyTags()	Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot.
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 Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot.
List<SdkField<?>>	sdkFields()
static Class<? extends CopyClusterSnapshotRequest.Builder>	serializableBuilderClass()
String	snapshotArn()	The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.
Map<String,String>	tags()	The tags to be assigned to the elastic cluster snapshot.
String	targetSnapshotName()	The identifier of the new elastic cluster snapshot to create from the source cluster snapshot.
CopyClusterSnapshotRequest.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

copyTags

public final Boolean copyTags()

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

Returns:

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

kmsKeyId

public final String kmsKeyId()

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

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

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

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

Returns:

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

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

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

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

snapshotArn

public final String snapshotArn()

The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.

Returns:

The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.

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 Map<String,String> tags()

The tags to be assigned to the elastic 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 elastic cluster snapshot.

targetSnapshotName

public final String targetSnapshotName()

The identifier of the new elastic 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: elastic-cluster-snapshot-5

Returns:

The identifier of the new elastic 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: elastic-cluster-snapshot-5

toBuilder

public CopyClusterSnapshotRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CopyClusterSnapshotRequest.Builder,CopyClusterSnapshotRequest>

Specified by:

toBuilder in class DocDbElasticRequest

builder

public static CopyClusterSnapshotRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CopyClusterSnapshotRequest.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