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

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

Overview

Constant Summary collapse

SENSITIVE =
[:presigned_url]

Instance Attribute Summary collapse

Instance Attribute Details

#completion_duration_minutes ⇒ Integer

Not supported when copying snapshots to or from Local Zones or Outposts.

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.

Returns:

  • (Integer)


9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9940

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,
  :destination_availability_zone,
  :dry_run)
  SENSITIVE = [:presigned_url]
  include Aws::Structure
end

#description ⇒ String

A description for the EBS snapshot.

Returns:

  • (String)


9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9940

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,
  :destination_availability_zone,
  :dry_run)
  SENSITIVE = [:presigned_url]
  include Aws::Structure
end

#destination_availability_zone ⇒ String

The Local Zone, for example, cn-north-1-pkx-1a to which to copy the snapshot.

Only supported when copying a snapshot to a Local Zone.

Returns:

  • (String)


9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9940

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,
  :destination_availability_zone,
  :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 supported when copying a snapshot to an Outpost.

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

Returns:

  • (String)


9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9940

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,
  :destination_availability_zone,
  :dry_run)
  SENSITIVE = [:presigned_url]
  include Aws::Structure
end

#destination_region ⇒ String

Deprecated.

Returns:

  • (String)


9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9940

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,
  :destination_availability_zone,
  :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)


9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9940

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,
  :destination_availability_zone,
  :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. Copies of 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.

Returns:

  • (Boolean)


9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9940

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,
  :destination_availability_zone,
  :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)


9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9940

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,
  :destination_availability_zone,
  :dry_run)
  SENSITIVE = [:presigned_url]
  include Aws::Structure
end

#presigned_url ⇒ String

Deprecated.

Returns:

  • (String)


9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9940

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,
  :destination_availability_zone,
  :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)


9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9940

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,
  :destination_availability_zone,
  :dry_run)
  SENSITIVE = [:presigned_url]
  include Aws::Structure
end

#source_snapshot_id ⇒ String

The ID of the EBS snapshot to copy.

Returns:

  • (String)


9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9940

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,
  :destination_availability_zone,
  :dry_run)
  SENSITIVE = [:presigned_url]
  include Aws::Structure
end

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the new snapshot.

Returns:



9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9940

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,
  :destination_availability_zone,
  :dry_run)
  SENSITIVE = [:presigned_url]
  include Aws::Structure
end