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

Class CallAwsServiceCrossRegionProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CallAwsServiceCrossRegionProps>

Enclosing interface:

CallAwsServiceCrossRegionProps

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

A builder for CallAwsServiceCrossRegionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CallAwsServiceCrossRegionProps.Builder	action(String action)	Sets the value of CallAwsServiceCrossRegionProps.getAction()
CallAwsServiceCrossRegionProps.Builder	additionalIamStatements(List<? extends PolicyStatement> additionalIamStatements)	Sets the value of CallAwsServiceCrossRegionProps.getAdditionalIamStatements()
CallAwsServiceCrossRegionProps	build()	Builds the configured instance.
CallAwsServiceCrossRegionProps.Builder	comment(String comment)	Sets the value of TaskStateBaseProps.getComment()
CallAwsServiceCrossRegionProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseProps.getCredentials()
CallAwsServiceCrossRegionProps.Builder	endpoint(String endpoint)	Sets the value of CallAwsServiceCrossRegionProps.getEndpoint()
CallAwsServiceCrossRegionProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
CallAwsServiceCrossRegionProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseProps.getHeartbeatTimeout()
CallAwsServiceCrossRegionProps.Builder	iamAction(String iamAction)	Sets the value of CallAwsServiceCrossRegionProps.getIamAction()
CallAwsServiceCrossRegionProps.Builder	iamResources(List<String> iamResources)	Sets the value of CallAwsServiceCrossRegionProps.getIamResources()
CallAwsServiceCrossRegionProps.Builder	inputPath(String inputPath)	Sets the value of TaskStateBaseProps.getInputPath()
CallAwsServiceCrossRegionProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseProps.getIntegrationPattern()
CallAwsServiceCrossRegionProps.Builder	outputPath(String outputPath)	Sets the value of TaskStateBaseProps.getOutputPath()
CallAwsServiceCrossRegionProps.Builder	parameters(Map<String,? extends Object> parameters)	Sets the value of CallAwsServiceCrossRegionProps.getParameters()
CallAwsServiceCrossRegionProps.Builder	region(String region)	Sets the value of CallAwsServiceCrossRegionProps.getRegion()
CallAwsServiceCrossRegionProps.Builder	resultPath(String resultPath)	Sets the value of TaskStateBaseProps.getResultPath()
CallAwsServiceCrossRegionProps.Builder	resultSelector(Map<String,? extends Object> resultSelector)	Sets the value of TaskStateBaseProps.getResultSelector()
CallAwsServiceCrossRegionProps.Builder	retryOnServiceExceptions(Boolean retryOnServiceExceptions)	Sets the value of CallAwsServiceCrossRegionProps.getRetryOnServiceExceptions()
CallAwsServiceCrossRegionProps.Builder	service(String service)	Sets the value of CallAwsServiceCrossRegionProps.getService()
CallAwsServiceCrossRegionProps.Builder	stateName(String stateName)	Sets the value of TaskStateBaseProps.getStateName()
CallAwsServiceCrossRegionProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseProps.getTaskTimeout()
CallAwsServiceCrossRegionProps.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 CallAwsServiceCrossRegionProps.Builder action(String action)

Sets the value of CallAwsServiceCrossRegionProps.getAction()

Parameters:

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

Returns:

this

iamResources

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

Sets the value of CallAwsServiceCrossRegionProps.getIamResources()

Parameters:

iamResources - The resources for the IAM statement that will be added to the Lambda function role's policy to allow the state machine to make the API call. This parameter is required.

Returns:

this

region

@Stability(Stable)
public CallAwsServiceCrossRegionProps.Builder region(String region)

Sets the value of CallAwsServiceCrossRegionProps.getRegion()

Parameters:

region - The AWS region to call this AWS API for. This parameter is required.

Returns:

this

service

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

Sets the value of CallAwsServiceCrossRegionProps.getService()

Parameters:

service - The AWS service to call in AWS SDK for JavaScript v3 format. This parameter is required.

Returns:

this

additionalIamStatements

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

Sets the value of CallAwsServiceCrossRegionProps.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

endpoint

@Stability(Stable)
public CallAwsServiceCrossRegionProps.Builder endpoint(String endpoint)

Sets the value of CallAwsServiceCrossRegionProps.getEndpoint()

Parameters:

endpoint - The AWS API endpoint.

Returns:

this

iamAction

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

Sets the value of CallAwsServiceCrossRegionProps.getIamAction()

Parameters:

iamAction - The action for the IAM statement that will be added to the Lambda function role's policy to allow the state machine to make the API call. By default the action for this IAM statement will be service:action.

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 CallAwsServiceCrossRegionProps.Builder parameters(Map<String,? extends Object> parameters)

Sets the value of CallAwsServiceCrossRegionProps.getParameters()

Parameters:

parameters - Parameters for the API action call in AWS SDK for JavaScript v3 format.

Returns:

this

retryOnServiceExceptions

@Stability(Stable)
public CallAwsServiceCrossRegionProps.Builder retryOnServiceExceptions(Boolean retryOnServiceExceptions)

Sets the value of CallAwsServiceCrossRegionProps.getRetryOnServiceExceptions()

Parameters:

retryOnServiceExceptions - Whether to retry on the backend Lambda service exceptions. This handles Lambda.ServiceException, Lambda.AWSLambdaException, Lambda.SdkClientException, and Lambda.ClientExecutionTimeoutException with an interval of 2 seconds, a back-off rate of 2 and 6 maximum attempts.

Returns:

this

comment

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

Sets the value of TaskStateBaseProps.getComment()

Parameters:

comment - An optional description for this state.

Returns:

this

credentials

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

Sets the value of TaskStateBaseProps.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 CallAwsServiceCrossRegionProps.Builder heartbeat(Duration heartbeat)

Deprecated.

use `heartbeatTimeout`

Sets the value of TaskStateBaseProps.getHeartbeat()

Parameters:

heartbeat - Timeout for the heartbeat.

Returns:

this

heartbeatTimeout

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

Sets the value of TaskStateBaseProps.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

inputPath

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

Sets the value of TaskStateBaseProps.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

integrationPattern

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

Sets the value of TaskStateBaseProps.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

outputPath

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

Sets the value of TaskStateBaseProps.getOutputPath()

Parameters:

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

Returns:

this

resultPath

@Stability(Stable)
public CallAwsServiceCrossRegionProps.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 CallAwsServiceCrossRegionProps.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

stateName

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

Sets the value of TaskStateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

taskTimeout

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

Sets the value of TaskStateBaseProps.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 CallAwsServiceCrossRegionProps.Builder timeout(Duration timeout)

Deprecated.

use `taskTimeout`

Sets the value of TaskStateBaseProps.getTimeout()

Parameters:

timeout - Timeout for the task.

Returns:

this

build

@Stability(Stable)
public CallAwsServiceCrossRegionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CallAwsServiceCrossRegionProps

Throws:

NullPointerException - if any required attribute was not provided