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

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

Overview

Note:

When making an API call, you may pass CreateSnapshotsRequest data as a hash:

{
  description: "String",
  instance_specification: { # required
    instance_id: "InstanceId",
    exclude_boot_volume: false,
  },
  tag_specifications: [
    {
      resource_type: "client-vpn-endpoint", # accepts client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  dry_run: false,
  copy_tags_from_source: "volume", # accepts volume
}

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)


8023
8024
8025
8026
8027
8028
8029
8030
8031
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 8023

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

#descriptionString

A description propagated to every snapshot specified by the instance.

Returns:

  • (String)


8023
8024
8025
8026
8027
8028
8029
8030
8031
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 8023

class CreateSnapshotsRequest < Struct.new(
  :description,
  :instance_specification,
  :tag_specifications,
  :dry_run,
  :copy_tags_from_source)
  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)


8023
8024
8025
8026
8027
8028
8029
8030
8031
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 8023

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

#instance_specificationTypes::InstanceSpecification

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



8023
8024
8025
8026
8027
8028
8029
8030
8031
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 8023

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

#tag_specificationsArray<Types::TagSpecification>

Tags to apply to every snapshot specified by the instance.

Returns:



8023
8024
8025
8026
8027
8028
8029
8030
8031
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 8023

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