Package software.amazon.awscdk.services.imagebuilder

Interface CfnImageRecipe.EbsInstanceBlockDeviceSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnImageRecipe.EbsInstanceBlockDeviceSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnImageRecipe

@Stability(Stable)
public static interface CfnImageRecipe.EbsInstanceBlockDeviceSpecificationProperty
extends software.amazon.jsii.JsiiSerializable

The image recipe EBS instance block device specification includes the Amazon EBS-specific block device mapping specifications for the image.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.imagebuilder.*;
 EbsInstanceBlockDeviceSpecificationProperty ebsInstanceBlockDeviceSpecificationProperty = EbsInstanceBlockDeviceSpecificationProperty.builder()
         .deleteOnTermination(false)
         .encrypted(false)
         .iops(123)
         .kmsKeyId("kmsKeyId")
         .snapshotId("snapshotId")
         .throughput(123)
         .volumeSize(123)
         .volumeType("volumeType")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnImageRecipe.EbsInstanceBlockDeviceSpecificationProperty.Builder	A builder for CfnImageRecipe.EbsInstanceBlockDeviceSpecificationProperty
static final class	CfnImageRecipe.EbsInstanceBlockDeviceSpecificationProperty.Jsii$Proxy	An implementation for CfnImageRecipe.EbsInstanceBlockDeviceSpecificationProperty

Method Summary

Modifier and Type	Method	Description
static CfnImageRecipe.EbsInstanceBlockDeviceSpecificationProperty.Builder	builder()
default Object	getDeleteOnTermination()	Configures delete on termination of the associated device.
default Object	getEncrypted()	Use to configure device encryption.
default Number	getIops()	Use to configure device IOPS.
default String	getKmsKeyId()	Use to configure the KMS key to use when encrypting the device.
default String	getSnapshotId()	The snapshot that defines the device contents.
default Number	getThroughput()	For GP3 volumes only – The throughput in MiB/s that the volume supports.
default Number	getVolumeSize()	Overrides the volume size of the device.
default String	getVolumeType()	Overrides the volume type of the device.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeleteOnTermination

@Stability(Stable)
@Nullable
default Object getDeleteOnTermination()

Configures delete on termination of the associated device.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification-deleteontermination

getEncrypted

@Stability(Stable)
@Nullable
default Object getEncrypted()

Use to configure device encryption.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification-encrypted

getIops

@Stability(Stable)
@Nullable
default Number getIops()

Use to configure device IOPS.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification-iops

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

Use to configure the KMS key to use when encrypting the device.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification-kmskeyid

getSnapshotId

@Stability(Stable)
@Nullable
default String getSnapshotId()

The snapshot that defines the device contents.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification-snapshotid

getThroughput

@Stability(Stable)
@Nullable
default Number getThroughput()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification-throughput

getVolumeSize

@Stability(Stable)
@Nullable
default Number getVolumeSize()

Overrides the volume size of the device.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification-volumesize

getVolumeType

@Stability(Stable)
@Nullable
default String getVolumeType()

Overrides the volume type of the device.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification-volumetype

builder

@Stability(Stable)
static CfnImageRecipe.EbsInstanceBlockDeviceSpecificationProperty.Builder builder()

Returns:

a CfnImageRecipe.EbsInstanceBlockDeviceSpecificationProperty.Builder of CfnImageRecipe.EbsInstanceBlockDeviceSpecificationProperty