You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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: "String", # required
  tag_specifications: [
    {
      resource_type: "client-vpn-endpoint", # accepts client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, elastic-ip, fleet, fpga-image, host-reservation, 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.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description for the snapshot.

Returns:

  • (String)


6428
6429
6430
6431
6432
6433
6434
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6428

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


6428
6429
6430
6431
6432
6433
6434
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6428

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

#tag_specificationsArray<Types::TagSpecification>

The tags to apply to the snapshot during creation.

Returns:



6428
6429
6430
6431
6432
6433
6434
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6428

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

#volume_idString

The ID of the EBS volume.

Returns:

  • (String)


6428
6429
6430
6431
6432
6433
6434
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6428

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