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, gp2, sc1, st1
  encrypted: false,
  kms_key_id: "String",
}

Describes a block device for an EBS volume.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#delete_on_terminationBoolean

Indicates whether the EBS volume is deleted on instance termination.

Returns:

  • (Boolean)

    Indicates whether the EBS volume is deleted on instance termination.

#encryptedBoolean

Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption.

If you are creating a volume from a snapshot, you cannot specify an encryption value. This is because only blank volumes can be encrypted on creation. If you are creating a snapshot from an existing EBS volume, you cannot specify an encryption value that differs from that of the EBS volume. We recommend that you omit the encryption value from the block device mappings when creating an image from an instance.

Returns:

  • (Boolean)

    Indicates whether the EBS volume is encrypted.

#iopsInteger

The number of I/O operations per second (IOPS) that the volume supports. For io1 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,000IOPS for io1 volumes, in most Regions. The maximum IOPS for io1 of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS.

Condition: This parameter is required for requests to create io1 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_idString

Identifier (key ID, key alias, ID ARN, or alias ARN) for a user-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 user-managed CMK under which the EBS volume is encrypted.

#snapshot_idString

The ID of the snapshot.

Returns:

  • (String)

    The ID of the snapshot.

#volume_sizeInteger

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), 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_typeString

The volume type. If you set the type to io1, you must also set the Iops property.

Default: standard

Possible values:

  • standard
  • io1
  • gp2
  • sc1
  • st1

Returns:

  • (String)

    The volume type.