Package software.amazon.awscdk.services.ecs

Interface CfnService.ServiceManagedEBSVolumeConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.ServiceManagedEBSVolumeConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnService

@Stability(Stable)
public static interface CfnService.ServiceManagedEBSVolumeConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf.

These settings are used to create each Amazon EBS volume, with one volume created for each task in the service.

Many of these parameters map 1:1 with the Amazon EBS CreateVolume API request parameters.

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.ecs.*;
 ServiceManagedEBSVolumeConfigurationProperty serviceManagedEBSVolumeConfigurationProperty = ServiceManagedEBSVolumeConfigurationProperty.builder()
         .roleArn("roleArn")
         // the properties below are optional
         .encrypted(false)
         .filesystemType("filesystemType")
         .iops(123)
         .kmsKeyId("kmsKeyId")
         .sizeInGiB(123)
         .snapshotId("snapshotId")
         .tagSpecifications(List.of(EBSTagSpecificationProperty.builder()
                 .resourceType("resourceType")
                 // the properties below are optional
                 .propagateTags("propagateTags")
                 .tags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build()))
         .throughput(123)
         .volumeType("volumeType")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder	builder()
default Object	getEncrypted()	Indicates whether the volume should be encrypted.
default String	getFilesystemType()	The Linux filesystem type for the volume.
default Number	getIops()	The number of I/O operations per second (IOPS).
default String	getKmsKeyId()	The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption.
String	getRoleArn()	The ARN of the IAM role to associate with this volume.
default Number	getSizeInGiB()	The size of the volume in GiB.
default String	getSnapshotId()	The snapshot that Amazon ECS uses to create the volume.
default Object	getTagSpecifications()	The tags to apply to the volume.
default Number	getThroughput()	The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s.
default String	getVolumeType()	The volume type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The ARN of the IAM role to associate with this volume.

This is the Amazon ECS infrastructure IAM role that is used to manage your AWS infrastructure. We recommend using the Amazon ECS-managed AmazonECSInfrastructureRolePolicyForVolumes IAM policy with this role. For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-rolearn

getEncrypted

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

Indicates whether the volume should be encrypted.

If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume API in the Amazon EC2 API Reference .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-encrypted

getFilesystemType

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

The Linux filesystem type for the volume.

For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.

The available filesystem types are ext3 , ext4 , and xfs . If no value is specified, the xfs filesystem type is used by default.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-filesystemtype

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

This parameter is required for io1 and io2 volume types. The default for gp3 volumes is 3,000 IOPS . This parameter is not supported for st1 , sc1 , or standard volume types.

This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the Amazon EC2 API Reference .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-iops

getKmsKeyId

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

The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption.

When encryption is turned on and no AWS Key Management Service key is specified, the default AWS managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the Amazon EC2 API Reference .

AWS authenticates the AWS Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-kmskeyid

getSizeInGiB

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

The size of the volume in GiB.

You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the Size parameter of the CreateVolume API in the Amazon EC2 API Reference .

The following are the supported volume size values for each volume type.

• gp2 and gp3 : 1-16,384
• io1 and io2 : 4-16,384
• st1 and sc1 : 125-16,384
• standard : 1-1,024

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-sizeingib

getSnapshotId

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

The snapshot that Amazon ECS uses to create the volume.

You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the SnapshotId parameter of the CreateVolume API in the Amazon EC2 API Reference .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-snapshotid

getTagSpecifications

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

The tags to apply to the volume.

Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the TagSpecifications.N parameter of the CreateVolume API in the Amazon EC2 API Reference .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-tagspecifications

getThroughput

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

The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s.

This parameter maps 1:1 with the Throughput parameter of the CreateVolume API in the Amazon EC2 API Reference .

This parameter is only supported for the gp3 volume type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-throughput

getVolumeType

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

The volume type.

This parameter maps 1:1 with the VolumeType parameter of the CreateVolume API in the Amazon EC2 API Reference . For more information, see Amazon EBS volume types in the Amazon EC2 User Guide .

The following are the supported volume types.

• General Purpose SSD: gp2 | gp3
• Provisioned IOPS SSD: io1 | io2
• Throughput Optimized HDD: st1
• Cold HDD: sc1
• Magnetic: standard

The magnetic volume type is not supported on Fargate.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-volumetype

builder

@Stability(Stable)
static CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder builder()

Returns:

a CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder of CfnService.ServiceManagedEBSVolumeConfigurationProperty