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

Class EcsRunTaskProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.stepfunctions.tasks.EcsRunTaskProps.Jsii$Proxy

All Implemented Interfaces:

AssignableStateOptions, JsonataCommonOptions, JsonPathCommonOptions, StateBaseProps, EcsRunTaskProps, TaskStateBaseOptions, TaskStateBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

EcsRunTaskProps

@Stability(Stable)
@Internal
public static final class EcsRunTaskProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements EcsRunTaskProps

An implementation for EcsRunTaskProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.tasks.EcsRunTaskProps

EcsRunTaskProps.Builder, EcsRunTaskProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(EcsRunTaskProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the EcsRunTaskProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Map<String,Object>	getAssign()	Workflow variables to store in this step.
final Boolean	getAssignPublicIp()	Assign public IP addresses to each task.
final ICluster	getCluster()	The ECS cluster to run the task on.
final String	getComment()	A comment describing this state.
final List<ContainerOverride>	getContainerOverrides()	Container setting overrides.
final String	getCpu()	Cpu setting override.
final Credentials	getCredentials()	Credentials for an IAM Role that the State Machine assumes for executing the task.
final Boolean	getEnableExecuteCommand()	Whether ECS Exec should be enabled.
final Duration	getHeartbeat()	(deprecated) Timeout for the heartbeat.
final Timeout	getHeartbeatTimeout()	Timeout for the heartbeat.
final String	getInputPath()	JSONPath expression to select part of the state to be the input to this state.
final IntegrationPattern	getIntegrationPattern()	AWS Step Functions integrates with services directly in the Amazon States Language.
final IEcsLaunchTarget	getLaunchTarget()	An Amazon ECS launch type determines the type of infrastructure on which your tasks and services are hosted.
final String	getMemoryMiB()	Memory setting override.
final String	getOutputPath()	JSONPath expression to select part of the state to be the output to this state.
final Object	getOutputs()	Used to specify and transform output from the state.
final PropagatedTagSource	getPropagatedTagSource()	Specifies whether to propagate the tags from the task definition to the task.
final QueryLanguage	getQueryLanguage()	The name of the query language used by the state.
final String	getResultPath()	JSONPath expression to indicate where to inject the state's output.
final Map<String,Object>	getResultSelector()	The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
final Number	getRevisionNumber()	The revision number of ECS task definition family.
final List<ISecurityGroup>	getSecurityGroups()	Existing security groups to use for the tasks.
final String	getStateName()	Optional name for this state.
final SubnetSelection	getSubnets()	Subnets to place the task's ENIs.
final TaskDefinition	getTaskDefinition()	[disable-awslint:ref-via-interface] Task Definition used for running tasks in the service.
final Timeout	getTaskTimeout()	Timeout for the task.
final Duration	getTimeout()	(deprecated) Timeout for the task.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(EcsRunTaskProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the EcsRunTaskProps.Builder.

Method Details

getCluster

public final ICluster getCluster()

Description copied from interface: EcsRunTaskProps

The ECS cluster to run the task on.

Specified by:

getCluster in interface EcsRunTaskProps

getLaunchTarget

public final IEcsLaunchTarget getLaunchTarget()

Description copied from interface: EcsRunTaskProps

An Amazon ECS launch type determines the type of infrastructure on which your tasks and services are hosted.

Specified by:

getLaunchTarget in interface EcsRunTaskProps

See Also:

• https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html

getTaskDefinition

public final TaskDefinition getTaskDefinition()

Description copied from interface: EcsRunTaskProps

[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

Specified by:

getTaskDefinition in interface EcsRunTaskProps

getAssignPublicIp

public final Boolean getAssignPublicIp()

Description copied from interface: EcsRunTaskProps

Assign public IP addresses to each task.

Default: false

Specified by:

getAssignPublicIp in interface EcsRunTaskProps

getContainerOverrides

public final List<ContainerOverride> getContainerOverrides()

Description copied from interface: EcsRunTaskProps

Container setting overrides.

Specify the container to use and the overrides to apply.

Default: - No overrides

Specified by:

getContainerOverrides in interface EcsRunTaskProps

getCpu

public final String getCpu()

Description copied from interface: EcsRunTaskProps

Cpu setting override.

Default: - No override

Specified by:

getCpu in interface EcsRunTaskProps

See Also:

• https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskOverride.html

getEnableExecuteCommand

public final Boolean getEnableExecuteCommand()

Description copied from interface: EcsRunTaskProps

Whether ECS Exec should be enabled.

Default: false

Specified by:

getEnableExecuteCommand in interface EcsRunTaskProps

See Also:

• https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-enableExecuteCommand

getMemoryMiB

public final String getMemoryMiB()

Description copied from interface: EcsRunTaskProps

Memory setting override.

Default: - No override

Specified by:

getMemoryMiB in interface EcsRunTaskProps

See Also:

• https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskOverride.html

getPropagatedTagSource

public final PropagatedTagSource getPropagatedTagSource()

Description copied from interface: EcsRunTaskProps

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.

Specified by:

getPropagatedTagSource in interface EcsRunTaskProps

See Also:

• https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-propagateTags

getRevisionNumber

public final Number getRevisionNumber()

Description copied from interface: EcsRunTaskProps

The revision number of ECS task definition family.

Default: - '$latest'

Specified by:

getRevisionNumber in interface EcsRunTaskProps

getSecurityGroups

public final List<ISecurityGroup> getSecurityGroups()

Description copied from interface: EcsRunTaskProps

Existing security groups to use for the tasks.

Default: - A new security group is created

Specified by:

getSecurityGroups in interface EcsRunTaskProps

getSubnets

public final SubnetSelection getSubnets()

Description copied from interface: EcsRunTaskProps

Subnets to place the task's ENIs.

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

Specified by:

getSubnets in interface EcsRunTaskProps

getResultPath

public final String getResultPath()

Description copied from interface: TaskStateBaseProps

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: $

Specified by:

getResultPath in interface TaskStateBaseProps

getResultSelector

public final Map<String,Object> getResultSelector()

Description copied from interface: TaskStateBaseProps

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

Specified by:

getResultSelector in interface TaskStateBaseProps

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

getComment

public final String getComment()

Description copied from interface: StateBaseProps

A comment describing this state.

Default: No comment

Specified by:

getComment in interface StateBaseProps

getQueryLanguage

public final QueryLanguage getQueryLanguage()

Description copied from interface: StateBaseProps

The name of the query language used by the state.

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

Default: - JSONPath

Specified by:

getQueryLanguage in interface StateBaseProps

getStateName

public final String getStateName()

Description copied from interface: StateBaseProps

Optional name for this state.

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

Specified by:

getStateName in interface StateBaseProps

getCredentials

public final Credentials getCredentials()

Description copied from interface: TaskStateBaseOptions

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)

Specified by:

getCredentials in interface TaskStateBaseOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html

getHeartbeat

public final Duration getHeartbeat()

Description copied from interface: TaskStateBaseOptions

(deprecated) Timeout for the heartbeat.

Default: - None

Specified by:

getHeartbeat in interface TaskStateBaseOptions

getHeartbeatTimeout

public final Timeout getHeartbeatTimeout()

Description copied from interface: TaskStateBaseOptions

Timeout for the heartbeat.

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

Default: - None

Specified by:

getHeartbeatTimeout in interface TaskStateBaseOptions

getIntegrationPattern

public final IntegrationPattern getIntegrationPattern()

Description copied from interface: TaskStateBaseOptions

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`.

Specified by:

getIntegrationPattern in interface TaskStateBaseOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html

getTaskTimeout

public final Timeout getTaskTimeout()

Description copied from interface: TaskStateBaseOptions

Timeout for the task.

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

Default: - None

Specified by:

getTaskTimeout in interface TaskStateBaseOptions

getTimeout

public final Duration getTimeout()

Description copied from interface: TaskStateBaseOptions

(deprecated) Timeout for the task.

Default: - None

Specified by:

getTimeout in interface TaskStateBaseOptions

getAssign

public final Map<String,Object> getAssign()

Description copied from interface: AssignableStateOptions

Workflow variables to store in this step.

Using workflow variables, you can store data in a step and retrieve that data in future steps.

Default: - Not assign variables

Specified by:

getAssign in interface AssignableStateOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

getInputPath

public final String getInputPath()

Description copied from interface: JsonPathCommonOptions

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: $

Specified by:

getInputPath in interface JsonPathCommonOptions

getOutputPath

public final String getOutputPath()

Description copied from interface: JsonPathCommonOptions

JSONPath expression to select part of the state to be the output to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Default: $

Specified by:

getOutputPath in interface JsonPathCommonOptions

getOutputs

public final Object getOutputs()

Description copied from interface: JsonataCommonOptions

Used to specify and transform output from the state.

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Default: - $states.result or $states.errorOutput

Specified by:

getOutputs in interface JsonataCommonOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object