Class: Aws::EC2::Types::CreateSnapshotsRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#copy_tags_from_sourceString

Copies the tags from the specified volume to corresponding snapshot.

Returns:

  • (String)


12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12881

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

#descriptionString

A description propagated to every snapshot specified by the instance.

Returns:

  • (String)


12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12881

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

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


12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12881

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

#instance_specificationTypes::InstanceSpecification

The instance to specify which volumes should be included in the snapshots.



12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12881

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

#locationString

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

  • To create local snapshots in the same Local Zone as the source instance, specify local.

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

Default value: regional

Returns:

  • (String)


12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12881

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

#outpost_arnString

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

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

  • To create the snapshots 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)


12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12881

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

#tag_specificationsArray<Types::TagSpecification>

Tags to apply to every snapshot specified by the instance.

Returns:



12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12881

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