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

Class CallAwsServiceProps.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.tasks.CallAwsServiceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CallAwsServiceProps>

Enclosing interface:

CallAwsServiceProps

@Stability(Stable)
public static final class CallAwsServiceProps.Builder
extends Object
implements software.amazon.jsii.Builder<CallAwsServiceProps>

A builder for CallAwsServiceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CallAwsServiceProps.Builder	action(String action)	Sets the value of CallAwsServiceProps.getAction()
CallAwsServiceProps.Builder	additionalIamStatements(List<? extends PolicyStatement> additionalIamStatements)	Sets the value of CallAwsServiceProps.getAdditionalIamStatements()
CallAwsServiceProps.Builder	assign(Map<String,? extends Object> assign)	Sets the value of AssignableStateOptions.getAssign()
CallAwsServiceProps	build()	Builds the configured instance.
CallAwsServiceProps.Builder	comment(String comment)	Sets the value of StateBaseProps.getComment()
CallAwsServiceProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseOptions.getCredentials()
CallAwsServiceProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
CallAwsServiceProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()
CallAwsServiceProps.Builder	iamAction(String iamAction)	Sets the value of CallAwsServiceProps.getIamAction()
CallAwsServiceProps.Builder	iamResources(List<String> iamResources)	Sets the value of CallAwsServiceProps.getIamResources()
CallAwsServiceProps.Builder	inputPath(String inputPath)	Sets the value of JsonPathCommonOptions.getInputPath()
CallAwsServiceProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseOptions.getIntegrationPattern()
CallAwsServiceProps.Builder	outputPath(String outputPath)	Sets the value of JsonPathCommonOptions.getOutputPath()
CallAwsServiceProps.Builder	outputs(Object outputs)	Sets the value of JsonataCommonOptions.getOutputs()
CallAwsServiceProps.Builder	parameters(Map<String,? extends Object> parameters)	Sets the value of CallAwsServiceProps.getParameters()
CallAwsServiceProps.Builder	queryLanguage(QueryLanguage queryLanguage)	Sets the value of StateBaseProps.getQueryLanguage()
CallAwsServiceProps.Builder	resultPath(String resultPath)	Sets the value of TaskStateBaseProps.getResultPath()
CallAwsServiceProps.Builder	resultSelector(Map<String,? extends Object> resultSelector)	Sets the value of TaskStateBaseProps.getResultSelector()
CallAwsServiceProps.Builder	service(String service)	Sets the value of CallAwsServiceProps.getService()
CallAwsServiceProps.Builder	stateName(String stateName)	Sets the value of StateBaseProps.getStateName()
CallAwsServiceProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseOptions.getTaskTimeout()
CallAwsServiceProps.Builder	timeout(Duration timeout)	Deprecated. use `taskTimeout`

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

action

@Stability(Stable)
public CallAwsServiceProps.Builder action(String action)

Sets the value of CallAwsServiceProps.getAction()

Parameters:

action - The API action to call. This parameter is required. Use camelCase.

Returns:

this

iamResources

@Stability(Stable)
public CallAwsServiceProps.Builder iamResources(List<String> iamResources)

Sets the value of CallAwsServiceProps.getIamResources()

Parameters:

iamResources - The resources for the IAM statement that will be added to the state machine role's policy to allow the state machine to make the API call. This parameter is required. By default the action for this IAM statement will be service:action.

Returns:

this

service

@Stability(Stable)
public CallAwsServiceProps.Builder service(String service)

Sets the value of CallAwsServiceProps.getService()

Parameters:

service - The AWS service to call. This parameter is required.

Returns:

this

additionalIamStatements

@Stability(Stable)
public CallAwsServiceProps.Builder additionalIamStatements(List<? extends PolicyStatement> additionalIamStatements)

Sets the value of CallAwsServiceProps.getAdditionalIamStatements()

Parameters:

additionalIamStatements - Additional IAM statements that will be added to the state machine role's policy. Use in the case where the call requires more than a single statement to be executed, e.g. rekognition:detectLabels requires also S3 permissions to read the object on which it must act.

Returns:

this

iamAction

