Class: Aws::EC2::Types::DetachVolumeRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::DetachVolumeRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DetachVolumeRequest data as a hash:

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

Contains the parameters for DetachVolume.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #device ⇒ String

  The device name.

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #force ⇒ Boolean

  Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally).

• #instance_id ⇒ String

  The ID of the instance.

• #volume_id ⇒ String

  The ID of the volume.

Instance Attribute Details

#device ⇒ String

The device name.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 11672

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

# File 'lib/aws-sdk-ec2/types.rb', line 11672

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

#force ⇒ Boolean

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won’t have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 11672

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

#instance_id ⇒ String

The ID of the instance.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 11672

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

#volume_id ⇒ String

The ID of the volume.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 11672

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