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",
  volume_id: "VolumeId", # required
  tag_specifications: [
    {
      resource_type: "client-vpn-endpoint", # accepts client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, 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,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description for the snapshot.

Returns:

  • (String)


7751
7752
7753
7754
7755
7756
7757
7758
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7751

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


7751
7752
7753
7754
7755
7756
7757
7758
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7751

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



7751
7752
7753
7754
7755
7756
7757
7758
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7751

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

#volume_idString

The ID of the EBS volume.

Returns:

  • (String)


7751
7752
7753
7754
7755
7756
7757
7758
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7751

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