Class CopyDbClusterSnapshotRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CopyDbClusterSnapshotRequest.Builder,
CopyDbClusterSnapshotRequest>
Represents the input to CopyDBClusterSnapshot.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Boolean
copyTags()
Set totrue
to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwisefalse
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
kmsKeyId()
The KMS key ID for an encrypted cluster snapshot.final String
The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot
API action in the Amazon Web Services Region that contains the source cluster snapshot to copy.static Class
<? extends CopyDbClusterSnapshotRequest.Builder> final String
The identifier of the cluster snapshot to copy.final String
If PreSignedUrl is not specified, this is the region where the source snapshot is located.tags()
The tags to be assigned to the cluster snapshot.final String
The identifier of the new cluster snapshot to create from the source cluster snapshot.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 Amazon Web Services Region as the copy, specify a valid snapshot identifier.
-
If the source snapshot is in a different Amazon Web Services 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 Amazon Web Services Region as the copy, specify a valid snapshot identifier.
-
If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid cluster snapshot ARN.
Example:
my-cluster-snapshot1
-
-
-
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
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 Amazon Web Services 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 forKmsKeyId
, 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 Amazon Web Services account, then you must specify a value for
KmsKeyId
.To copy an encrypted cluster snapshot to another Amazon Web Services 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 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 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 Amazon Web Services 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 forKmsKeyId
, 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 Amazon Web Services account, then you must specify a value for
KmsKeyId
.To copy an encrypted cluster snapshot to another Amazon Web Services 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 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 cluster snapshot and specify a value for the
KmsKeyId
parameter, an error is returned.
-
preSignedUrl
The URL that contains a Signature Version 4 signed request for the
CopyDBClusterSnapshot
API action in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use thePreSignedUrl
parameter when copying a cluster snapshot from another Amazon Web Services 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 specifyingPreSignedUrl
manually. SpecifyingSourceRegion
autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.The presigned URL must be a valid request for the
CopyDBClusterSnapshot
API action that can be executed in the source Amazon Web Services 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 Amazon Web Services Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Amazon Web Services Region, then yourSourceDBClusterSnapshotIdentifier
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 the
CopyDBClusterSnapshot
API action in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use thePreSignedUrl
parameter when copying a cluster snapshot from another Amazon Web Services 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 specifyingPreSignedUrl
manually. SpecifyingSourceRegion
autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.The presigned URL must be a valid request for the
CopyDBClusterSnapshot
API action that can be executed in the source Amazon Web Services 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 Amazon Web Services Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Amazon Web Services Region, then yourSourceDBClusterSnapshotIdentifier
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
Set to
true
to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwisefalse
. The default isfalse
.- Returns:
- Set to
true
to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwisefalse
. The default isfalse
.
-
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 theisEmpty()
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
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
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
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 interfaceToCopyableBuilder<CopyDbClusterSnapshotRequest.Builder,
CopyDbClusterSnapshotRequest> - Specified by:
toBuilder
in classDocDbRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-