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

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::CopySnapshotRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:presigned_url]

Instance Attribute Summary

• #completion_duration_minutes ⇒ Integer

  Specify a completion duration, in 15 minute increments, to initiate a time-based snapshot copy.

• #description ⇒ String

  A description for the EBS snapshot.

• #destination_outpost_arn ⇒ String

  The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot.

• #destination_region ⇒ String

  The destination Region to use in the ‘PresignedUrl` parameter of a snapshot copy operation.

• #dry_run ⇒ Boolean

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

• #encrypted ⇒ Boolean

  To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter.

• #kms_key_id ⇒ String

  The identifier of the KMS key to use for Amazon EBS encryption.

• #presigned_url ⇒ String

  When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL.

• #source_region ⇒ String

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

• #source_snapshot_id ⇒ String

  The ID of the EBS snapshot to copy.

• #tag_specifications ⇒ Array<Types::TagSpecification>

  The tags to apply to the new snapshot.

Instance Attribute Details

#completion_duration_minutes ⇒ Integer

Specify a completion duration, in 15 minute increments, to initiate a time-based snapshot copy. Time-based snapshot copy operations complete within the specified duration. For more information, see [ Time-based copies].

If you do not specify a value, the snapshot copy operation is completed on a best-effort basis.

[1]: docs.aws.amazon.com/ebs/latest/userguide/time-based-copies.html

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 7284

class CopySnapshotRequest < Struct.new(
  :description,
  :destination_outpost_arn,
  :destination_region,
  :encrypted,
  :kms_key_id,
  :presigned_url,
  :source_region,
  :source_snapshot_id,
  :tag_specifications,
  :completion_duration_minutes,
  :dry_run)
  SENSITIVE = [:presigned_url]
  include Aws::Structure
end

#description ⇒ String

A description for the EBS snapshot.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 7284

class CopySnapshotRequest < Struct.new(
  :description,
  :destination_outpost_arn,
  :destination_region,
  :encrypted,
  :kms_key_id,
  :presigned_url,
  :source_region,
  :source_snapshot_id,
  :tag_specifications,
  :completion_duration_minutes,
  :dry_run)
  SENSITIVE = [:presigned_url]
  include Aws::Structure
end

#destination_outpost_arn ⇒ String

The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see [ Copy snapshots from an Amazon Web Services Region to an Outpost] in the *Amazon EBS User Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#copy-snapshots

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 7284

class CopySnapshotRequest < Struct.new(
  :description,
  :destination_outpost_arn,
  :destination_region,
  :encrypted,
  :kms_key_id,
  :presigned_url,
  :source_region,
  :source_snapshot_id,
  :tag_specifications,
  :completion_duration_minutes,
  :dry_run)
  SENSITIVE = [:presigned_url]
  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.

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 CLI, this is specified using the `–region` parameter or the default Region in your Amazon Web Services configuration file.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 7284

class CopySnapshotRequest < Struct.new(
  :description,
  :destination_outpost_arn,
  :destination_region,
  :encrypted,
  :kms_key_id,
  :presigned_url,
  :source_region,
  :source_snapshot_id,
  :tag_specifications,
  :completion_duration_minutes,
  :dry_run)
  SENSITIVE = [:presigned_url]
  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)

# File 'lib/aws-sdk-ec2/types.rb', line 7284

class CopySnapshotRequest < Struct.new(
  :description,
  :destination_outpost_arn,
  :destination_region,
  :encrypted,
  :kms_key_id,
  :presigned_url,
  :source_region,
  :source_snapshot_id,
  :tag_specifications,
  :completion_duration_minutes,
  :dry_run)
  SENSITIVE = [:presigned_url]
  include Aws::Structure
end

#encrypted ⇒ Boolean

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 EBS User Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html

Returns:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 7284

class CopySnapshotRequest < Struct.new(
  :description,
  :destination_outpost_arn,
  :destination_region,
  :encrypted,
  :kms_key_id,
  :presigned_url,
  :source_region,
  :source_snapshot_id,
  :tag_specifications,
  :completion_duration_minutes,
  :dry_run)
  SENSITIVE = [:presigned_url]
  include Aws::Structure
end

#kms_key_id ⇒ String

The identifier of the KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If ‘KmsKeyId` is specified, the encrypted state must be `true`.

You can specify the KMS key using any of the following:

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

• Key alias. For example, alias/ExampleAlias.

• Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

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

Amazon Web Services authenticates the KMS key 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)

# File 'lib/aws-sdk-ec2/types.rb', line 7284

class CopySnapshotRequest < Struct.new(
  :description,
  :destination_outpost_arn,
  :destination_region,
  :encrypted,
  :kms_key_id,
  :presigned_url,
  :source_region,
  :source_snapshot_id,
  :tag_specifications,
  :completion_duration_minutes,
  :dry_run)
  SENSITIVE = [:presigned_url]
  include Aws::Structure
end

#presigned_url ⇒ 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].

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 Amazon Web Services 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: Using Query Parameters (Amazon Web Services Signature Version 4)] in the *Amazon S3 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/AWSEC2/latest/APIReference/Query-Requests.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 7284

class CopySnapshotRequest < Struct.new(
  :description,
  :destination_outpost_arn,
  :destination_region,
  :encrypted,
  :kms_key_id,
  :presigned_url,
  :source_region,
  :source_snapshot_id,
  :tag_specifications,
  :completion_duration_minutes,
  :dry_run)
  SENSITIVE = [:presigned_url]
  include Aws::Structure
end

#source_region ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 7284

class CopySnapshotRequest < Struct.new(
  :description,
  :destination_outpost_arn,
  :destination_region,
  :encrypted,
  :kms_key_id,
  :presigned_url,
  :source_region,
  :source_snapshot_id,
  :tag_specifications,
  :completion_duration_minutes,
  :dry_run)
  SENSITIVE = [:presigned_url]
  include Aws::Structure
end

#source_snapshot_id ⇒ String

The ID of the EBS snapshot to copy.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 7284

class CopySnapshotRequest < Struct.new(
  :description,
  :destination_outpost_arn,
  :destination_region,
  :encrypted,
  :kms_key_id,
  :presigned_url,
  :source_region,
  :source_snapshot_id,
  :tag_specifications,
  :completion_duration_minutes,
  :dry_run)
  SENSITIVE = [:presigned_url]
  include Aws::Structure
end

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the new snapshot.

Returns:

• (Array<Types::TagSpecification>)

# File 'lib/aws-sdk-ec2/types.rb', line 7284

class CopySnapshotRequest < Struct.new(
  :description,
  :destination_outpost_arn,
  :destination_region,
  :encrypted,
  :kms_key_id,
  :presigned_url,
  :source_region,
  :source_snapshot_id,
  :tag_specifications,
  :completion_duration_minutes,
  :dry_run)
  SENSITIVE = [:presigned_url]
  include Aws::Structure
end