software.amazon.awssdk.services.neptune.model

Class CopyDbClusterSnapshotRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.neptune.model.NeptuneRequest

software.amazon.awssdk.services.neptune.model.CopyDbClusterSnapshotRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CopyDbClusterSnapshotRequest.Builder,CopyDbClusterSnapshotRequest>

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

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() True to copy all tags from the source DB cluster snapshot to the target DB 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 Amazon Amazon KMS key ID for an encrypted DB cluster snapshot.
String	preSignedUrl() Not currently supported.
List<SdkField<?>>	sdkFields()
static Class<? extends CopyDbClusterSnapshotRequest.Builder>	serializableBuilderClass()
String	sourceDBClusterSnapshotIdentifier() The identifier of the DB 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 assign to the new DB cluster snapshot copy.
String	targetDBClusterSnapshotIdentifier() The identifier of the new DB cluster snapshot to create from the source DB 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 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

targetDBClusterSnapshotIdentifier

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

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

kmsKeyId

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

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.

preSignedUrl

public final String preSignedUrl()

Not currently supported.

Returns:

Not currently supported.

copyTags

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

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.

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 assign to the new DB cluster snapshot copy.

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 assign to the new DB cluster snapshot copy.

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 NeptuneRequest

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