class Aws::RDS::Types::CopyDBSnapshotMessage

@see docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CopyDBSnapshotMessage AWS API Documentation
@return [String]
shapshot is encrypted and in a different region.
The source region of the snapshot. This is only needed when the
@!attribute [rw] source_region
@return [Boolean]
can be copied only with cross-account snapshot copy calls.
associate with the target DB snapshot. The associated option group
source DB snapshot to the target Amazon Web Services account and
Specifies whether to copy the DB option group associated with the
@!attribute [rw] copy_option_group
@return [String]
Example: ‘rds-caz-aiqhTgQv`.
target CAZ.
The external custom Availability Zone (CAZ) identifier for the
@!attribute [rw] target_custom_availability_zone
@return [String] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options *Amazon RDS User Guide*.
more information, see [Option group considerations] in the
this option when copying across Amazon Web Services Regions. For
Data Encryption for Oracle or Microsoft SQL Server, you must specify
nondefault option group. If your source DB instance uses Transparent
Web Services Region to another, and your DB instance uses a
Specify this option if you are copying a snapshot from one Amazon
snapshot.
The name of an option group to associate with the copy of the
@!attribute [rw] option_group_name
@return [String] : docs.aws.amazon.com/general/latest/gr/signature-version-4.html [1]: docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html </note>
operation that can run in the source Amazon Web Services Region.
autogenerates a presigned URL that is a valid request for the
specifying `PreSignedUrl` manually. Specifying `SourceRegion`
specify `SourceRegion` (or `–source-region` for the CLI) instead of
<note markdown=“1”> If you are using an Amazon Web Services SDK tool or the CLI, you can Process].
Services Signature Version 4)] and [Signature Version 4 Signing
[Authenticating Requests: Using Query Parameters (Amazon Web
To learn how to generate a Signature Version 4 signed request, see
`arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115`.
`SourceDBSnapshotIdentifier` looks like the following example:
snapshot from the us-west-2 Amazon Web Services Region, then your
Services Region. For example, if you are copying an encrypted DB
Amazon Resource Name (ARN) format for the source Amazon Web
encrypted snapshot to be copied. This identifier must be in the
* `SourceDBSnapshotIdentifier` - The DB snapshot identifier for the
presigned URL.
Amazon Web Services Region, and the operation contained in the
`CopyDBSnapshot` operation that is called in the destination
Services Region. This is the same identifier for both the
encrypt the copy of the DB snapshot in the destination Amazon Web
* `KmsKeyId` - The KMS key identifier for the KMS key to use to
us-east-1 Amazon Web Services Region.
`DestinationRegion` in the presigned URL must be set to the
us-west-2 Amazon Web Services Region. For this example, the
URL that contains a call to the `CopyDBSnapshot` operation in the
the us-east-1 Amazon Web Services Region and provide a presigned
Services Region, then you call the `CopyDBSnapshot` operation in
us-west-2 Amazon Web Services Region to the us-east-1 Amazon Web
For example, if you copy an encrypted DB snapshot from the
called that contains this presigned URL.
Region is the same one where the `CopyDBSnapshot` operation is
encrypted DB snapshot is copied to. This Amazon Web Services
* `DestinationRegion` - The Amazon Web Services Region that the
following parameter values:
snapshot to copy. The presigned URL request must contain the
Amazon Web Services Region that contains the encrypted DB cluster
`CopyDBClusterSnapshot` API operation that can run in the source
The presigned URL must be a valid request for the
encrypted DB snapshot in the same Amazon Web Services Region.
RDS API. Don’t specify ‘PreSignedUrl` when you are copying an
snapshot from another Amazon Web Services Region by using the Amazon
You must specify this parameter when you copy an encrypted DB
Regions. It’s ignored in other Amazon Web Services Regions.
This setting applies only to Amazon Web Services GovCloud (US)
snapshot to copy.
the source Amazon Web Services Region that contains the source DB
Version 4 signed request for the ‘CopyDBSnapshot` API operation in
GovCloud (US) Region to another, the URL that contains a Signature
When you are copying a snapshot from one Amazon Web Services
@!attribute [rw] pre_signed_url
@return [Boolean]
the target DB snapshot. By default, tags aren’t copied.
Specifies whether to copy all tags from the source DB snapshot to
@!attribute [rw] copy_tags
@return [Array<Types::Tag>] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Resources][1] in the *Amazon RDS User Guide.*
A list of tags. For more information, see [Tagging Amazon RDS
@!attribute [rw] tags
@return [String]
in another Amazon Web Services Region.
in, and you can’t use KMS keys from one Amazon Web Services Region
are specific to the Amazon Web Services Region that they are created
identifier for the destination Amazon Web Services Region. KMS keys
Region, then you must specify an Amazon Web Services KMS key
If you copy an encrypted snapshot to a different Amazon Web Services
the copy is encrypted.
If you specify this parameter when you copy an unencrypted snapshot,
parameter.
Amazon Web Services account, then you must specify a value for this
If you copy an encrypted DB snapshot that is shared from another
same Amazon Web Services KMS key as the source DB snapshot.
parameter, then the copy of the DB snapshot is encrypted with the
copy with a new KMS key. If you don’t specify a value for this
account, you can specify a value for this parameter to encrypt the
If you copy an encrypted DB snapshot from your Amazon Web Services
key ID, alias ARN, or alias name for the KMS key.
snapshot. The Amazon Web Services KMS key identifier is the key ARN,
The Amazon Web Services KMS key identifier for an encrypted DB
@!attribute [rw] kms_key_id
@return [String]
Example: ‘my-db-snapshot`
* Can’t end with a hyphen or contain two consecutive hyphens
* First character must be a letter
* Must contain from 1 to 255 letters, numbers, or hyphens
* Can’t be null, empty, or blank
Constraints:
The identifier for the copy of the snapshot.
@!attribute [rw] target_db_snapshot_identifier
@return [String]
‘arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805`
Example:
Example: `rds:mydb-2012-04-02-00-01`
^
* Must specify a valid system snapshot in the “available” state.
Constraints:
the ARN format for the source Amazon Web Services Region.
If you are copying an encrypted snapshot this parameter must be in
must be the Amazon Resource Name (ARN) of the shared DB snapshot.
If you are copying from a shared manual DB snapshot, this parameter
`arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805`.
might specify
than the copy, specify a valid DB snapshot ARN. For example, you
If the source snapshot is in a different Amazon Web Services Region
might specify `rds:mysql-instance1-snapshot-20130805`.
the copy, specify a valid DB snapshot identifier. For example, you
If the source snapshot is in the same Amazon Web Services Region as
The identifier for the source DB snapshot.
@!attribute [rw] source_db_snapshot_identifier

class Aws::RDS::Types::CopyDBSnapshotMessage

Namespace

Included Modules

Defined in