AWS CDK Reference

Appearance

v2.274.0

ServiceManagedEBSVolumeConfigurationProperty Struct ​

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. For information about the supported launch types and operating systems, see Supported operating systems and launch types in the Amazon Elastic Container Service Developer Guide .

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

Source
Generated code
Type last changed
v2.196.0 · 16 May 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ecs as ecs } from 'aws-cdk-lib';
const serviceManagedEBSVolumeConfigurationProperty: ecs.CfnService.ServiceManagedEBSVolumeConfigurationProperty = {
  roleArn: 'roleArn',

  // the properties below are optional
  encrypted: false,
  filesystemType: 'filesystemType',
  iops: 123,
  kmsKeyId: 'kmsKeyId',
  sizeInGiB: 123,
  snapshotId: 'snapshotId',
  tagSpecifications: [{
    resourceType: 'resourceType',

    // the properties below are optional
    propagateTags: 'propagateTags',
    tags: [{
      key: 'key',
      value: 'value',
    }],
  }],
  throughput: 123,
  volumeInitializationRate: 123,
  volumeType: 'volumeType',
};

Properties ​

encryptedboolean | IResolvableencryptedtyping.Union[bool, IResolvable]encryptedBooleanEncryptedboolEncryptedinterface{}#
Indicates whether the volume should be encrypted.
notes

If you turn on Region-level Amazon EBS encryption by default but set this value as false , the setting is overridden and the volume is encrypted with the KMS key specified for Amazon EBS encryption by default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume API in the Amazon EC2 API Reference .

filesystemTypestringfilesystem_typestrfilesystemTypeStringFilesystemTypestringFilesystemType*string#
The filesystem type for the volume.
notes

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 tasks will fail to start.

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

The available Windows filesystem types are NTFS .

iopsnumberiopsint | floatiopsNumberIopsdoubleIops*float64#
The number of I/O operations per second (IOPS).
notes

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 .

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

When a key is specified using this parameter, it overrides Amazon EBS default encryption or any KMS key that you specified for cluster-level managed storage encryption. This parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the Amazon EC2 API Reference . For more information about encrypting Amazon EBS volumes attached to tasks, see Encrypt data stored in Amazon EBS volumes attached to Amazon ECS tasks .

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.

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*stringrequired#
The ARN of the IAM role to associate with this volume.
notes

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 .

sizeInGiBnumbersize_in_gi_bint | floatsizeInGiBNumberSizeInGiBdoubleSizeInGiB*float64#
The size of the volume in GiB.
notes

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
snapshotIdstringsnapshot_idstrsnapshotIdStringSnapshotIdstringSnapshotId*string#
The snapshot that Amazon ECS uses to create volumes for attachment to tasks maintained by the service.
notes

You must specify either snapshotId or sizeInGiB in your volume configuration. This parameter maps 1:1 with the SnapshotId parameter of the CreateVolume API in the Amazon EC2 API Reference .

tagSpecificationsIResolvable | IResolvable | CfnService.EBSTagSpecificationProperty[]tag_specificationstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, EBSTagSpecificationProperty]]]tagSpecificationsIResolvableTagSpecificationsIResolvableTagSpecificationsinterface{}#
The tags to apply to the volume.
notes

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 .

throughputnumberthroughputint | floatthroughputNumberThroughputdoubleThroughput*float64#
The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s.
notes

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.

volumeInitializationRatenumbervolume_initialization_rateint | floatvolumeInitializationRateNumberVolumeInitializationRatedoubleVolumeInitializationRate*float64#
The rate, in MiB/s, at which data is fetched from a snapshot of an existing EBS volume to create new volumes for attachment to the tasks maintained by the service.

This property can be specified only if you specify a snapshotId . For more information, see Initialize Amazon EBS volumes in the Amazon EBS User Guide .

volumeTypestringvolume_typestrvolumeTypeStringVolumeTypestringVolumeType*string#
The volume type.
notes

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.