Interface CfnService.ServiceManagedEBSVolumeConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnService.ServiceManagedEBSVolumeConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnService
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.
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)
.volumeInitializationRate(123)
.volumeType("volumeType")
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnService.ServiceManagedEBSVolumeConfigurationPropertystatic final classAn implementation forCfnService.ServiceManagedEBSVolumeConfigurationProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectIndicates whether the volume should be encrypted.default StringThe filesystem type for the volume.default NumbergetIops()The number of I/O operations per second (IOPS).default StringThe Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption.The ARN of the IAM role to associate with this volume.default NumberThe size of the volume in GiB.default StringThe snapshot that Amazon ECS uses to create volumes for attachment to tasks maintained by the service.default ObjectThe tags to apply to the volume.default NumberThe throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s.default NumberThe 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.default StringThe volume type.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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
AmazonECSInfrastructureRolePolicyForVolumesIAM policy with this role. For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide .- See Also:
-
getEncrypted
Indicates whether the volume should be encrypted.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 theEncryptedparameter of the CreateVolume API in the Amazon EC2 API Reference .Returns union: either
BooleanorIResolvable- See Also:
-
getFilesystemType
The 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 tasks will fail to start.
The available Linux filesystem types are
ext3,ext4, andxfs. If no value is specified, thexfsfilesystem type is used by default.The available Windows filesystem types are
NTFS.- See Also:
-
getIops
The number of I/O operations per second (IOPS).For
gp3,io1, andio2volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2volumes, 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 IOPSio1: 100 - 64,000 IOPSio2: 100 - 256,000 IOPS
This parameter is required for
io1andio2volume types. The default forgp3volumes is3,000 IOPS. This parameter is not supported forst1,sc1, orstandardvolume types.This parameter maps 1:1 with the
Iopsparameter of the CreateVolume API in the Amazon EC2 API Reference .- See Also:
-
getKmsKeyId
The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption.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
KmsKeyIdparameter 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.
- See Also:
-
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
Sizeparameter of the CreateVolume API in the Amazon EC2 API Reference .The following are the supported volume size values for each volume type.
gp2andgp3: 1-16,384io1andio2: 4-16,384st1andsc1: 125-16,384standard: 1-1,024
- See Also:
-
getSnapshotId
The snapshot that Amazon ECS uses to create volumes for attachment to tasks maintained by the service.You must specify either
snapshotIdorsizeInGiBin your volume configuration. This parameter maps 1:1 with theSnapshotIdparameter of the CreateVolume API in the Amazon EC2 API Reference .- See Also:
-
getTagSpecifications
The tags to apply to the volume.Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the
TagSpecifications.Nparameter of the CreateVolume API in the Amazon EC2 API Reference .Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnService.EBSTagSpecificationProperty>- See Also:
-
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
Throughputparameter of the CreateVolume API in the Amazon EC2 API Reference .This parameter is only supported for the
gp3volume type.- See Also:
-
getVolumeInitializationRate
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 .- See Also:
-
getVolumeType
The volume type.This parameter maps 1:1 with the
VolumeTypeparameter 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:
- General Purpose SSD:
-
builder
-