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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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: "String", # required
  tag_specifications: [
    {
      resource_type: "client-vpn-endpoint", # accepts client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, elastic-ip, fleet, fpga-image, image, instance, internet-gateway, launch-template, natgateway, network-acl, network-interface, reserved-instances, route-table, security-group, snapshot, spot-instances-request, subnet, transit-gateway, transit-gateway-attachment, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  dry_run: false,
}

Contains the parameters for CreateSnapshot.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A description for the snapshot.

Returns:

  • (String) 


6336
6337
6338
6339
6340
6341
6342
 
# File 'lib/aws-sdk-ec2/types.rb', line 6336

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

#dry_run ⇒ Boolean

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) 


6336
6337
6338
6339
6340
6341
6342
 
# File 'lib/aws-sdk-ec2/types.rb', line 6336

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

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the snapshot during creation.

Returns:



6336
6337
6338
6339
6340
6341
6342
 
# File 'lib/aws-sdk-ec2/types.rb', line 6336

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

#volume_id ⇒ String

The ID of the EBS volume.

Returns:

  • (String) 


6336
6337
6338
6339
6340
6341
6342
 
# File 'lib/aws-sdk-ec2/types.rb', line 6336

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