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

Class: Aws::EC2::Types::EbsBlockDevice

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing EbsBlockDevice as input to an Aws::Client method, you can use a vanilla Hash:

{
  delete_on_termination: false,
  iops: 1,
  snapshot_id: "String",
  volume_size: 1,
  volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1
  kms_key_id: "String",
  encrypted: false,
}

Describes a block device for an EBS volume.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#delete_on_termination ⇒ Boolean

Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (Boolean) —

    Indicates whether the EBS volume is deleted on instance termination.

#encrypted ⇒ Boolean

Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

In no case can you remove encryption from an encrypted volume.

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

This parameter is not returned by .

Returns:

  • (Boolean) —

    Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot.

#iops ⇒ Integer

The number of I/O operations per second (IOPS) that the volume supports. For io1 and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000 IOPS for io1 and io2 volumes in most Regions. Maximum io1 and io2 IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Condition: This parameter is required for requests to create io1 and io2 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

Returns:

  • (Integer) —

    The number of I/O operations per second (IOPS) that the volume supports.

#kms_key_id ⇒ String

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.

This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.

Returns:

  • (String) —

    Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.

#snapshot_id ⇒ String

The ID of the snapshot.

Returns:

  • (String) —

    The ID of the snapshot.

#volume_size ⇒ Integer

The size of the volume, in GiB.

Default: If you\'re creating the volume from a snapshot and don\'t specify a volume size, the default is the snapshot size.

Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1 and io2), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Returns:

  • (Integer) —

    The size of the volume, in GiB.

#volume_type ⇒ String

The volume type. If you set the type to io1 or io2, you must also specify the Iops parameter. If you set the type to gp2, st1, sc1, or standard, you must omit the Iops parameter.

Default: gp2

Possible values:

  • standard
  • io1
  • io2
  • gp2
  • sc1
  • st1

Returns:

  • (String) —

    The volume type.