EcsTaskProps¶
-
class
aws_cdk.aws_events_targets.
EcsTaskProps
(*, cluster, task_definition, container_overrides=None, platform_version=None, role=None, security_group=None, security_groups=None, subnet_selection=None, task_count=None)¶ Bases:
object
Properties to define an ECS Event Task.
- Parameters
cluster (
ICluster
) – Cluster where service will be deployed.task_definition (
ITaskDefinition
) – Task Definition of the task that should be started.container_overrides (
Optional
[Sequence
[ContainerOverride
]]) – Container setting overrides. Key is the name of the container to override, value is the values you want to override.platform_version (
Optional
[FargatePlatformVersion
]) – The platform version on which to run your task. Unless you have specific compatibility requirements, you don’t need to specify this. Default: - ECS will set the Fargate platform version to ‘LATEST’role (
Optional
[IRole
]) – Existing IAM role to run the ECS task. Default: A new IAM role is createdsecurity_group (
Optional
[ISecurityGroup
]) – (deprecated) Existing security group to use for the task’s ENIs. (Only applicable in case the TaskDefinition is configured for AwsVpc networking) Default: A new security group is createdsecurity_groups (
Optional
[Sequence
[ISecurityGroup
]]) – Existing security groups to use for the task’s ENIs. (Only applicable in case the TaskDefinition is configured for AwsVpc networking) Default: A new security group is createdsubnet_selection (
Optional
[SubnetSelection
]) – In what subnets to place the task’s ENIs. (Only applicable in case the TaskDefinition is configured for AwsVpc networking) Default: Private subnetstask_count (
Union
[int
,float
,None
]) – How many tasks should be started when this event is triggered. Default: 1
Attributes
-
container_overrides
¶ Container setting overrides.
Key is the name of the container to override, value is the values you want to override.
- Return type
Optional
[List
[ContainerOverride
]]
-
platform_version
¶ The platform version on which to run your task.
Unless you have specific compatibility requirements, you don’t need to specify this.
- Default
ECS will set the Fargate platform version to ‘LATEST’
- See
https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
- Return type
Optional
[FargatePlatformVersion
]
-
role
¶ Existing IAM role to run the ECS task.
- Default
A new IAM role is created
- Return type
Optional
[IRole
]
-
security_group
¶ (deprecated) Existing security group to use for the task’s ENIs.
(Only applicable in case the TaskDefinition is configured for AwsVpc networking)
- Default
A new security group is created
- Deprecated
use securityGroups instead
- Stability
deprecated
- Return type
Optional
[ISecurityGroup
]
-
security_groups
¶ Existing security groups to use for the task’s ENIs.
(Only applicable in case the TaskDefinition is configured for AwsVpc networking)
- Default
A new security group is created
- Return type
Optional
[List
[ISecurityGroup
]]
-
subnet_selection
¶ In what subnets to place the task’s ENIs.
(Only applicable in case the TaskDefinition is configured for AwsVpc networking)
- Default
Private subnets
- Return type
Optional
[SubnetSelection
]
-
task_count
¶ How many tasks should be started when this event is triggered.
- Default
1
- Return type
Union
[int
,float
,None
]
-
task_definition
¶ Task Definition of the task that should be started.
- Return type