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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A description for the EBS snapshot.

Returns:

  • (String) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
 
# File 'lib/aws-sdk-ec2/types.rb', line 2317

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_region ⇒ 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.

<note markdown=“1”> ‘CopySnapshot` sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as `ec2.us-east-1.amazonaws.com` (in the AWS CLI, this is specified with the `–region` parameter or the default region in your AWS configuration file).

</note>

Returns:

  • (String) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
 
# File 'lib/aws-sdk-ec2/types.rb', line 2317

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_run ⇒ Boolean

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) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
 
# File 'lib/aws-sdk-ec2/types.rb', line 2317

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

#encrypted ⇒ Boolean

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html

Returns:

  • (Boolean) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
 
# File 'lib/aws-sdk-ec2/types.rb', line 2317

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_id ⇒ String

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. 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. The 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. The specified CMK must exist in the region that the snapshot is being copied to. If a `KmsKeyId` is specified, the `Encrypted` flag must also be set.

Returns:

  • (String) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
 
# File 'lib/aws-sdk-ec2/types.rb', line 2317

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_url ⇒ String

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. 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.

[1]: docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html

Returns:

  • (String) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
 
# File 'lib/aws-sdk-ec2/types.rb', line 2317

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_region ⇒ String

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

Returns:

  • (String) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
 
# File 'lib/aws-sdk-ec2/types.rb', line 2317

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_id ⇒ String

The ID of the EBS snapshot to copy.

Returns:

  • (String) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
 
# File 'lib/aws-sdk-ec2/types.rb', line 2317

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