AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

CopyDBSnapshotInput

import "github.com/aws/aws-sdk-go/service/rds"

type CopyDBSnapshotInput struct { CopyTags *bool `type:"boolean"` DestinationRegion *string `type:"string"` KmsKeyId *string `type:"string"` OptionGroupName *string `type:"string"` PreSignedUrl *string `type:"string"` SourceDBSnapshotIdentifier *string `type:"string" required:"true"` SourceRegion *string `type:"string" ignore:"true"` Tags []*Tag `locationNameList:"Tag" type:"list"` TargetDBSnapshotIdentifier *string `type:"string" required:"true"` }

CopyTags

Type: *bool

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

DestinationRegion

Type: *string

DestinationRegion is used for presigning the request to a given region.

KmsKeyId

Type: *string

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.

OptionGroupName

Type: *string

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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options) in the Amazon RDS User Guide.

PreSignedUrl

Type: *string

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) (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) and Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

SourceDBSnapshotIdentifier

Type: *string

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

SourceDBSnapshotIdentifier is a required field

SourceRegion

Type: *string

SourceRegion is the source region where the resource exists. This is not sent over the wire and is only used for presigning. This value should always have the same region as the source ARN.

Tags

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

TargetDBSnapshotIdentifier

Type: *string

The identifier for the copy of the snapshot.

Constraints:

  • Can't be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

  • Can't end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

TargetDBSnapshotIdentifier is a required field

Method

GoString

func (s CopyDBSnapshotInput) GoString() string

GoString returns the string representation

SetCopyTags

func (s *CopyDBSnapshotInput) SetCopyTags(v bool) *CopyDBSnapshotInput

SetCopyTags sets the CopyTags field's value.

SetDestinationRegion

func (s *CopyDBSnapshotInput) SetDestinationRegion(v string) *CopyDBSnapshotInput

SetDestinationRegion sets the DestinationRegion field's value.

SetKmsKeyId

func (s *CopyDBSnapshotInput) SetKmsKeyId(v string) *CopyDBSnapshotInput

SetKmsKeyId sets the KmsKeyId field's value.

SetOptionGroupName

func (s *CopyDBSnapshotInput) SetOptionGroupName(v string) *CopyDBSnapshotInput

SetOptionGroupName sets the OptionGroupName field's value.

SetPreSignedUrl

func (s *CopyDBSnapshotInput) SetPreSignedUrl(v string) *CopyDBSnapshotInput

SetPreSignedUrl sets the PreSignedUrl field's value.

SetSourceDBSnapshotIdentifier

func (s *CopyDBSnapshotInput) SetSourceDBSnapshotIdentifier(v string) *CopyDBSnapshotInput

SetSourceDBSnapshotIdentifier sets the SourceDBSnapshotIdentifier field's value.

SetSourceRegion

func (s *CopyDBSnapshotInput) SetSourceRegion(v string) *CopyDBSnapshotInput

SetSourceRegion sets the SourceRegion field's value.

SetTags

func (s *CopyDBSnapshotInput) SetTags(v []*Tag) *CopyDBSnapshotInput

SetTags sets the Tags field's value.

SetTargetDBSnapshotIdentifier

func (s *CopyDBSnapshotInput) SetTargetDBSnapshotIdentifier(v string) *CopyDBSnapshotInput

SetTargetDBSnapshotIdentifier sets the TargetDBSnapshotIdentifier field's value.

String

func (s CopyDBSnapshotInput) String() string

String returns the string representation

Validate

func (s *CopyDBSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: