software.amazon.awscdk.services.stepfunctions.tasks

Interface CallAwsServiceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

All Known Implementing Classes:

CallAwsServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.448Z")
 @Stability(value=Stable)
public interface CallAwsServiceProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

Properties for calling an AWS service's API action from your state machine.

Example:

 Bucket myBucket;
 CallAwsService getObject = CallAwsService.Builder.create(this, "GetObject")
         .service("s3")
         .action("getObject")
         .parameters(Map.of(
                 "Bucket", myBucket.getBucketName(),
                 "Key", JsonPath.stringAt("$.key")))
         .iamResources(List.of(myBucket.arnForObjects("*")))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CallAwsServiceProps.Builder A builder for CallAwsServiceProps
static class	CallAwsServiceProps.Jsii$Proxy An implementation for CallAwsServiceProps

Method Summary

Modifier and Type	Method and Description
static CallAwsServiceProps.Builder	builder()
String	getAction() The API action to call.
default String	getIamAction() 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.
List<String>	getIamResources() 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.
default Map<String,Object>	getParameters() Parameters for the API action call.
String	getService() The AWS service to call.

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps

getComment, getHeartbeat, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getTimeout

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAction

@Stability(value=Stable)
 @NotNull
String getAction()

The API action to call.

Use camelCase.

getIamResources

@Stability(value=Stable)
 @NotNull
List<String> getIamResources()

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.

By default the action for this IAM statement will be service:action.

getService

@Stability(value=Stable)
 @NotNull
String getService()

The AWS service to call.

See Also:

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

getIamAction

@Stability(value=Stable)
 @Nullable
default String getIamAction()

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.

Default: - service:action

getParameters

@Stability(value=Stable)
 @Nullable
default Map<String,Object> getParameters()

Parameters for the API action call.

Use PascalCase for the parameter names.

Default: - no parameters

builder

@Stability(value=Stable)
static CallAwsServiceProps.Builder builder()

Specified by:

builder in interface TaskStateBaseProps

Returns:

a CallAwsServiceProps.Builder of CallAwsServiceProps