Class: Aws::ECS::Types::ServiceManagedEBSVolumeConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::ECS::Types::ServiceManagedEBSVolumeConfiguration
- Defined in:
- gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb
Overview
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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#encrypted ⇒ Boolean
Indicates whether the volume should be encrypted.
-
#filesystem_type ⇒ String
The filesystem type for the volume.
-
#iops ⇒ Integer
The number of I/O operations per second (IOPS).
-
#kms_key_id ⇒ String
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption.
-
#role_arn ⇒ String
The ARN of the IAM role to associate with this volume.
-
#size_in_gi_b ⇒ Integer
The size of the volume in GiB.
-
#snapshot_id ⇒ String
The snapshot that Amazon ECS uses to create the volume.
-
#tag_specifications ⇒ Array<Types::EBSTagSpecification>
The tags to apply to the volume.
-
#throughput ⇒ Integer
The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s.
-
#volume_type ⇒ String
The volume type.
Instance Attribute Details
#encrypted ⇒ Boolean
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.
10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 10459 class ServiceManagedEBSVolumeConfiguration < Struct.new( :encrypted, :kms_key_id, :volume_type, :size_in_gi_b, :snapshot_id, :iops, :throughput, :tag_specifications, :role_arn, :filesystem_type) SENSITIVE = [] include Aws::Structure end |
#filesystem_type ⇒ String
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 task 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
.
10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 10459 class ServiceManagedEBSVolumeConfiguration < Struct.new( :encrypted, :kms_key_id, :volume_type, :size_in_gi_b, :snapshot_id, :iops, :throughput, :tag_specifications, :role_arn, :filesystem_type) SENSITIVE = [] include Aws::Structure end |
#iops ⇒ Integer
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 IOPSio1
: 100 - 64,000 IOPSio2
: 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.
10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 10459 class ServiceManagedEBSVolumeConfiguration < Struct.new( :encrypted, :kms_key_id, :volume_type, :size_in_gi_b, :snapshot_id, :iops, :throughput, :tag_specifications, :role_arn, :filesystem_type) SENSITIVE = [] include Aws::Structure end |
#kms_key_id ⇒ String
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
KmsKeyId
parameter of the CreateVolume API in the Amazon EC2
API Reference.
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.
10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 10459 class ServiceManagedEBSVolumeConfiguration < Struct.new( :encrypted, :kms_key_id, :volume_type, :size_in_gi_b, :snapshot_id, :iops, :throughput, :tag_specifications, :role_arn, :filesystem_type) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
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 AmazonECSInfrastructureRolePolicyForVolumes
IAM policy
with this role. For more information, see Amazon ECS infrastructure
IAM role in the Amazon ECS Developer Guide.
10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 10459 class ServiceManagedEBSVolumeConfiguration < Struct.new( :encrypted, :kms_key_id, :volume_type, :size_in_gi_b, :snapshot_id, :iops, :throughput, :tag_specifications, :role_arn, :filesystem_type) SENSITIVE = [] include Aws::Structure end |
#size_in_gi_b ⇒ Integer
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
andgp3
: 1-16,384io1
andio2
: 4-16,384st1
andsc1
: 125-16,384standard
: 1-1,024
10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 10459 class ServiceManagedEBSVolumeConfiguration < Struct.new( :encrypted, :kms_key_id, :volume_type, :size_in_gi_b, :snapshot_id, :iops, :throughput, :tag_specifications, :role_arn, :filesystem_type) SENSITIVE = [] include Aws::Structure end |
#snapshot_id ⇒ String
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.
10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 10459 class ServiceManagedEBSVolumeConfiguration < Struct.new( :encrypted, :kms_key_id, :volume_type, :size_in_gi_b, :snapshot_id, :iops, :throughput, :tag_specifications, :role_arn, :filesystem_type) SENSITIVE = [] include Aws::Structure end |
#tag_specifications ⇒ Array<Types::EBSTagSpecification>
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.
10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 10459 class ServiceManagedEBSVolumeConfiguration < Struct.new( :encrypted, :kms_key_id, :volume_type, :size_in_gi_b, :snapshot_id, :iops, :throughput, :tag_specifications, :role_arn, :filesystem_type) SENSITIVE = [] include Aws::Structure end |
#throughput ⇒ Integer
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.
10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 10459 class ServiceManagedEBSVolumeConfiguration < Struct.new( :encrypted, :kms_key_id, :volume_type, :size_in_gi_b, :snapshot_id, :iops, :throughput, :tag_specifications, :role_arn, :filesystem_type) SENSITIVE = [] include Aws::Structure end |
#volume_type ⇒ String
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.
10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 10459 class ServiceManagedEBSVolumeConfiguration < Struct.new( :encrypted, :kms_key_id, :volume_type, :size_in_gi_b, :snapshot_id, :iops, :throughput, :tag_specifications, :role_arn, :filesystem_type) SENSITIVE = [] include Aws::Structure end |