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

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


10502
10503
10504
10505
10506
10507
10508
10509
10510
 
# File 'lib/aws-sdk-ec2/types.rb', line 10502

class CreateSnapshotRequest < Struct.new(
  :description,
  :outpost_arn,
  :volume_id,
  :tag_specifications,
  :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) 


10502
10503
10504
10505
10506
10507
10508
10509
10510
 
# File 'lib/aws-sdk-ec2/types.rb', line 10502

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

#outpost_arn ⇒ String

The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.

  • To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.

  • To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.

  • To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.

For more information, see [Create local snapshots from volumes on an Outpost] in the *Amazon Elastic Compute Cloud User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#create-snapshot

Returns:

  • (String) 


10502
10503
10504
10505
10506
10507
10508
10509
10510
 
# File 'lib/aws-sdk-ec2/types.rb', line 10502

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

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the snapshot during creation.

Returns:



10502
10503
10504
10505
10506
10507
10508
10509
10510
 
# File 'lib/aws-sdk-ec2/types.rb', line 10502

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

#volume_id ⇒ String

The ID of the Amazon EBS volume.

Returns:

  • (String) 


10502
10503
10504
10505
10506
10507
10508
10509
10510
 
# File 'lib/aws-sdk-ec2/types.rb', line 10502

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