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
  dry_run: false,
}

Contains the parameters for CreateSnapshot.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description for the snapshot.

Returns:

  • (String)


4239
4240
4241
4242
4243
4244
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4239

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


4239
4240
4241
4242
4243
4244
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4239

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

#volume_idString

The ID of the EBS volume.

Returns:

  • (String)


4239
4240
4241
4242
4243
4244
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4239

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