EcsRunTaskProps¶
-
class
aws_cdk.aws_stepfunctions_tasks.
EcsRunTaskProps
(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, result_selector=None, timeout=None, cluster, launch_target, task_definition, assign_public_ip=None, container_overrides=None, security_groups=None, subnets=None)¶ Bases:
aws_cdk.aws_stepfunctions.TaskStateBaseProps
Properties for ECS Tasks.
- Parameters
comment (
Optional
[str
]) – An optional description for this state. Default: - No commentheartbeat (
Optional
[Duration
]) – Timeout for the heartbeat. Default: - Noneinput_path (
Optional
[str
]) – JSONPath expression to select part of the state to be the input to this state. May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}. Default: - The entire task input (JSON path ‘$’)integration_pattern (
Optional
[IntegrationPattern
]) – AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns Default: -IntegrationPattern.REQUEST_RESPONSE
for most tasks.IntegrationPattern.RUN_JOB
for the following exceptions:BatchSubmitJob
,EmrAddStep
,EmrCreateCluster
,EmrTerminationCluster
, andEmrContainersStartJobRun
.output_path (
Optional
[str
]) – JSONPath expression to select select a portion of the state output to pass to the next state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}. Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path ‘$’)result_path (
Optional
[str
]) – JSONPath expression to indicate where to inject the state’s output. May also be the special value JsonPath.DISCARD, which will cause the state’s input to become its output. Default: - Replaces the entire input with the result (JSON path ‘$’)result_selector (
Optional
[Mapping
[str
,Any
]]) – The JSON that will replace the state’s raw result and become the effective result before ResultPath is applied. You can use ResultSelector to create a payload with values that are static or selected from the state’s raw result. Default: - Nonetimeout (
Optional
[Duration
]) – Timeout for the state machine. Default: - Nonecluster (
ICluster
) – The ECS cluster to run the task on.launch_target (
IEcsLaunchTarget
) – An Amazon ECS launch type determines the type of infrastructure on which your tasks and services are hosted.task_definition (
TaskDefinition
) – [disable-awslint:ref-via-interface] Task Definition used for running tasks in the service. Note: this must be TaskDefinition, and not ITaskDefinition, as it requires properties that are not known for imported task definitionsassign_public_ip (
Optional
[bool
]) – Assign public IP addresses to each task. Default: falsecontainer_overrides (
Optional
[Sequence
[ContainerOverride
]]) – Container setting overrides. Specify the container to use and the overrides to apply. Default: - No overridessecurity_groups (
Optional
[Sequence
[ISecurityGroup
]]) – Existing security groups to use for the tasks. Default: - A new security group is createdsubnets (
Optional
[SubnetSelection
]) – Subnets to place the task’s ENIs. Default: - Public subnets if assignPublicIp is set. Private subnets otherwise.
- ExampleMetadata
infused
Example:
vpc = ec2.Vpc.from_lookup(self, "Vpc", is_default=True ) cluster = ecs.Cluster(self, "Ec2Cluster", vpc=vpc) cluster.add_capacity("DefaultAutoScalingGroup", instance_type=ec2.InstanceType("t2.micro"), vpc_subnets=ec2.SubnetSelection(subnet_type=ec2.SubnetType.PUBLIC) ) task_definition = ecs.TaskDefinition(self, "TD", compatibility=ecs.Compatibility.EC2 ) task_definition.add_container("TheContainer", image=ecs.ContainerImage.from_registry("foo/bar"), memory_limit_mi_b=256 ) run_task = tasks.EcsRunTask(self, "Run", integration_pattern=sfn.IntegrationPattern.RUN_JOB, cluster=cluster, task_definition=task_definition, launch_target=tasks.EcsEc2LaunchTarget( placement_strategies=[ ecs.PlacementStrategy.spread_across_instances(), ecs.PlacementStrategy.packed_by_cpu(), ecs.PlacementStrategy.randomly() ], placement_constraints=[ ecs.PlacementConstraint.member_of("blieptuut") ] ) )
Attributes
-
assign_public_ip
¶ Assign public IP addresses to each task.
- Default
false
- Return type
Optional
[bool
]
-
comment
¶ An optional description for this state.
- Default
No comment
- Return type
Optional
[str
]
-
container_overrides
¶ Container setting overrides.
Specify the container to use and the overrides to apply.
- Default
No overrides
- Return type
Optional
[List
[ContainerOverride
]]
-
input_path
¶ JSONPath expression to select part of the state to be the input to this state.
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
- Default
The entire task input (JSON path ‘$’)
- Return type
Optional
[str
]
-
integration_pattern
¶ AWS Step Functions integrates with services directly in the Amazon States Language.
You can control these AWS services using service integration patterns
- Default
IntegrationPattern.REQUEST_RESPONSE
for most tasks.
IntegrationPattern.RUN_JOB
for the following exceptions:BatchSubmitJob
,EmrAddStep
,EmrCreateCluster
,EmrTerminationCluster
, andEmrContainersStartJobRun
.
-
launch_target
¶ An Amazon ECS launch type determines the type of infrastructure on which your tasks and services are hosted.
-
output_path
¶ JSONPath expression to select select a portion of the state output to pass to the next state.
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
- Default
The entire JSON node determined by the state input, the task result,
and resultPath is passed to the next state (JSON path ‘$’)
- Return type
Optional
[str
]
-
result_path
¶ JSONPath expression to indicate where to inject the state’s output.
May also be the special value JsonPath.DISCARD, which will cause the state’s input to become its output.
- Default
Replaces the entire input with the result (JSON path ‘$’)
- Return type
Optional
[str
]
-
result_selector
¶ The JSON that will replace the state’s raw result and become the effective result before ResultPath is applied.
You can use ResultSelector to create a payload with values that are static or selected from the state’s raw result.
- Default
None
- See
- Return type
Optional
[Mapping
[str
,Any
]]
-
security_groups
¶ Existing security groups to use for the tasks.
- Default
A new security group is created
- Return type
Optional
[List
[ISecurityGroup
]]
-
subnets
¶ Subnets to place the task’s ENIs.
- Default
Public subnets if assignPublicIp is set. Private subnets otherwise.
- Return type
Optional
[SubnetSelection
]
-
task_definition
¶ ref-via-interface] Task Definition used for running tasks in the service.
Note: this must be TaskDefinition, and not ITaskDefinition, as it requires properties that are not known for imported task definitions
- Type
[disable-awslint
- Return type