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,
  },
  outpost_arn: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts capacity-reservation, client-vpn-endpoint, customer-gateway, carrier-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, instance-event-window, internet-gateway, ipv4pool-ec2, ipv6pool-ec2, key-pair, launch-template, local-gateway, local-gateway-route-table, local-gateway-virtual-interface, local-gateway-virtual-interface-group, local-gateway-route-table-vpc-association, local-gateway-route-table-virtual-interface-group-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, placement-group, prefix-list, replace-root-volume-task, reserved-instances, route-table, security-group, security-group-rule, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-endpoint, vpc-endpoint-service, 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)


9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9577

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


9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9577

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


9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9577

class CreateSnapshotsRequest < Struct.new(
  :description,
  :instance_specification,
  :outpost_arn,
  :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.



9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9577

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

#outpost_arnString

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

  • To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.

  • To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.

  • To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.

For more information, see Create multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (String)


9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9577

class CreateSnapshotsRequest < Struct.new(
  :description,
  :instance_specification,
  :outpost_arn,
  :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:



9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9577

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