interface CallAwsServiceProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.StepFunctions.Tasks.CallAwsServiceProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#CallAwsServiceProps |
Java | software.amazon.awscdk.services.stepfunctions.tasks.CallAwsServiceProps |
Python | aws_cdk.aws_stepfunctions_tasks.CallAwsServiceProps |
TypeScript (source) | aws-cdk-lib » aws_stepfunctions_tasks » CallAwsServiceProps |
Properties for calling an AWS service's API action from your state machine.
See also: https://docs.aws.amazon.com/step-functions/latest/dg/supported-services-awssdk.html
Example
declare const myBucket: s3.Bucket;
const getObject = new tasks.CallAwsService(this, 'GetObject', {
service: 's3',
action: 'getObject',
parameters: {
Bucket: myBucket.bucketName,
Key: sfn.JsonPath.stringAt('$.key')
},
iamResources: [myBucket.arnForObjects('*')],
});
Properties
Name | Type | Description |
---|---|---|
action | string | The API action to call. |
iam | string[] | 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. |
service | string | The AWS service to call. |
additional | Policy [] | Additional IAM statements that will be added to the state machine role's policy. |
comment? | string | An optional description for this state. |
credentials? | Credentials | Credentials for an IAM Role that the State Machine assumes for executing the task. |
heartbeat? | Duration | Timeout for the heartbeat. |
heartbeat | Timeout | Timeout for the heartbeat. |
iam | string | 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. |
input | string | JSONPath expression to select part of the state to be the input to this state. |
integration | Integration | AWS Step Functions integrates with services directly in the Amazon States Language. |
output | string | JSONPath expression to select select a portion of the state output to pass to the next state. |
parameters? | { [string]: any } | Parameters for the API action call. |
result | string | JSONPath expression to indicate where to inject the state's output. |
result | { [string]: any } | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
state | string | Optional name for this state. |
task | Timeout | Timeout for the task. |
timeout? | Duration | Timeout for the task. |
action
Type:
string
The API action to call.
Use camelCase.
iamResources
Type:
string[]
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
.
service
Type:
string
The AWS service to call.
See also: https://docs.aws.amazon.com/step-functions/latest/dg/supported-services-awssdk.html
additionalIamStatements?
Type:
Policy
[]
(optional, default: no additional statements are added)
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.
comment?
Type:
string
(optional, default: No comment)
An optional description for this state.
credentials?
Type:
Credentials
(optional, default: None (Task is executed using the State Machine's execution role))
Credentials for an IAM Role that the State Machine assumes for executing the task.
This enables cross-account resource invocations.
See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html
heartbeat?
⚠️ Deprecated: use heartbeatTimeout
Type:
Duration
(optional, default: None)
Timeout for the heartbeat.
heartbeatTimeout?
Type:
Timeout
(optional, default: None)
Timeout for the heartbeat.
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
iamAction?
Type:
string
(optional, default: service:action)
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
.
inputPath?
Type:
string
(optional, default: The entire task input (JSON path '$'))
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 {}.
integrationPattern?
Type:
Integration
(optional, default: IntegrationPattern.REQUEST_RESPONSE
for most tasks.
IntegrationPattern.RUN_JOB
for the following exceptions:
BatchSubmitJob
, EmrAddStep
, EmrCreateCluster
, EmrTerminationCluster
, and EmrContainersStartJobRun
.)
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.
See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html
outputPath?
Type:
string
(optional, default: The entire JSON node determined by the state input, the task result,
and resultPath is passed to the next state (JSON path '$'))
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 {}.
parameters?
Type:
{ [string]: any }
(optional, default: no parameters)
Parameters for the API action call.
Use PascalCase for the parameter names.
resultPath?
Type:
string
(optional, default: Replaces the entire input with the result (JSON path '$'))
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.
resultSelector?
Type:
{ [string]: any }
(optional, default: None)
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.
stateName?
Type:
string
(optional, default: The construct ID will be used as state name)
Optional name for this state.
taskTimeout?
Type:
Timeout
(optional, default: None)
Timeout for the task.
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
timeout?
⚠️ Deprecated: use taskTimeout
Type:
Duration
(optional, default: None)
Timeout for the task.