Skip to content

EbsInstanceBlockDeviceSpecification

Source code in docs_src/capo_imagebuilder/types/ebs_instance_block_device_specification.py
class EbsInstanceBlockDeviceSpecification(TypedDict, closed=True):
    encrypted: NotRequired["capo_imagebuilder.types.nullable_boolean.NullableBoolean"]
    """<p>Specifies whether to encrypt the device.</p>"""
    delete_on_termination: NotRequired[
        "capo_imagebuilder.types.nullable_boolean.NullableBoolean"
    ]
    """<p>Specifies whether to delete the associated device on termination.</p>"""
    iops: NotRequired["capo_imagebuilder.types.ebs_iops_integer.EbsIopsInteger"]
    """<p>The IOPS value for the device. Required only when volumeType is io1 or io2.</p>"""
    kms_key_id: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>The Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device. This can be either the Key ARN or the Alias ARN. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">Key identifiers (KeyId)</a> in the <i>Key Management Service Developer Guide</i>.</p>"""
    snapshot_id: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>The snapshot that defines the device contents.</p>"""
    volume_size: NotRequired[
        "capo_imagebuilder.types.ebs_volume_size_integer.EbsVolumeSizeInteger"
    ]
    """<p>Overrides the volume size for the device.</p>"""
    volume_type: NotRequired["capo_imagebuilder.types.ebs_volume_type.EbsVolumeType"]
    """<p>Overrides the volume type for the device.</p>"""
    throughput: NotRequired[
        "capo_imagebuilder.types.ebs_volume_throughput.EbsVolumeThroughput"
    ]
    """<p> <b>For GP3 volumes only</b> – The throughput in MiB/s that the volume supports.</p>"""

delete_on_termination instance-attribute

delete_on_termination: NotRequired[NullableBoolean]

Specifies whether to delete the associated device on termination.

encrypted instance-attribute

encrypted: NotRequired[NullableBoolean]

Specifies whether to encrypt the device.

iops instance-attribute

iops: NotRequired[EbsIopsInteger]

The IOPS value for the device. Required only when volumeType is io1 or io2.

kms_key_id instance-attribute

kms_key_id: NotRequired[NonEmptyString]

The Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.

snapshot_id instance-attribute

snapshot_id: NotRequired[NonEmptyString]

The snapshot that defines the device contents.

throughput instance-attribute

throughput: NotRequired[EbsVolumeThroughput]

For GP3 volumes only – The throughput in MiB/s that the volume supports.

volume_size instance-attribute

volume_size: NotRequired[EbsVolumeSizeInteger]

Overrides the volume size for the device.

volume_type instance-attribute

volume_type: NotRequired[EbsVolumeType]

Overrides the volume type for the device.