Package software.amazon.awscdk.services.stepfunctions.tasks

Class EcsRunTask.Builder

java.lang.Object
software.amazon.awscdk.services.stepfunctions.tasks.EcsRunTask.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<EcsRunTask>
Enclosing class:
EcsRunTask
@Stability(Stable) public static final class EcsRunTask.Builder extends Object implements software.amazon.jsii.Builder<EcsRunTask>
A fluent builder for EcsRunTask.

  • Method Details

    • create

      @Stability(Stable) public static EcsRunTask.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - Descriptive identifier for this chainable. This parameter is required.
      Returns:
      a new instance of EcsRunTask.Builder.

    • comment

      @Stability(Stable) public EcsRunTask.Builder comment(String comment)
      An optional description for this state.

      Default: - No comment

      Parameters:
      comment - An optional description for this state. This parameter is required.
      Returns:
      this

    • credentials

      @Stability(Stable) public EcsRunTask.Builder credentials(Credentials credentials)
      Credentials for an IAM Role that the State Machine assumes for executing the task.

      This enables cross-account resource invocations.

      Default: - None (Task is executed using the State Machine's execution role)

      Parameters:
      credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This parameter is required.
      Returns:
      this
      See Also:

    • heartbeat

      @Stability(Deprecated) @Deprecated public EcsRunTask.Builder heartbeat(Duration heartbeat)
      Deprecated.
      use heartbeatTimeout
      (deprecated) Timeout for the heartbeat.

      Default: - None

      Parameters:
      heartbeat - Timeout for the heartbeat. This parameter is required.
      Returns:
      this

    • heartbeatTimeout

      @Stability(Stable) public EcsRunTask.Builder heartbeatTimeout(Timeout heartbeatTimeout)
      Timeout for the heartbeat.

      [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

      Default: - None

      Parameters:
      heartbeatTimeout - Timeout for the heartbeat. This parameter is required.
      Returns:
      this

    • inputPath

      @Stability(Stable) public EcsRunTask.Builder inputPath(String inputPath)
      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 '$')

      Parameters:
      inputPath - JSONPath expression to select part of the state to be the input to this state. This parameter is required.
      Returns:
      this

    • integrationPattern

      @Stability(Stable) public EcsRunTask.Builder integrationPattern(IntegrationPattern integrationPattern)
      AWS Step Functions integrates with services directly in the Amazon States Language.

      You can control these AWS services using service integration patterns.

      Depending on the AWS Service, the Service Integration Pattern availability will vary.

      Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.

      Parameters:
      integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.
      Returns:
      this
      See Also:

    • outputPath

      @Stability(Stable) public EcsRunTask.Builder outputPath(String outputPath)
      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 '$')

      Parameters:
      outputPath - JSONPath expression to select select a portion of the state output to pass to the next state. This parameter is required.
      Returns:
      this

    • resultPath

      @Stability(Stable) public EcsRunTask.Builder resultPath(String resultPath)
      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 '$')

      Parameters:
      resultPath - JSONPath expression to indicate where to inject the state's output. This parameter is required.
      Returns:
      this

    • resultSelector

      @Stability(Stable) public EcsRunTask.Builder resultSelector(Map<String,? extends Object> resultSelector)
      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

      Parameters:
      resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.
      Returns:
      this
      See Also:

    • stateName

      @Stability(Stable) public EcsRunTask.Builder stateName(String stateName)
      Optional name for this state.

      Default: - The construct ID will be used as state name

      Parameters:
      stateName - Optional name for this state. This parameter is required.
      Returns:
      this

    • taskTimeout

      @Stability(Stable) public EcsRunTask.Builder taskTimeout(Timeout taskTimeout)
      Timeout for the task.

      [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

      Default: - None

      Parameters:
      taskTimeout - Timeout for the task. This parameter is required.
      Returns:
      this

    • timeout

      @Stability(Deprecated) @Deprecated public EcsRunTask.Builder timeout(Duration timeout)
      Deprecated.
      use taskTimeout
      (deprecated) Timeout for the task.

      Default: - None

      Parameters:
      timeout - Timeout for the task. This parameter is required.
      Returns:
      this

    • cluster

      @Stability(Stable) public EcsRunTask.Builder cluster(ICluster cluster)
      The ECS cluster to run the task on.

      Parameters:
      cluster - The ECS cluster to run the task on. This parameter is required.
      Returns:
      this

    • launchTarget

      @Stability(Stable) public EcsRunTask.Builder launchTarget(IEcsLaunchTarget launchTarget)
      An Amazon ECS launch type determines the type of infrastructure on which your tasks and services are hosted.

      Parameters:
      launchTarget - An Amazon ECS launch type determines the type of infrastructure on which your tasks and services are hosted. This parameter is required.
      Returns:
      this
      See Also:

    • taskDefinition

      @Stability(Stable) public EcsRunTask.Builder taskDefinition(TaskDefinition 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 definitions If you want to run a RunTask with an imported task definition, consider using CustomState

      Parameters:
      taskDefinition - [disable-awslint:ref-via-interface] Task Definition used for running tasks in the service. This parameter is required.
      Returns:
      this

    • assignPublicIp

      @Stability(Stable) public EcsRunTask.Builder assignPublicIp(Boolean assignPublicIp)
      Assign public IP addresses to each task.

      Default: false

      Parameters:
      assignPublicIp - Assign public IP addresses to each task. This parameter is required.
      Returns:
      this

    • containerOverrides

      @Stability(Stable) public EcsRunTask.Builder containerOverrides(List<? extends ContainerOverride> containerOverrides)
      Container setting overrides.

      Specify the container to use and the overrides to apply.

      Default: - No overrides

      Parameters:
      containerOverrides - Container setting overrides. This parameter is required.
      Returns:
      this

    • enableExecuteCommand

      @Stability(Stable) public EcsRunTask.Builder enableExecuteCommand(Boolean enableExecuteCommand)
      Whether ECS Exec should be enabled.

      Default: false

      Parameters:
      enableExecuteCommand - Whether ECS Exec should be enabled. This parameter is required.
      Returns:
      this
      See Also:

    • propagatedTagSource

      @Stability(Stable) public EcsRunTask.Builder propagatedTagSource(PropagatedTagSource propagatedTagSource)
      Specifies whether to propagate the tags from the task definition to the task.

      An error will be received if you specify the SERVICE option when running a task.

      Default: - No tags are propagated.

      Parameters:
      propagatedTagSource - Specifies whether to propagate the tags from the task definition to the task. This parameter is required.
      Returns:
      this
      See Also:

    • revisionNumber

      @Stability(Stable) public EcsRunTask.Builder revisionNumber(Number revisionNumber)
      The revision number of ECS task definition family.

      Default: - '$latest'

      Parameters:
      revisionNumber - The revision number of ECS task definition family. This parameter is required.
      Returns:
      this

    • securityGroups

      @Stability(Stable) public EcsRunTask.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)
      Existing security groups to use for the tasks.

      Default: - A new security group is created

      Parameters:
      securityGroups - Existing security groups to use for the tasks. This parameter is required.
      Returns:
      this

    • subnets

      @Stability(Stable) public EcsRunTask.Builder subnets(SubnetSelection subnets)
      Subnets to place the task's ENIs.

      Default: - Public subnets if assignPublicIp is set. Private subnets otherwise.

      Parameters:
      subnets - Subnets to place the task's ENIs. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public EcsRunTask build()
      Specified by:
      build in interface software.amazon.jsii.Builder<EcsRunTask>
      Returns:
      a newly built instance of EcsRunTask.