Class: Aws::EC2::Types::CreateSnapshotRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A description for the snapshot.

Returns:

  • (String) 


16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16167

class CreateSnapshotRequest < Struct.new(
  :description,
  :outpost_arn,
  :volume_id,
  :tag_specifications,
  :location,
  :dry_run)
  SENSITIVE = []
  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) 


16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16167

class CreateSnapshotRequest < Struct.new(
  :description,
  :outpost_arn,
  :volume_id,
  :tag_specifications,
  :location,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#location ⇒ String

Only supported for volumes in Local Zones. If the source volume is not in a Local Zone, omit this parameter.

  • To create a local snapshot in the same Local Zone as the source volume, specify local.

  • To create a regional snapshot in the parent Region of the Local Zone, specify regional or omit this parameter.

Default value: regional

Returns:

  • (String) 


16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16167

class CreateSnapshotRequest < Struct.new(
  :description,
  :outpost_arn,
  :volume_id,
  :tag_specifications,
  :location,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#outpost_arn ⇒ String

Only supported for volumes on Outposts. If the source volume is not on an Outpost, omit this parameter.

  • To create the snapshot on the same Outpost as the source volume, specify the ARN of that Outpost. The snapshot must be created on the same Outpost as the volume.

  • To create the snapshot in the parent Region of the Outpost, omit this parameter.

For more information, see Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.

Returns:

  • (String) 


16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16167

class CreateSnapshotRequest < Struct.new(
  :description,
  :outpost_arn,
  :volume_id,
  :tag_specifications,
  :location,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the snapshot during creation.

Returns:



16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16167

class CreateSnapshotRequest < Struct.new(
  :description,
  :outpost_arn,
  :volume_id,
  :tag_specifications,
  :location,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#volume_id ⇒ String

The ID of the Amazon EBS volume.

Returns:

  • (String) 


16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16167

class CreateSnapshotRequest < Struct.new(
  :description,
  :outpost_arn,
  :volume_id,
  :tag_specifications,
  :location,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end