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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CopySnapshotRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  description: "String",
  encrypted: false,
  kms_key_id: "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)

    A description for the EBS snapshot.

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

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

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

    Specifies whether the destination snapshot should be encrypted.

#kms_key_idString

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)

    The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy.

#source_regionString

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

Returns:

  • (String)

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

#source_snapshot_idString

The ID of the EBS snapshot to copy.

Returns:

  • (String)

    The ID of the EBS snapshot to copy.