TaskDefinitionArgs class
The set of arguments for TaskDefinition. The set of arguments for TaskDefinition.
Constructors
-
TaskDefinitionArgs({required Input<
String> containerDefinitions, Input<String?> ? cpu, Input<bool?> ? enableFaultInjection, Input<TaskDefinitionEphemeralStorage?> ? ephemeralStorage, Input<String?> ? executionRoleArn, required Input<String> family, Input<String?> ? ipcMode, Input<String?> ? memory, Input<String?> ? networkMode, Input<String?> ? pidMode, Input<List< ? placementConstraints, Input<TaskDefinitionPlacementConstraint> ?>TaskDefinitionProxyConfiguration?> ? proxyConfiguration, Input<String?> ? region, Input<List< ? requiresCompatibilities, Input<String> ?>TaskDefinitionRuntimePlatform?> ? runtimePlatform, Input<bool?> ? skipDestroy, Input<Map< ? tags, Input<String, String> ?>String?> ? taskRoleArn, Input<bool?> ? trackLatest, Input<List< ? volumes})TaskDefinitionVolume> ?> -
Creates a new TaskDefinitionArgs.
containerDefinitionsList of valid container definitions provided as a single valid JSON document. Please note that you should only provide values that are part of the container definition document. For a detailed description of what parameters are available, see the Task Definition Parameters section from the official Developer Guide.cpuNumber of cpu units used by the task. If therequiresCompatibilitiesisFARGATEthis field is required.enableFaultInjectionEnables fault injection and allows for fault injection requests to be accepted from the task's containers. Default isfalse.ephemeralStorageAmount 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.executionRoleArnARN of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.familyUnique name for your task definition.ipcModeIPC resource namespace to be used for the containers in the task. Valid values:host,task,none.memoryAmount (in MiB) of memory used by the task. If therequiresCompatibilitiesisFARGATEthis field is required.networkModeDocker networking mode to use for the containers in the task. Valid values:awsvpc,bridge,host, andnone.pidModeProcess 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 ofplacementConstraintsis10. 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. [requiresCompatibilities] Set of launch types required by the task. Valid values:EC2,EXTERNAL,FARGATE,MANAGED_INSTANCES. [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 isfalse. [tags] Key-value map of resource tags. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. [taskRoleArn] ARN of 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.volumesRepeatable configuration block for volumes that containers in your task may use. Detailed below.const -
TaskDefinitionArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
containerDefinitions
→ Input<
String> -
List of valid container definitions provided as a single valid JSON document. Please note that you should only provide values that are part of the container definition document. For a detailed description of what parameters are available, see the Task Definition Parameters section from the official Developer Guide.
final
-
cpu
→ Input<
String?> ? -
Number of cpu units used by the task. If the
requiresCompatibilitiesisFARGATEthis field is required.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
-
executionRoleArn
→ Input<
String?> ? -
ARN of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
final
-
family
→ Input<
String> -
Unique name for your task definition.
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 -
memory
→ Input<
String?> ? -
Amount (in MiB) of memory used by the task. If the
requiresCompatibilitiesisFARGATEthis field is required.final -
networkMode
→ Input<
String?> ? -
Docker networking mode to use for the containers in the task. Valid values:
awsvpc,bridge,host, andnone.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
placementConstraintsis10. 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
-
requiresCompatibilities
→ Input<
List< ?String> ?> -
Set of launch types required by the task. Valid values:
EC2,EXTERNAL,FARGATE,MANAGED_INSTANCES.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 -
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.final -
taskRoleArn
→ Input<
String?> ? -
ARN of IAM role that allows your Amazon ECS container task to make calls to other AWS services.
final
-
trackLatest
→ Input<
bool?> ? -
Whether should track latest
ACTIVEtask 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.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