Class: Aws::ECS::Types::TaskManagedEBSVolumeConfiguration

Inherits:

Struct

Object
Struct
Aws::ECS::Types::TaskManagedEBSVolumeConfiguration

show all

Includes:: Structure

Defined in:: 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.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#encrypted ⇒ Boolean

Indicates whether the volume should be encrypted.
#filesystem_type ⇒ String

The Linux 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.
#termination_policy ⇒ Types::TaskManagedEBSVolumeTerminationPolicy

The termination policy for the volume when the task exits.
#throughput ⇒ Integer

The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s.
#volume_initialization_rate ⇒ Integer

The rate, in MiB/s, at which data is fetched from a snapshot of an existing Amazon EBS volume to create a new volume for attachment to the task.
#volume_type ⇒ String

The volume type.

Instance Attribute Details

#encrypted ⇒ `Boolean`

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 the `Encrypted` parameter of the

CreateVolume API][1: in the *Amazon EC2 API Reference*.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html

Returns:

(Boolean)

# File 'lib/aws-sdk-ecs/types.rb', line 15172

class TaskManagedEBSVolumeConfiguration < Struct.new(
  :encrypted,
  :kms_key_id,
  :volume_type,
  :size_in_gi_b,
  :snapshot_id,
  :volume_initialization_rate,
  :iops,
  :throughput,
  :tag_specifications,
  :role_arn,
  :termination_policy,
  :filesystem_type)
  SENSITIVE = []
  include Aws::Structure
end

#filesystem_type ⇒ `String`

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  ‘ext3`, `ext4`, and `xfs`. If no value is specified, the `xfs` filesystem type is used by default.

Returns:

(String)

# File 'lib/aws-sdk-ecs/types.rb', line 15172

class TaskManagedEBSVolumeConfiguration < Struct.new(
  :encrypted,
  :kms_key_id,
  :volume_type,
  :size_in_gi_b,
  :snapshot_id,
  :volume_initialization_rate,
  :iops,
  :throughput,
  :tag_specifications,
  :role_arn,
  :termination_policy,
  :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 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][1: in the *Amazon EC2 API Reference*.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html

Returns:

(Integer)

# File 'lib/aws-sdk-ecs/types.rb', line 15172

class TaskManagedEBSVolumeConfiguration < Struct.new(
  :encrypted,
  :kms_key_id,
  :volume_type,
  :size_in_gi_b,
  :snapshot_id,
  :volume_initialization_rate,
  :iops,
  :throughput,
  :tag_specifications,
  :role_arn,
  :termination_policy,
  :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 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 a task, see [Encrypt data stored in Amazon EBS volumes attached to Amazon ECS tasks].

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.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html [2]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-kms-encryption.html

Returns:

(String)

# File 'lib/aws-sdk-ecs/types.rb', line 15172

class TaskManagedEBSVolumeConfiguration < Struct.new(
  :encrypted,
  :kms_key_id,
  :volume_type,
  :size_in_gi_b,
  :snapshot_id,
  :volume_initialization_rate,
  :iops,
  :throughput,
  :tag_specifications,
  :role_arn,
  :termination_policy,
  :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*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html

Returns:

(String)

# File 'lib/aws-sdk-ecs/types.rb', line 15172

class TaskManagedEBSVolumeConfiguration < Struct.new(
  :encrypted,
  :kms_key_id,
  :volume_type,
  :size_in_gi_b,
  :snapshot_id,
  :volume_initialization_rate,
  :iops,
  :throughput,
  :tag_specifications,
  :role_arn,
  :termination_policy,
  :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` and `gp3`: 1-16,384
‘io1` and `io2`: 4-16,384
‘st1` and `sc1`: 125-16,384
‘standard`: 1-1,024

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html

Returns:

(Integer)

# File 'lib/aws-sdk-ecs/types.rb', line 15172

class TaskManagedEBSVolumeConfiguration < Struct.new(
  :encrypted,
  :kms_key_id,
  :volume_type,
  :size_in_gi_b,
  :snapshot_id,
  :volume_initialization_rate,
  :iops,
  :throughput,
  :tag_specifications,
  :role_arn,
  :termination_policy,
  :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*.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html

Returns:

(String)

# File 'lib/aws-sdk-ecs/types.rb', line 15172

class TaskManagedEBSVolumeConfiguration < Struct.new(
  :encrypted,
  :kms_key_id,
  :volume_type,
  :size_in_gi_b,
  :snapshot_id,
  :volume_initialization_rate,
  :iops,
  :throughput,
  :tag_specifications,
  :role_arn,
  :termination_policy,
  :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*.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html

Returns:

(Array<Types::EBSTagSpecification>)

# File 'lib/aws-sdk-ecs/types.rb', line 15172

class TaskManagedEBSVolumeConfiguration < Struct.new(
  :encrypted,
  :kms_key_id,
  :volume_type,
  :size_in_gi_b,
  :snapshot_id,
  :volume_initialization_rate,
  :iops,
  :throughput,
  :tag_specifications,
  :role_arn,
  :termination_policy,
  :filesystem_type)
  SENSITIVE = []
  include Aws::Structure
end

#termination_policy ⇒ `Types::TaskManagedEBSVolumeTerminationPolicy`

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.

Returns:

(Types::TaskManagedEBSVolumeTerminationPolicy)

# File 'lib/aws-sdk-ecs/types.rb', line 15172

class TaskManagedEBSVolumeConfiguration < Struct.new(
  :encrypted,
  :kms_key_id,
  :volume_type,
  :size_in_gi_b,
  :snapshot_id,
  :volume_initialization_rate,
  :iops,
  :throughput,
  :tag_specifications,
  :role_arn,
  :termination_policy,
  :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.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html

Returns:

(Integer)

# File 'lib/aws-sdk-ecs/types.rb', line 15172

class TaskManagedEBSVolumeConfiguration < Struct.new(
  :encrypted,
  :kms_key_id,
  :volume_type,
  :size_in_gi_b,
  :snapshot_id,
  :volume_initialization_rate,
  :iops,
  :throughput,
  :tag_specifications,
  :role_arn,
  :termination_policy,
  :filesystem_type)
  SENSITIVE = []
  include Aws::Structure
end

#volume_initialization_rate ⇒ `Integer`

The rate, in MiB/s, at which data is fetched from a snapshot of an existing Amazon EBS volume to create a new volume for attachment to the task. 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*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html

Returns:

(Integer)

# File 'lib/aws-sdk-ecs/types.rb', line 15172

class TaskManagedEBSVolumeConfiguration < Struct.new(
  :encrypted,
  :kms_key_id,
  :volume_type,
  :size_in_gi_b,
  :snapshot_id,
  :volume_initialization_rate,
  :iops,
  :throughput,
  :tag_specifications,
  :role_arn,
  :termination_policy,
  :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`

<note markdown=“1”> The magnetic volume type is not supported on Fargate.
```
</note>
```

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html

Returns:

(String)

# File 'lib/aws-sdk-ecs/types.rb', line 15172

class TaskManagedEBSVolumeConfiguration < Struct.new(
  :encrypted,
  :kms_key_id,
  :volume_type,
  :size_in_gi_b,
  :snapshot_id,
  :volume_initialization_rate,
  :iops,
  :throughput,
  :tag_specifications,
  :role_arn,
  :termination_policy,
  :filesystem_type)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::ECS::Types::TaskManagedEBSVolumeConfiguration

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#encrypted ⇒ Boolean

#filesystem_type ⇒ String

#iops ⇒ Integer

#kms_key_id ⇒ String

#role_arn ⇒ String

#size_in_gi_b ⇒ Integer

#snapshot_id ⇒ String

#tag_specifications ⇒ Array<Types::EBSTagSpecification>

#termination_policy ⇒ Types::TaskManagedEBSVolumeTerminationPolicy

#throughput ⇒ Integer

#volume_initialization_rate ⇒ Integer

#volume_type ⇒ String

#encrypted ⇒ `Boolean`

#filesystem_type ⇒ `String`

#iops ⇒ `Integer`

#kms_key_id ⇒ `String`

#role_arn ⇒ `String`

#size_in_gi_b ⇒ `Integer`

#snapshot_id ⇒ `String`

#tag_specifications ⇒ `Array<Types::EBSTagSpecification>`

#termination_policy ⇒ `Types::TaskManagedEBSVolumeTerminationPolicy`

#throughput ⇒ `Integer`

#volume_initialization_rate ⇒ `Integer`

#volume_type ⇒ `String`