EbsDeviceProps

class aws_cdk.aws_ec2.EbsDeviceProps(*, delete_on_termination=None, iops=None, volume_type=None, volume_size=None, encrypted=None, kms_key=None, snapshot_id=None)

Bases: EbsDeviceSnapshotOptions, EbsDeviceOptions

Properties of an EBS block device.

Parameters

delete_on_termination (Optional[bool]) – Indicates whether to delete the volume when the instance is terminated. Default: - true for Amazon EC2 Auto Scaling, false otherwise (e.g. EBS)
iops (Union[int, float, None]) – The number of I/O operations per second (IOPS) to provision for the volume. Must only be set for {@link volumeType}: {@link EbsDeviceVolumeType.IO1} The maximum ratio of IOPS to volume size (in GiB) is 50:1, so for 5,000 provisioned IOPS, you need at least 100 GiB storage on the volume. Default: - none, required for {@link EbsDeviceVolumeType.IO1}
volume_type (Optional[EbsDeviceVolumeType]) – The EBS volume type. Default: {@link EbsDeviceVolumeType.GP2}
volume_size (Union[int, float, None]) – The volume size, in Gibibytes (GiB). If you specify volumeSize, it must be equal or greater than the size of the snapshot. Default: - The snapshot size
encrypted (Optional[bool]) – Specifies whether the EBS volume is encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption Default: false
kms_key (Optional[IKey]) – The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption. You have to ensure that the KMS CMK has the correct permissions to be used by the service launching the ec2 instances. Default: - If encrypted is true, the default aws/ebs KMS key will be used.
snapshot_id (Optional[str]) – The snapshot ID of the volume to use. Default: - No snapshot will be used

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ec2 as ec2
import aws_cdk.aws_kms as kms

# key: kms.Key

ebs_device_props = ec2.EbsDeviceProps(
    delete_on_termination=False,
    encrypted=False,
    iops=123,
    kms_key=key,
    snapshot_id="snapshotId",
    volume_size=123,
    volume_type=ec2.EbsDeviceVolumeType.STANDARD
)

Attributes

delete_on_termination

Indicates whether to delete the volume when the instance is terminated.

Default

true for Amazon EC2 Auto Scaling, false otherwise (e.g. EBS)

Return type

Optional[bool]

encrypted

Specifies whether the EBS volume is encrypted.

Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption

Default: false
See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances
Return type: Optional[bool]

iops

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

Must only be set for {@link volumeType}: {@link EbsDeviceVolumeType.IO1}

The maximum ratio of IOPS to volume size (in GiB) is 50:1, so for 5,000 provisioned IOPS, you need at least 100 GiB storage on the volume.

Default

none, required for {@link EbsDeviceVolumeType.IO1}

See

https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html

Return type

Union[int, float, None]

kms_key

The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.

You have to ensure that the KMS CMK has the correct permissions to be used by the service launching the ec2 instances.

Default

If encrypted is true, the default aws/ebs KMS key will be used.

See

https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#ebs-encryption-requirements

Return type

Optional[IKey]

snapshot_id

The snapshot ID of the volume to use.

Default

No snapshot will be used

Return type

Optional[str]

volume_size

The volume size, in Gibibytes (GiB).

If you specify volumeSize, it must be equal or greater than the size of the snapshot.

Default

The snapshot size

Return type

Union[int, float, None]

volume_type

The EBS volume type.

Default: {@link EbsDeviceVolumeType.GP2}
See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
Return type: Optional[EbsDeviceVolumeType]