@Generated(value="software.amazon.awssdk:codegen") public class CopyDBSnapshotRequest extends RDSRequest implements ToCopyableBuilder<CopyDBSnapshotRequest.Builder,CopyDBSnapshotRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CopyDBSnapshotRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static CopyDBSnapshotRequest.Builder |
builder() |
Boolean |
copyTags()
True to copy all tags from the source DB snapshot to the target DB snapshot, and otherwise false.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
kmsKeyId()
The AWS KMS key ID for an encrypted DB snapshot.
|
String |
optionGroupName()
The name of an option group to associate with the copy of the snapshot.
|
String |
preSignedUrl()
The URL that contains a Signature Version 4 signed request for the
CopyDBSnapshot API action in the
source AWS Region that contains the source DB snapshot to copy. |
static Class<? extends CopyDBSnapshotRequest.Builder> |
serializableBuilderClass() |
String |
sourceDBSnapshotIdentifier()
The identifier for the source DB snapshot.
|
String |
sourceRegion()
The region where the source snapshot is located.
|
List<Tag> |
tags()
Returns the value of the Tags property for this object.
|
String |
targetDBSnapshotIdentifier()
The identifier for the copy of the snapshot.
|
CopyDBSnapshotRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfig
copy
public String sourceDBSnapshotIdentifier()
The identifier for the source DB snapshot.
If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For
example, you might specify rds:mysql-instance1-snapshot-20130805
.
If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example,
you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
.
If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.
If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and
must match the SourceDBSnapshotIdentifier
in the PreSignedUrl
parameter.
Constraints:
Must specify a valid system snapshot in the "available" state.
Example: rds:mydb-2012-04-02-00-01
Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For
example, you might specify rds:mysql-instance1-snapshot-20130805
.
If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For
example, you might specify
arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
.
If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.
If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS
Region, and must match the SourceDBSnapshotIdentifier
in the PreSignedUrl
parameter.
Constraints:
Must specify a valid system snapshot in the "available" state.
Example: rds:mydb-2012-04-02-00-01
Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
public String targetDBSnapshotIdentifier()
The identifier for the copy of the snapshot.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-db-snapshot
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-db-snapshot
public String kmsKeyId()
The AWS KMS key ID for an encrypted DB 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 snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.
If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter.
If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.
If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.
If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.
If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter.
If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.
If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.
public List<Tag> tags()
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Boolean copyTags()
True to copy all tags from the source DB snapshot to the target DB snapshot, and otherwise false. The default is false.
public String preSignedUrl()
The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot
API action in the
source AWS Region that contains the source DB snapshot to copy.
You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the
Amazon RDS API. You can specify the --source-region
option instead of this parameter when you copy
an encrypted DB snapshot from another AWS Region by using the AWS CLI.
The presigned URL must be a valid request for the CopyDBSnapshot
API action that can be executed in
the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must
contain the following parameter values:
DestinationRegion
- The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is
the same one where the CopyDBSnapshot
action is called that contains this presigned URL.
For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then
you call the CopyDBSnapshot
action in the us-east-1 AWS Region and provide a presigned URL that
contains a call to the CopyDBSnapshot
action in the us-west-2 AWS Region. For this example, the
DestinationRegion
in the presigned URL must be set to the us-east-1 AWS Region.
KmsKeyId
- The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in
the destination AWS Region. This is the same identifier for both the CopyDBSnapshot
action that is
called in the destination AWS Region, and the action contained in the presigned URL.
SourceDBSnapshotIdentifier
- The DB snapshot identifier for the encrypted snapshot to be copied.
This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you
are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your
SourceDBSnapshotIdentifier
looks like the following example:
arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
CopyDBSnapshot
API action
in the source AWS Region that contains the source DB snapshot to copy.
You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using
the Amazon RDS API. You can specify the --source-region
option instead of this parameter
when you copy an encrypted DB snapshot from another AWS Region by using the AWS CLI.
The presigned URL must be a valid request for the CopyDBSnapshot
API action that can be
executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL
request must contain the following parameter values:
DestinationRegion
- The AWS Region that the encrypted DB snapshot is copied to. This AWS
Region is the same one where the CopyDBSnapshot
action is called that contains this
presigned URL.
For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS
Region, then you call the CopyDBSnapshot
action in the us-east-1 AWS Region and provide a
presigned URL that contains a call to the CopyDBSnapshot
action in the us-west-2 AWS Region.
For this example, the DestinationRegion
in the presigned URL must be set to the us-east-1
AWS Region.
KmsKeyId
- The AWS KMS key identifier for the key to use to encrypt the copy of the DB
snapshot in the destination AWS Region. This is the same identifier for both the
CopyDBSnapshot
action that is called in the destination AWS Region, and the action contained
in the presigned URL.
SourceDBSnapshotIdentifier
- The DB snapshot identifier for the encrypted snapshot to be
copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For
example, if you are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your
SourceDBSnapshotIdentifier
looks like the following example:
arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
public String optionGroupName()
The name of an option group to associate with the copy of the snapshot.
Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations.
Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations.
public String sourceRegion()
public CopyDBSnapshotRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CopyDBSnapshotRequest.Builder,CopyDBSnapshotRequest>
toBuilder
in class RDSRequest
public static CopyDBSnapshotRequest.Builder builder()
public static Class<? extends CopyDBSnapshotRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. 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, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.