Package software.amazon.awscdk.services.imagebuilder

Interface CfnContainerRecipe.EbsInstanceBlockDeviceSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnContainerRecipe.EbsInstanceBlockDeviceSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnContainerRecipe

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

Amazon EBS-specific block device mapping specifications.

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-containerrecipe-ebsinstanceblockdevicespecification.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnContainerRecipe.EbsInstanceBlockDeviceSpecificationProperty.Builder	builder()
default Object	getDeleteOnTermination()	Use to configure 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()	The Amazon Resource Name (ARN) that uniquely identifies 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()	Use to override the device's volume size.
default String	getVolumeType()	Use to override the device's volume type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeleteOnTermination

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

Use to configure delete on termination of the associated device.

Returns union: either Boolean or IResolvable

See Also:

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

getEncrypted

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

Use to configure device encryption.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-containerrecipe-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-containerrecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification-iops

getKmsKeyId

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

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 AWS Key Management Service Developer Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-containerrecipe-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-containerrecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-containerrecipe-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-containerrecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification-throughput

getVolumeSize

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

Use to override the device's volume size.

See Also:

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

getVolumeType

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

Use to override the device's volume type.

See Also:

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

builder

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

Returns:

a CfnContainerRecipe.EbsInstanceBlockDeviceSpecificationProperty.Builder of CfnContainerRecipe.EbsInstanceBlockDeviceSpecificationProperty