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

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

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

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

Contains the parameters for DetachVolume.

Instance Attribute Summary collapse

Instance Attribute Details

#deviceString

The device name.

Returns:

  • (String)


11879
11880
11881
11882
11883
11884
11885
11886
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11879

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


11879
11880
11881
11882
11883
11884
11885
11886
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11879

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

#forceBoolean

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)


11879
11880
11881
11882
11883
11884
11885
11886
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11879

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

#instance_idString

The ID of the instance.

Returns:

  • (String)


11879
11880
11881
11882
11883
11884
11885
11886
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11879

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

#volume_idString

The ID of the volume.

Returns:

  • (String)


11879
11880
11881
11882
11883
11884
11885
11886
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11879

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