@Stability(Stable)
public CallAwsServiceProps.Builder iamAction(String iamAction)

Sets the value of CallAwsServiceProps.getIamAction()

Parameters:

iamAction - The action for the IAM statement that will be added to the state machine role's policy to allow the state machine to make the API call. Use in the case where the IAM action name does not match with the API service/action name, e.g. s3:ListBuckets requires s3:ListAllMyBuckets.

Returns:

this

parameters

@Stability(Stable)
public CallAwsServiceProps.Builder parameters(Map<String,? extends Object> parameters)

Sets the value of CallAwsServiceProps.getParameters()

Parameters:

parameters - Parameters for the API action call. Use PascalCase for the parameter names.

Returns:

this

resultPath

@Stability(Stable)
public CallAwsServiceProps.Builder resultPath(String resultPath)

Sets the value of TaskStateBaseProps.getResultPath()

Parameters:

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.

Returns:

this

resultSelector

@Stability(Stable)
public CallAwsServiceProps.Builder resultSelector(Map<String,? extends Object> resultSelector)

Sets the value of TaskStateBaseProps.getResultSelector()

Parameters:

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.

Returns:

this

comment

@Stability(Stable)
public CallAwsServiceProps.Builder comment(String comment)

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

@Stability(Stable)
public CallAwsServiceProps.Builder queryLanguage(QueryLanguage queryLanguage)

Sets the value of StateBaseProps.getQueryLanguage()

Parameters:

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

Returns:

this

stateName

@Stability(Stable)
public CallAwsServiceProps.Builder stateName(String stateName)

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

@Stability(Stable)
public CallAwsServiceProps.Builder credentials(Credentials credentials)

Sets the value of TaskStateBaseOptions.getCredentials()

Parameters:

credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations.

Returns:

this

heartbeat

@Stability(Deprecated)
@Deprecated
public CallAwsServiceProps.Builder heartbeat(Duration heartbeat)

Deprecated.

use `heartbeatTimeout`

Sets the value of TaskStateBaseOptions.getHeartbeat()

Parameters:

heartbeat - Timeout for the heartbeat.

Returns:

this

heartbeatTimeout

@Stability(Stable)
public CallAwsServiceProps.Builder heartbeatTimeout(Timeout heartbeatTimeout)

Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()

Parameters:

heartbeatTimeout - Timeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

integrationPattern

@Stability(Stable)
public CallAwsServiceProps.Builder integrationPattern(IntegrationPattern integrationPattern)

Sets the value of TaskStateBaseOptions.getIntegrationPattern()

Parameters:

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.

Returns:

this

taskTimeout

@Stability(Stable)
public CallAwsServiceProps.Builder taskTimeout(Timeout taskTimeout)

Sets the value of TaskStateBaseOptions.getTaskTimeout()

Parameters:

taskTimeout - Timeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

timeout

@Stability(Deprecated)
@Deprecated
public CallAwsServiceProps.Builder timeout(Duration timeout)

Deprecated.

use `taskTimeout`

Sets the value of TaskStateBaseOptions.getTimeout()

Parameters:

timeout - Timeout for the task.

Returns:

this

assign

@Stability(Stable)
public CallAwsServiceProps.Builder assign(Map<String,? extends Object> assign)

Sets the value of AssignableStateOptions.getAssign()

Parameters:

assign - Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps.

Returns:

this

inputPath

@Stability(Stable)
public CallAwsServiceProps.Builder inputPath(String inputPath)

Sets the value of JsonPathCommonOptions.getInputPath()

Parameters:

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 {}.

Returns:

this

outputPath

@Stability(Stable)
public CallAwsServiceProps.Builder outputPath(String outputPath)

Sets the value of JsonPathCommonOptions.getOutputPath()

Parameters:

outputPath - 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 {}.

Returns:

this

outputs

@Stability(Stable)
public CallAwsServiceProps.Builder outputs(Object outputs)

Sets the value of JsonataCommonOptions.getOutputs()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CallAwsServiceProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CallAwsServiceProps>

Returns:

a new instance of CallAwsServiceProps

Throws:

NullPointerException - if any required attribute was not provided