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

Class: Aws::EC2::Types::AttachVolumeRequest

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

{
  device: "String", # required
  instance_id: "String", # required
  volume_id: "String", # required
  dry_run: false,
}

Contains the parameters for AttachVolume.

Instance Attribute Summary collapse

Instance Attribute Details

#deviceString

The device name to expose to the instance (for example, /dev/sdh or xvdh).

Returns:

  • (String)


927
928
929
930
931
932
933
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 927

class AttachVolumeRequest < Struct.new(
  :device,
  :instance_id,
  :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)


927
928
929
930
931
932
933
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 927

class AttachVolumeRequest < Struct.new(
  :device,
  :instance_id,
  :volume_id,
  :dry_run)
  include Aws::Structure
end

#instance_idString

The ID of the instance.

Returns:

  • (String)


927
928
929
930
931
932
933
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 927

class AttachVolumeRequest < Struct.new(
  :device,
  :instance_id,
  :volume_id,
  :dry_run)
  include Aws::Structure
end

#volume_idString

The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

Returns:

  • (String)


927
928
929
930
931
932
933
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 927

class AttachVolumeRequest < Struct.new(
  :device,
  :instance_id,
  :volume_id,
  :dry_run)
  include Aws::Structure
end