Package software.amazon.awscdk.services.ec2

Interface CfnSpotFleet.EbsBlockDeviceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSpotFleet.EbsBlockDeviceProperty.Jsii$Proxy

Enclosing class:

CfnSpotFleet

@Stability(Stable)
public static interface CfnSpotFleet.EbsBlockDeviceProperty
extends software.amazon.jsii.JsiiSerializable

Describes a block device for an EBS volume.

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.ec2.*;
 EbsBlockDeviceProperty ebsBlockDeviceProperty = EbsBlockDeviceProperty.builder()
         .deleteOnTermination(false)
         .encrypted(false)
         .iops(123)
         .snapshotId("snapshotId")
         .volumeSize(123)
         .volumeType("volumeType")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnSpotFleet.EbsBlockDeviceProperty.Builder	builder()
default Object	getDeleteOnTermination()	Indicates whether the EBS volume is deleted on instance termination.
default Object	getEncrypted()	Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot.
default Number	getIops()	The number of I/O operations per second (IOPS).
default String	getSnapshotId()	The ID of the snapshot.
default Number	getVolumeSize()	The size of the volume, in GiBs.
default String	getVolumeType()	The volume type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeleteOnTermination

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

Indicates whether the EBS volume is deleted on instance termination.

For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-deleteontermination

getEncrypted

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

Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot.

The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS Encryption in the Amazon EC2 User Guide .

In no case can you remove encryption from an encrypted volume.

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types .

This parameter is not returned by DescribeImageAttribute .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-encrypted

getIops

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

The number of I/O operations per second (IOPS).

For gp3 , io1 , and io2 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
• io2 : 100 - 256,000 IOPS

For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System . On other instances, you can achieve performance up to 32,000 IOPS.

This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-iops

getSnapshotId

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

The ID of the snapshot.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-snapshotid

getVolumeSize

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

The size of the volume, in GiBs.

You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.

The following are the supported sizes for each volume type:

• gp2 and gp3 : 1 - 16,384 GiB
• io1 : 4 - 16,384 GiB
• io2 : 4 - 65,536 GiB
• st1 and sc1 : 125 - 16,384 GiB
• standard : 1 - 1024 GiB

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-volumesize

getVolumeType

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

The volume type.

For more information, see Amazon EBS volume types in the Amazon EBS User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-volumetype

builder

@Stability(Stable)
static CfnSpotFleet.EbsBlockDeviceProperty.Builder builder()

Returns:

a CfnSpotFleet.EbsBlockDeviceProperty.Builder of CfnSpotFleet.EbsBlockDeviceProperty