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

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

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::EbsBlockDevice

Defined in:

gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass EbsBlockDevice data as a 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.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #delete_on_termination ⇒ 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.

• #iops ⇒ 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.

• #snapshot_id ⇒ String

  The ID of the snapshot.

• #volume_size ⇒ Integer

  The size of the volume, in GiB.

• #volume_type ⇒ String

  The volume type.

Instance Attribute Details

#delete_on_termination ⇒ Boolean

Indicates whether the EBS volume is deleted on instance termination.

Returns:

• (Boolean)

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

class EbsBlockDevice < Struct.new(
  :delete_on_termination,
  :iops,
  :snapshot_id,
  :volume_size,
  :volume_type,
  :encrypted,
  :kms_key_id)
  include Aws::Structure
end

#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.

Returns:

• (Boolean)

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

class EbsBlockDevice < Struct.new(
  :delete_on_termination,
  :iops,
  :snapshot_id,
  :volume_size,
  :volume_type,
  :encrypted,
  :kms_key_id)
  include Aws::Structure
end

#iops ⇒ Integer

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. Maximum io1 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 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

Returns:

• (Integer)

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

class EbsBlockDevice < Struct.new(
  :delete_on_termination,
  :iops,
  :snapshot_id,
  :volume_size,
  :volume_type,
  :encrypted,
  :kms_key_id)
  include Aws::Structure
end

#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)

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

class EbsBlockDevice < Struct.new(
  :delete_on_termination,
  :iops,
  :snapshot_id,
  :volume_size,
  :volume_type,
  :encrypted,
  :kms_key_id)
  include Aws::Structure
end

#snapshot_id ⇒ String

The ID of the snapshot.

Returns:

• (String)

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

class EbsBlockDevice < Struct.new(
  :delete_on_termination,
  :iops,
  :snapshot_id,
  :volume_size,
  :volume_type,
  :encrypted,
  :kms_key_id)
  include Aws::Structure
end

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

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

class EbsBlockDevice < Struct.new(
  :delete_on_termination,
  :iops,
  :snapshot_id,
  :volume_size,
  :volume_type,
  :encrypted,
  :kms_key_id)
  include Aws::Structure
end

#volume_type ⇒ String

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

Default: standard

Returns:

• (String)

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

class EbsBlockDevice < Struct.new(
  :delete_on_termination,
  :iops,
  :snapshot_id,
  :volume_size,
  :volume_type,
  :encrypted,
  :kms_key_id)
  include Aws::Structure
end