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.
Inheritance Hierarchy
Namespace: Amazon.ECS.Model
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z
Syntax
public class TaskManagedEBSVolumeConfiguration
The TaskManagedEBSVolumeConfiguration type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
TaskManagedEBSVolumeConfiguration() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Encrypted | System.Boolean |
Gets and sets the property Encrypted.
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 |
|
|
FilesystemType | Amazon.ECS.TaskFilesystemType |
Gets and sets the property FilesystemType. 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
|
|
|
Iops | System.Int32 |
Gets and sets the property Iops.
The number of I/O operations per second (IOPS). For The following are the supported values for each volume type.
This parameter is required for
This parameter maps 1:1 with the |
|
|
KmsKeyId | System.String |
Gets and sets the property KmsKeyId.
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management
Service key to use for Amazon EBS encryption. When encryption is turned on and no
Amazon Web Services Key Management Service key is specified, the default Amazon Web
Services managed key for Amazon EBS volumes is used. This parameter maps 1:1 with
the Amazon Web Services authenticates the Amazon Web Services 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. |
|
|
RoleArn | System.String |
Gets and sets the property RoleArn.
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 Amazon Web Services infrastructure. We recommend
using the Amazon ECS-managed |
|
|
SizeInGiB | System.Int32 |
Gets and sets the property SizeInGiB.
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 The following are the supported volume size values for each volume type.
|
|
|
SnapshotId | System.String |
Gets and sets the property SnapshotId.
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 |
|
|
TagSpecifications | System.Collections.Generic.List<Amazon.ECS.Model.EBSTagSpecification> |
Gets and sets the property TagSpecifications.
The tags to apply to the volume. Amazon ECS applies service-managed tags by default.
This parameter maps 1:1 with the |
|
|
TerminationPolicy | Amazon.ECS.Model.TaskManagedEBSVolumeTerminationPolicy |
Gets and sets the property TerminationPolicy. The termination policy for the volume when the task exits. This provides a way to control whether Amazon ECS terminates the Amazon EBS volume when the task stops. |
|
|
Throughput | System.Int32 |
Gets and sets the property Throughput.
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
This parameter is only supported for the |
|
|
VolumeType | System.String |
Gets and sets the property VolumeType.
The volume type. This parameter maps 1:1 with the The following are the supported volume types.
|
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5