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)


2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2585

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)


2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2585

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)


2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2585

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

Specifies whether the destination snapshot should be encrypted. You can encrypt a copy of an unencrypted snapshot using this flag, but you cannot use it to create an unencrypted copy from an encrypted snapshot. Your default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (Boolean)


2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2585

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

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.

Returns:

  • (String)


2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2585

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)


2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2585

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)


2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2585

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)


2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2585

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