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
-
Method Summary
Modifier and TypeMethodDescriptionSets the value ofCallAwsServiceProps.getAction()
additionalIamStatements
(List<? extends PolicyStatement> additionalIamStatements) Sets the value ofCallAwsServiceProps.getAdditionalIamStatements()
build()
Builds the configured instance.Sets the value ofTaskStateBaseProps.getComment()
credentials
(Credentials credentials) Sets the value ofTaskStateBaseProps.getCredentials()
Deprecated.use `heartbeatTimeout`heartbeatTimeout
(Timeout heartbeatTimeout) Sets the value ofTaskStateBaseProps.getHeartbeatTimeout()
Sets the value ofCallAwsServiceProps.getIamAction()
iamResources
(List<String> iamResources) Sets the value ofCallAwsServiceProps.getIamResources()
Sets the value ofTaskStateBaseProps.getInputPath()
integrationPattern
(IntegrationPattern integrationPattern) Sets the value ofTaskStateBaseProps.getIntegrationPattern()
outputPath
(String outputPath) Sets the value ofTaskStateBaseProps.getOutputPath()
parameters
(Map<String, ? extends Object> parameters) Sets the value ofCallAwsServiceProps.getParameters()
resultPath
(String resultPath) Sets the value ofTaskStateBaseProps.getResultPath()
resultSelector
(Map<String, ? extends Object> resultSelector) Sets the value ofTaskStateBaseProps.getResultSelector()
Sets the value ofCallAwsServiceProps.getService()
Sets the value ofTaskStateBaseProps.getStateName()
taskTimeout
(Timeout taskTimeout) Sets the value ofTaskStateBaseProps.getTaskTimeout()
Deprecated.use `taskTimeout`
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
action
Sets the value ofCallAwsServiceProps.getAction()
- Parameters:
action
- The API action to call. This parameter is required. Use camelCase.- Returns:
this
-
iamResources
Sets the value ofCallAwsServiceProps.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 beservice:action
.- Returns:
this
-
service
Sets the value ofCallAwsServiceProps.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 ofCallAwsServiceProps.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
Sets the value ofCallAwsServiceProps.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
requiress3:ListAllMyBuckets
.- Returns:
this
-
parameters
@Stability(Stable) public CallAwsServiceProps.Builder parameters(Map<String, ? extends Object> parameters) Sets the value ofCallAwsServiceProps.getParameters()
- Parameters:
parameters
- Parameters for the API action call. Use PascalCase for the parameter names.- Returns:
this
-
comment
Sets the value ofTaskStateBaseProps.getComment()
- Parameters:
comment
- An optional description for this state.- Returns:
this
-
credentials
Sets the value ofTaskStateBaseProps.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
Deprecated.use `heartbeatTimeout`Sets the value ofTaskStateBaseProps.getHeartbeat()
- Parameters:
heartbeat
- Timeout for the heartbeat.- Returns:
this
-
heartbeatTimeout
Sets the value ofTaskStateBaseProps.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
Sets the value ofTaskStateBaseProps.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 CallAwsServiceProps.Builder integrationPattern(IntegrationPattern integrationPattern) Sets the value ofTaskStateBaseProps.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
Sets the value ofTaskStateBaseProps.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
Sets the value ofTaskStateBaseProps.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 ofTaskStateBaseProps.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
Sets the value ofTaskStateBaseProps.getStateName()
- Parameters:
stateName
- Optional name for this state.- Returns:
this
-
taskTimeout
Sets the value ofTaskStateBaseProps.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
Deprecated.use `taskTimeout`Sets the value ofTaskStateBaseProps.getTimeout()
- Parameters:
timeout
- Timeout for the task.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CallAwsServiceProps>
- Returns:
- a new instance of
CallAwsServiceProps
- Throws:
NullPointerException
- if any required attribute was not provided
-