The volume configuration used for creating Amazon EBS volumes that are attached to tasks that are maintained by a service when the service is created or updated. One volume is attached per task.
encrypted
Type: Boolean
Required: No
Valid values: true
|false
Specifies whether to encrypt each created Amazon EBS volume. If you've turned on Amazon EBS encryption by default for a particular AWS Region for your AWS account but set this parameter to false
, this parameter will be overridden, and the volumes will be encrypted with the KMS key specified for encryption by default. For more information about Amazon EBS encryption by default, see Enable Amazon EBS encryption by default in the Amazon EBS User Guide. For more information about encrypting Amazon EBS volumes attached to Amazon ECS tasks, see Encrypt data stored in Amazon EBS volumes attached to Amazon ECS tasks.
kmsKeyId
Type: String
Required: No
The identifier of the AWS Key Management Service (AWS KMS) key to use for Amazon EBS encryption. If kmsKeyId
is specified, the encrypted state must be true
.
The key specified using this parameter overrides the Amazon EBS default or any cluster-level KMS key for Amazon ECS managed storage encryption that you may have specified. For more information, see Encrypt data stored in Amazon EBS volumes attached to Amazon ECS tasks.
You can specify the KMS key by using any of the following:
Key ID â For example, 1234abcd-12ab-34cd-56ef-1234567890ab
.
Key alias â For example, alias/ExampleAlias
.
Key ARN â For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab
.
Alias ARN â For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias
.
AWS authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that isn't valid, the action can appear to succeed, but it eventually fails. For more information, see Troubleshooting Amazon EBS volume attachment issues.
volumeType
Type: String
Required: No
Valid values: gp2
|gp3
|io1
|io2
|sc1
|st1
|standard
The Amazon EBS volume type. For more information about volume types, see Amazon EBS volume types in the Amazon EBS User Guide. The default volume type is gp3
.
The standard
volume type is not supported for Fargate tasks.
sizeInGiB
Type: Integer
Required: No
Valid range: Integers between 1 and 16,384
The size of the EBS volume in gibibytes (GiB). If you do not provide a snapshot ID to configure a volume for attachment, you must provide a size value. If you configure a volume for attachment by using a snapshot, the default value is the snapshot size. You can then specify a size greater than or equal to the snapshot size.
For gp2
and gp3
volume types, the valid range is 1-16,384.
For io1
and io2
volume types, the valid range is 4-16,384.
For st1
and sc1
volume types, the valid range is 125-16,384.
For the standard
volume type, the valid range is 1-1,024.
snapshotId
Type: String
Required: No
The ID of the snapshot of an existing Amazon EBS volume that Amazon ECS uses to create new volumes for attachment. You must specify either a snapshotId
or a sizeInGiB
.
volumeInitializationRate
Type: Integer
Required: No
The rate, in MiB/s, at which data is fetched from a snapshot of an existing Amazon EBS volume to create new volumes for attachment. This property can be specified only if you specify a snapshotId
. For more information about this volume initialization rate, including the range of supported rates for initialization, see Initialize Amazon EBS volumes in the Amazon EBS User Guide.
iops
Type: Integer
Required: No
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 value represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. This parameter is required for io1
and io2
volumes. This parameter is not supported for gp2
, st1
,sc1
, or standard
volumes.
For gp3
volumes, the valid range of values is 3,000 to 16,000.
For io1
volumes, the valid range of values is 100 to 64,000.
For io2
volumes, the valid range of values is 100 to 64,000.
throughput
Type: Integer
Required: No
The throughput to provision for the volumes that are attached to tasks that are maintained by a service.
ImportantThis parameter is supported only for gp3
volumes.
roleArn
Type: String
Required: Yes
The Amazon Resource ARN (ARN) of the infrastructure AWS Identity and Access Management (IAM) role that provides Amazon ECS permissions to manage Amazon EBS resources for your tasks. For more information, see Amazon ECS infrastructure IAM role.
tagSpecifications
Type: Object
Required: No
The specification for tags to be applied to each Amazon EBS volume.
resourceType
Type: String
Required: Yes
Valid values: volume
The type of resource to tag on creation.
tags
Type: Array of objects
Required: No
The metadata that you apply to volumes to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. AmazonECSCreated
and AmazonECSManaged
are reserved tags that are added by Amazon ECS on your behalf, so you can specify a maximum of 48 tags of your own. When a volume is deleted, the tags are deleted as well. For more information, see Tagging Amazon ECS resources.
key
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
value
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
propagateTags
Type: String
Valid values: TASK_DEFINITION
| SERVICE
| NONE
Required: No
Specifies whether to copy the tags from the task definition or the service to a volume. If NONE
is specified or no value is specified, the tags aren't copied.
fileSystemType
Type: String
Required: No
Valid values: xfs
|ext3
|ext4
|NTFS
The type of file system on a volume. The volume's file system type determines how data is stored and retrieved in 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 valid values for Linux are xfs
, ext3, and ext4
. The default for volumes that are attached to Linux tasks is XFS
.
The valid values for Windows are NTFS
. The default for volumes that are attached to Windows tasks is NTFS
.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4