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.

CopySnapshotInput

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

type CopySnapshotInput struct { Description *string `type:"string"` DestinationRegion *string `locationName:"destinationRegion" type:"string"` DryRun *bool `locationName:"dryRun" type:"boolean"` Encrypted *bool `locationName:"encrypted" type:"boolean"` KmsKeyId *string `locationName:"kmsKeyId" type:"string"` PresignedUrl *string `locationName:"presignedUrl" type:"string"` SourceRegion *string `type:"string" required:"true"` SourceSnapshotId *string `type:"string" required:"true"` }

Contains the parameters for CopySnapshot.

Description

Type: *string

A description for the EBS snapshot.

DestinationRegion

Type: *string

The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.

The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the AWS CLI, this is specified using the --region parameter or the default Region in your AWS configuration file.

DryRun

Type: *bool

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Encrypted

Type: *bool

Specifies whether the destination snapshot should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot use it to create an unencrypted copy of an encrypted snapshot. Your default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the Amazon Elastic Compute Cloud User Guide.

KmsKeyId

Type: *string

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The CMK identifier may be provided in any of the following formats:

  • Key ID

  • Key alias

  • ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. The action will eventually fail.

PresignedUrl

Type: *string

When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query Requests (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html).

The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

SourceRegion

Type: *string

The ID of the Region that contains the snapshot to be copied.

SourceRegion is a required field

SourceSnapshotId

Type: *string

The ID of the EBS snapshot to copy.

SourceSnapshotId is a required field

Method

GoString

func (s CopySnapshotInput) GoString() string

GoString returns the string representation

SetDescription

func (s *CopySnapshotInput) SetDescription(v string) *CopySnapshotInput

SetDescription sets the Description field's value.

SetDestinationRegion

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

SetDestinationRegion sets the DestinationRegion field's value.

SetDryRun

func (s *CopySnapshotInput) SetDryRun(v bool) *CopySnapshotInput

SetDryRun sets the DryRun field's value.

SetEncrypted

func (s *CopySnapshotInput) SetEncrypted(v bool) *CopySnapshotInput

SetEncrypted sets the Encrypted field's value.

SetKmsKeyId

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

SetKmsKeyId sets the KmsKeyId field's value.

SetPresignedUrl

func (s *CopySnapshotInput) SetPresignedUrl(v string) *CopySnapshotInput

SetPresignedUrl sets the PresignedUrl field's value.

SetSourceRegion

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

SetSourceRegion sets the SourceRegion field's value.

SetSourceSnapshotId

func (s *CopySnapshotInput) SetSourceSnapshotId(v string) *CopySnapshotInput

SetSourceSnapshotId sets the SourceSnapshotId field's value.

String

func (s CopySnapshotInput) String() string

String returns the string representation

Validate

func (s *CopySnapshotInput) Validate() error

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

On this page: