Class CopyClusterSnapshotRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CopyClusterSnapshotRequest.Builder,
CopyClusterSnapshotRequest>
-
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 elastic cluster snapshot.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 Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot.static Class
<? extends CopyClusterSnapshotRequest.Builder> final String
The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.tags()
The tags to be assigned to the elastic cluster snapshot.final String
The identifier of the new elastic 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
-
copyTags
Set to
true
to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default isfalse
.- Returns:
- Set to
true
to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default isfalse
.
-
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 forKmsKeyId
, then the copy of the elastic cluster snapshot is encrypted with the sameAWS
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 forKmsKeyId
, then the copy of the elastic cluster snapshot is encrypted with the sameAWS
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
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 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 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
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
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<CopyClusterSnapshotRequest.Builder,
CopyClusterSnapshotRequest> - Specified by:
toBuilder
in classDocDbElasticRequest
- 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
-