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

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 CreateSnapshotRequest data as a hash:

{
  description: "String",
  outpost_arn: "String",
  volume_id: "VolumeId", # required
  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,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description for the snapshot.

Returns:

  • (String)


9489
9490
9491
9492
9493
9494
9495
9496
9497
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9489

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


9489
9490
9491
9492
9493
9494
9495
9496
9497
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9489

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

#outpost_arnString

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.

Returns:

  • (String)


9489
9490
9491
9492
9493
9494
9495
9496
9497
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9489

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

#tag_specificationsArray<Types::TagSpecification>

The tags to apply to the snapshot during creation.

Returns:



9489
9490
9491
9492
9493
9494
9495
9496
9497
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9489

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

#volume_idString

The ID of the Amazon EBS volume.

Returns:

  • (String)


9489
9490
9491
9492
9493
9494
9495
9496
9497
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9489

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