FargateServiceTaskDefinition class

Create a TaskDefinition resource with the given unique name, arguments, and options. Creates required log-group and task & execution roles. Presents required Service load balancers if target group included in port mappings.

Constructors

FargateServiceTaskDefinition({Input<TaskDefinitionContainerDefinition?>? container, Input<Map<String, TaskDefinitionContainerDefinition>?>? containers, Input<String?>? cpu, Input<bool?>? enableFaultInjection, Input<TaskDefinitionEphemeralStorage?>? ephemeralStorage, Input<DefaultRoleWithPolicy?>? executionRole, Input<String?>? family, Input<String?>? ipcMode, Input<DefaultLogGroup?>? logGroup, Input<String?>? memory, Input<String?>? pidMode, Input<List<TaskDefinitionPlacementConstraint>?>? placementConstraints, Input<TaskDefinitionProxyConfiguration?>? proxyConfiguration, Input<String?>? region, Input<TaskDefinitionRuntimePlatform?>? runtimePlatform, Input<bool?>? skipDestroy, Input<Map<String, String>?>? tags, Input<DefaultRoleWithPolicy?>? taskRole, Input<bool?>? trackLatest, Input<List<TaskDefinitionVolume>?>? volumes})
Creates a new FargateServiceTaskDefinition. container Single container to make a TaskDefinition from. Useful for simple cases where there aren't containers All the containers to make a TaskDefinition from. Useful when creating a Service that will cpu The number of cpu units used by the task. If not provided, a default will be computed based on the cumulative needs specified by containerDefinitions enableFaultInjection Enables fault injection and allows for fault injection requests to be accepted from the task's containers. Default is false. ephemeralStorage Amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate. See Ephemeral Storage. executionRole The execution role that the Amazon ECS container agent and the Docker daemon can assume. family An optional unique name for your task definition. If not specified, then a default will be created. ipcMode IPC resource namespace to be used for the containers in the task. Valid values: host, task, none. logGroup A set of volume blocks that containers in your task may use. memory The amount (in MiB) of memory used by the task. If not provided, a default will be computed pidMode Process namespace to use for the containers in the task. Valid values: host, task. [placementConstraints] Configuration block for rules that are taken into consideration during task placement. Maximum number of placementConstraintsis10. Detailed below. [proxyConfiguration] Configuration block for the App Mesh proxy. Detailed below. [region] Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. [runtimePlatform] Configuration block for runtimePlatform that containers in your task may use. [skipDestroy] Whether to retain the old revision when the resource is destroyed or replacement is necessary. Default is false. [tags] Key-value map of resource tags. If configured with a provider defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. [taskRole] IAM role that allows your Amazon ECS container task to make calls to other AWS services. [trackLatest] Whether should track latestACTIVEtask definition on AWS or the one created with the resource stored in state. Default isfalse`. Useful in the event the task definition is modified outside of this resource. volumes Repeatable configuration block for volumes that containers in your task may use. Detailed below.
const
FargateServiceTaskDefinition.fromMap(Map<String, dynamic> map)
factory

Properties

container → Input<TaskDefinitionContainerDefinition?>?
Single container to make a TaskDefinition from. Useful for simple cases where there aren't multiple containers, especially when creating a TaskDefinition to call run on.
final
containers → Input<Map<String, TaskDefinitionContainerDefinition>?>?
All the containers to make a TaskDefinition from. Useful when creating a Service that will contain many containers within.
final
cpu → Input<String?>?
The number of cpu units used by the task. If not provided, a default will be computed based on the cumulative needs specified by containerDefinitions
final
enableFaultInjection → Input<bool?>?
Enables fault injection and allows for fault injection requests to be accepted from the task's containers. Default is false.
final
ephemeralStorage → Input<TaskDefinitionEphemeralStorage?>?
Amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate. See Ephemeral Storage.
final
executionRole → Input<DefaultRoleWithPolicy?>?
The execution role that the Amazon ECS container agent and the Docker daemon can assume. Will be created automatically if not defined.
final
family → Input<String?>?
An optional unique name for your task definition. If not specified, then a default will be created.
final
hashCode → int
The hash code for this object.
no setterinherited
ipcMode → Input<String?>?
IPC resource namespace to be used for the containers in the task. Valid values: host, task, none.
final
logGroup → Input<DefaultLogGroup?>?
A set of volume blocks that containers in your task may use.
final
memory → Input<String?>?
The amount (in MiB) of memory used by the task. If not provided, a default will be computed based on the cumulative needs specified by containerDefinitions
final
pidMode → Input<String?>?
Process namespace to use for the containers in the task. Valid values: host, task`.
final
placementConstraints → Input<List<TaskDefinitionPlacementConstraint>?>?
Configuration block for rules that are taken into consideration during task placement. Maximum number of placementConstraints is 10. Detailed below.
final
proxyConfiguration → Input<TaskDefinitionProxyConfiguration?>?
Configuration block for the App Mesh proxy. Detailed below.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimePlatform → Input<TaskDefinitionRuntimePlatform?>?
Configuration block for runtimePlatform that containers in your task may use.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
skipDestroy → Input<bool?>?
Whether to retain the old revision when the resource is destroyed or replacement is necessary. Default is false.
final
tags → Input<Map<String, String>?>?
Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
taskRole → Input<DefaultRoleWithPolicy?>?
IAM role that allows your Amazon ECS container task to make calls to other AWS services. Will be created automatically if not defined.
final
trackLatest → Input<bool?>?
Whether should track latest ACTIVE task definition on AWS or the one created with the resource stored in state. Default is false. Useful in the event the task definition is modified outside of this resource.
final
volumes → Input<List<TaskDefinitionVolume>?>?
Repeatable configuration block for volumes that containers in your task may use. Detailed below.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited