Class: Aws::AutoScaling::Types::Ebs

Inherits:

Struct

• Object
• Struct
• Aws::AutoScaling::Types::Ebs

Includes:

Structure

Defined in:

lib/aws-sdk-autoscaling/types.rb

Overview

Describes information used to set up an Amazon EBS volume specified in a block device mapping.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #delete_on_termination ⇒ Boolean

  Indicates whether the volume is deleted on instance termination.

• #encrypted ⇒ Boolean

  Specifies whether the volume should be encrypted.

• #iops ⇒ Integer

  The number of input/output (I/O) operations per second (IOPS) to provision for the volume.

• #snapshot_id ⇒ String

  The snapshot ID of the volume to use.

• #throughput ⇒ Integer

  The throughput (MiBps) to provision for a ‘gp3` volume.

• #volume_size ⇒ Integer

  The volume size, in GiBs.

• #volume_type ⇒ String

  The volume type.

Instance Attribute Details

#delete_on_termination ⇒ Boolean

Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is ‘true`.

Returns:

• (Boolean)

# File 'lib/aws-sdk-autoscaling/types.rb', line 2943

class Ebs < Struct.new(
  :snapshot_id,
  :volume_size,
  :volume_type,
  :delete_on_termination,
  :iops,
  :encrypted,
  :throughput)
  SENSITIVE = []
  include Aws::Structure
end

#encrypted ⇒ Boolean

Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see [Requirements for Amazon EBS encryption] in the *Amazon EBS User Guide*. If your AMI uses encrypted volumes, you can also only launch it on supported instance types.

<note markdown=“1”> If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using a launch configuration.

If you enable encryption by default, the EBS volumes that you create

are always encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was encrypted.

For more information, see [Use Amazon Web Services KMS keys to

encrypt Amazon EBS volumes] in the *Amazon EC2 Auto Scaling User Guide*.

</note>

[1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html [2]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-data-protection.html#encryption

Returns:

• (Boolean)

# File 'lib/aws-sdk-autoscaling/types.rb', line 2943

class Ebs < Struct.new(
  :snapshot_id,
  :volume_size,
  :volume_type,
  :delete_on_termination,
  :iops,
  :encrypted,
  :throughput)
  SENSITIVE = []
  include Aws::Structure
end

#iops ⇒ Integer

The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For ‘gp3` and `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.

The following are the supported values for each volume type:

• ‘gp3`: 3,000-16,000 IOPS

• ‘io1`: 100-64,000 IOPS

For ‘io1` volumes, we guarantee 64,000 IOPS only for [Instances built on the Amazon Web Services Nitro System]. Other instance families guarantee performance up to 32,000 IOPS.

‘Iops` is supported when the volume type is `gp3` or `io1` and required only when the volume type is `io1`. (Not used with `standard`, `gp2`, `st1`, or `sc1` volumes.)

[1]: docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html

Returns:

• (Integer)

# File 'lib/aws-sdk-autoscaling/types.rb', line 2943

class Ebs < Struct.new(
  :snapshot_id,
  :volume_size,
  :volume_type,
  :delete_on_termination,
  :iops,
  :encrypted,
  :throughput)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_id ⇒ String

The snapshot ID of the volume to use.

You must specify either a ‘VolumeSize` or a `SnapshotId`.

Returns:

• (String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 2943

class Ebs < Struct.new(
  :snapshot_id,
  :volume_size,
  :volume_type,
  :delete_on_termination,
  :iops,
  :encrypted,
  :throughput)
  SENSITIVE = []
  include Aws::Structure
end

#throughput ⇒ Integer

The throughput (MiBps) to provision for a ‘gp3` volume.

Returns:

• (Integer)

# File 'lib/aws-sdk-autoscaling/types.rb', line 2943

class Ebs < Struct.new(
  :snapshot_id,
  :volume_size,
  :volume_type,
  :delete_on_termination,
  :iops,
  :encrypted,
  :throughput)
  SENSITIVE = []
  include Aws::Structure
end

#volume_size ⇒ Integer

The volume size, in GiBs. The following are the supported volumes sizes for each volume type:

• ‘gp2` and `gp3`: 1-16,384

• ‘io1`: 4-16,384

• ‘st1` and `sc1`: 125-16,384

• ‘standard`: 1-1,024

You must specify either a ‘SnapshotId` or a `VolumeSize`. If you specify both `SnapshotId` and `VolumeSize`, the volume size must be equal or greater than the size of the snapshot.

Returns:

• (Integer)

# File 'lib/aws-sdk-autoscaling/types.rb', line 2943

class Ebs < Struct.new(
  :snapshot_id,
  :volume_size,
  :volume_type,
  :delete_on_termination,
  :iops,
  :encrypted,
  :throughput)
  SENSITIVE = []
  include Aws::Structure
end

#volume_type ⇒ String

The volume type. For more information, see [Amazon EBS volume types] in the *Amazon EBS User Guide*.

Valid values: ‘standard` | `io1` | `gp2` | `st1` | `sc1` | `gp3`

[1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html

Returns:

• (String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 2943

class Ebs < Struct.new(
  :snapshot_id,
  :volume_size,
  :volume_type,
  :delete_on_termination,
  :iops,
  :encrypted,
  :throughput)
  SENSITIVE = []
  include Aws::Structure
end