Package software.amazon.awssdk.services.rds.model

Interface CopyDBSnapshotRequest.Builder

All Superinterfaces:

CopyableBuilder<CopyDBSnapshotRequest.Builder,CopyDBSnapshotRequest>, SdkBuilder<CopyDBSnapshotRequest.Builder,CopyDBSnapshotRequest>

Enclosing class:

CopyDBSnapshotRequest

public static interface CopyDBSnapshotRequest.Builder
extends CopyableBuilder<CopyDBSnapshotRequest.Builder,CopyDBSnapshotRequest>

Method Summary

Modifier and Type	Method	Description
CopyDBSnapshotRequest.Builder	copyTags(Boolean copyTags)	True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false.
CopyDBSnapshotRequest.Builder	kmsKeyId(String kmsKeyId)	The AWS KMS key ID for an encrypted DB snapshot.
CopyDBSnapshotRequest.Builder	optionGroupName(String optionGroupName)	The name of an option group to associate with the copy.
CopyDBSnapshotRequest.Builder	preSignedUrl(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.
CopyDBSnapshotRequest.Builder	sourceDBSnapshotIdentifier(String sourceDBSnapshotIdentifier)	The identifier for the source DB snapshot.
CopyDBSnapshotRequest.Builder	sourceRegion(String sourceRegion)	The region where the source snapshot is located.
CopyDBSnapshotRequest.Builder	tags(Collection<Tag> tags)
CopyDBSnapshotRequest.Builder	tags(Tag... tags)	NOTE: This method appends the values to the existing list (if any).
CopyDBSnapshotRequest.Builder	targetDBSnapshotIdentifier(String targetDBSnapshotIdentifier)	The identifier for the copy of the snapshot.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

sourceDBSnapshotIdentifier

CopyDBSnapshotRequest.Builder sourceDBSnapshotIdentifier(String sourceDBSnapshotIdentifier)

The identifier for the source DB snapshot.

If the source snapshot is in the same region as the copy, specify a valid DB snapshot identifier. For example, rds:mysql-instance1-snapshot-20130805.

If the source snapshot is in a different region than the copy, specify a valid DB snapshot ARN. For example, 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 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

Parameters:

sourceDBSnapshotIdentifier - The identifier for the source DB snapshot.

If the source snapshot is in the same region as the copy, specify a valid DB snapshot identifier. For example, rds:mysql-instance1-snapshot-20130805.

If the source snapshot is in a different region than the copy, specify a valid DB snapshot ARN. For example, 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 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

Returns:

Returns a reference to this object so that method calls can be chained together.

targetDBSnapshotIdentifier

CopyDBSnapshotRequest.Builder targetDBSnapshotIdentifier(String targetDBSnapshotIdentifier)

The identifier for the copy of the snapshot.

Constraints:

• Cannot be null, empty, or blank

• Must contain from 1 to 255 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

Parameters:

targetDBSnapshotIdentifier - The identifier for the copy of the snapshot.

Constraints:

• Cannot be null, empty, or blank

• Must contain from 1 to 255 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKeyId

CopyDBSnapshotRequest.Builder kmsKeyId(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 region that they are created in, and you cannot use encryption keys from one region in another region.

Parameters:

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 region that they are created in, and you cannot use encryption keys from one region in another region.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CopyDBSnapshotRequest.Builder tags(Collection<Tag> tags)

Parameters:

tags -

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CopyDBSnapshotRequest.Builder tags(Tag... tags)

NOTE: This method appends the values to the existing list (if any). Use #setTags(java.util.Collection) or #withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags -

Returns:

Returns a reference to this object so that method calls can be chained together.

copyTags

CopyDBSnapshotRequest.Builder copyTags(Boolean copyTags)

True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false.

Parameters:

copyTags - True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false.

Returns:

Returns a reference to this object so that method calls can be chained together.

preSignedUrl

CopyDBSnapshotRequest.Builder preSignedUrl(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 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 will be copied to. This 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 region to the us-east-1 region, then you will call the CopyDBSnapshot action in the us-east-1 region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 region.

• KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination 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 region. For example, if you are copying an encrypted DB snapshot from the us-west-2 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.

Parameters:

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 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 will be copied to. This 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 region to the us-east-1 region, then you will call the CopyDBSnapshot action in the us-east-1 region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 region.

• KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination 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 region. For example, if you are copying an encrypted DB snapshot from the us-west-2 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

optionGroupName

CopyDBSnapshotRequest.Builder optionGroupName(String optionGroupName)

The name of an option group to associate with the copy.

Specify this option if you are copying a snapshot from one AWS region to another, and your DB instance uses a non-default 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 regions. For more information, see Option Group Considerations.

Parameters:

optionGroupName - The name of an option group to associate with the copy.

Specify this option if you are copying a snapshot from one AWS region to another, and your DB instance uses a non-default 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 regions. For more information, see Option Group Considerations.

Returns:

Returns a reference to this object so that method calls can be chained together.

sourceRegion

CopyDBSnapshotRequest.Builder sourceRegion(String sourceRegion)

The region where the source snapshot is located.

Parameters:

sourceRegion - The region where the source snapshot is located.

Returns:

Returns a reference to this object so that method calls can be chained together.