You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::CopySnapshotRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass CopySnapshotRequest data as a hash:

{
  description: "String",
  destination_region: "String",
  encrypted: false,
  kms_key_id: "String",
  presigned_url: "String",
  source_region: "String", # required
  source_snapshot_id: "String", # required
  dry_run: false,
}

Contains the parameters for CopySnapshot.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description for the EBS snapshot.

Returns:

  • (String)


3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3921

class CopySnapshotRequest < Struct.new(
  :description,
  :destination_region,
  :encrypted,
  :kms_key_id,
  :presigned_url,
  :source_region,
  :source_snapshot_id,
  :dry_run)
  include Aws::Structure
end

#destination_regionString

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.

Returns:

  • (String)


3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3921

class CopySnapshotRequest < Struct.new(
  :description,
  :destination_region,
  :encrypted,
  :kms_key_id,
  :presigned_url,
  :source_region,
  :source_snapshot_id,
  :dry_run)
  include Aws::Structure
end

#dry_runBoolean

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.

Returns:

  • (Boolean)


3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3921

class CopySnapshotRequest < Struct.new(
  :description,
  :destination_region,
  :encrypted,
  :kms_key_id,
  :presigned_url,
  :source_region,
  :source_snapshot_id,
  :dry_run)
  include Aws::Structure
end

#encryptedBoolean

To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (Boolean)


3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3921

class CopySnapshotRequest < Struct.new(
  :description,
  :destination_region,
  :encrypted,
  :kms_key_id,
  :presigned_url,
  :source_region,
  :source_snapshot_id,
  :dry_run)
  include Aws::Structure
end

#kms_key_idString

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Returns:

  • (String)


3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3921

class CopySnapshotRequest < Struct.new(
  :description,
  :destination_region,
  :encrypted,
  :kms_key_id,
  :presigned_url,
  :source_region,
  :source_snapshot_id,
  :dry_run)
  include Aws::Structure
end

#presigned_urlString

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.

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) 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.

Returns:

  • (String)


3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3921

class CopySnapshotRequest < Struct.new(
  :description,
  :destination_region,
  :encrypted,
  :kms_key_id,
  :presigned_url,
  :source_region,
  :source_snapshot_id,
  :dry_run)
  include Aws::Structure
end

#source_regionString

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

Returns:

  • (String)


3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3921

class CopySnapshotRequest < Struct.new(
  :description,
  :destination_region,
  :encrypted,
  :kms_key_id,
  :presigned_url,
  :source_region,
  :source_snapshot_id,
  :dry_run)
  include Aws::Structure
end

#source_snapshot_idString

The ID of the EBS snapshot to copy.

Returns:

  • (String)


3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3921

class CopySnapshotRequest < Struct.new(
  :description,
  :destination_region,
  :encrypted,
  :kms_key_id,
  :presigned_url,
  :source_region,
  :source_snapshot_id,
  :dry_run)
  include Aws::Structure
end