class CallAwsServiceCrossRegion (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.StepFunctions.Tasks.CallAwsServiceCrossRegion |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#CallAwsServiceCrossRegion |
![]() | software.amazon.awscdk.services.stepfunctions.tasks.CallAwsServiceCrossRegion |
![]() | aws_cdk.aws_stepfunctions_tasks.CallAwsServiceCrossRegion |
![]() | aws-cdk-lib » aws_stepfunctions_tasks » CallAwsServiceCrossRegion |
Implements
IConstruct
, IDependable
, IChainable
, INextable
A Step Functions task to call an AWS service API across regions.
This task creates a Lambda function to call cross-region AWS API and invokes it.
Example
declare const myBucket: s3.Bucket;
const getObject = new tasks.CallAwsServiceCrossRegion(this, 'GetObject', {
region: 'ap-northeast-1',
service: 's3',
action: 'getObject',
parameters: {
Bucket: myBucket.bucketName,
Key: sfn.JsonPath.stringAt('$.key')
},
iamResources: [myBucket.arnForObjects('*')],
});
Initializer
new CallAwsServiceCrossRegion(scope: Construct, id: string, props: CallAwsServiceCrossRegionProps)
Parameters
- scope
Construct
- id
string
— Descriptive identifier for this chainable. - props
Call
Aws Service Cross Region Props
Construct Props
Name | Type | Description |
---|---|---|
action | string | The API action to call. |
iam | string[] | 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. |
region | string | The AWS region to call this AWS API for. |
service | string | The AWS service to call in AWS SDK for JavaScript v3 format. |
additional | Policy [] | Additional IAM statements that will be added to the state machine role's policy. |
assign? | { [string]: any } | Workflow variables to store in this step. |
comment? | string | A comment describing this state. |
credentials? | Credentials | Credentials for an IAM Role that the State Machine assumes for executing the task. |
endpoint? | string | The AWS API endpoint. |
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 Lambda function 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 part of the state to be the output to this state. |
outputs? | any | Used to specify and transform output from the state. |
parameters? | { [string]: any } | Parameters for the API action call in AWS SDK for JavaScript v3 format. |
query | Query | The name of the query language used by the state. |
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. |
retry | boolean | Whether to retry on the backend Lambda service exceptions. |
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 Lambda function role's policy to allow the state machine to make the API call.
region
Type:
string
The AWS region to call this AWS API for. Example
'us-east-1'
service
Type:
string
The AWS service to call in AWS SDK for JavaScript v3 format.
See also: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/ Example
's3'
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.
assign?
Type:
{ [string]: any }
(optional, default: Not assign variables)
Workflow variables to store in this step.
Using workflow variables, you can store data in a step and retrieve that data in future steps.
comment?
Type:
string
(optional, default: No comment)
A comment describing 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.
endpoint?
Type:
string
(optional, default: Do not override API endpoint.)
The AWS API endpoint.
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 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
.
inputPath?
Type:
string
(optional, default: $)
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.
outputPath?
Type:
string
(optional, default: $)
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 {}.
outputs?
Type:
any
(optional, default: $states.result or $states.errorOutput)
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.
parameters?
Type:
{ [string]: any }
(optional, default: no parameters)
Parameters for the API action call in AWS SDK for JavaScript v3 format.
queryLanguage?
Type:
Query
(optional, default: JSONPath)
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.
resultPath?
Type:
string
(optional, default: $)
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.
retryOnServiceExceptions?
Type:
boolean
(optional, default: true)
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.
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.
Properties
Name | Type | Description |
---|---|---|
end | INextable [] | Continuable states of this Chainable. |
id | string | Descriptive identifier for this chainable. |
lambda | IFunction | |
node | Node | The tree node. |
start | State | First state of this Chainable. |
state | string | Tokenized string that evaluates to the state's ID. |
task | Task | |
task | Policy [] |
endStates
Type:
INextable
[]
Continuable states of this Chainable.
id
Type:
string
Descriptive identifier for this chainable.
lambdaFunction
Type:
IFunction
node
Type:
Node
The tree node.
startState
Type:
State
First state of this Chainable.
stateId
Type:
string
Tokenized string that evaluates to the state's ID.
taskMetrics?
Type:
Task
(optional)
taskPolicies?
Type:
Policy
[]
(optional)
Methods
Name | Description |
---|---|
add | Add a recovery handler for this state. |
add | Add a prefix to the stateId of this state. |
add | Add retry configuration for this state. |
bind | Register this state as part of the given graph. |
metric(metricName, props?) | Return the given named metric for this Task. |
metric | Metric for the number of times this activity fails. |
metric | Metric for the number of times the heartbeat times out for this activity. |
metric | The interval, in milliseconds, between the time the Task starts and the time it closes. |
metric | The interval, in milliseconds, for which the activity stays in the schedule state. |
metric | Metric for the number of times this activity is scheduled. |
metric | Metric for the number of times this activity is started. |
metric | Metric for the number of times this activity succeeds. |
metric | The interval, in milliseconds, between the time the activity is scheduled and the time it closes. |
metric | Metric for the number of times this activity times out. |
next(next) | Continue normal execution with the given state. |
to | Return the Amazon States Language object for this state. |
to | Returns a string representation of this construct. |
static json | A Step Functions task using JSONPath to call an AWS service API across regions. |
static jsonata(scope, id, props) | A Step Functions task using JSONata to call an AWS service API across regions. |
addCatch(handler, props?)
public addCatch(handler: IChainable, props?: CatchProps): TaskStateBase
Parameters
- handler
IChainable
- props
Catch
Props
Returns
Add a recovery handler for this state.
When a particular error occurs, execution will continue at the error handler instead of failing the state machine execution.
addPrefix(x)
public addPrefix(x: string): void
Parameters
- x
string
Add a prefix to the stateId of this state.
addRetry(props?)
public addRetry(props?: RetryProps): TaskStateBase
Parameters
- props
Retry
Props
Returns
Add retry configuration for this state.
This controls if and how the execution will be retried if a particular error occurs.
bindToGraph(graph)
public bindToGraph(graph: StateGraph): void
Parameters
- graph
State
Graph
Register this state as part of the given graph.
Don't call this. It will be called automatically when you work with states normally.
metric(metricName, props?)
public metric(metricName: string, props?: MetricOptions): Metric
Parameters
- metricName
string
- props
Metric
Options
Returns
Return the given named metric for this Task.
metricFailed(props?)
public metricFailed(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times this activity fails.
metricHeartbeatTimedOut(props?)
public metricHeartbeatTimedOut(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times the heartbeat times out for this activity.
metricRunTime(props?)
public metricRunTime(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The interval, in milliseconds, between the time the Task starts and the time it closes.
metricScheduleTime(props?)
public metricScheduleTime(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The interval, in milliseconds, for which the activity stays in the schedule state.
metricScheduled(props?)
public metricScheduled(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times this activity is scheduled.
metricStarted(props?)
public metricStarted(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times this activity is started.
metricSucceeded(props?)
public metricSucceeded(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times this activity succeeds.
metricTime(props?)
public metricTime(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The interval, in milliseconds, between the time the activity is scheduled and the time it closes.
metricTimedOut(props?)
public metricTimedOut(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times this activity times out.
next(next)
public next(next: IChainable): Chain
Parameters
- next
IChainable
Returns
Continue normal execution with the given state.
toStateJson(topLevelQueryLanguage?)
public toStateJson(topLevelQueryLanguage?: QueryLanguage): json
Parameters
- topLevelQueryLanguage
Query
Language
Returns
json
Return the Amazon States Language object for this state.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
static jsonPath(scope, id, props)
public static jsonPath(scope: Construct, id: string, props: CallAwsServiceCrossRegionJsonPathProps): CallAwsServiceCrossRegion
Parameters
- scope
Construct
- id
string
- props
Call
Aws Service Cross Region Json Path Props
Returns
A Step Functions task using JSONPath to call an AWS service API across regions.
This task creates a Lambda function to call cross-region AWS API and invokes it.
static jsonata(scope, id, props)
public static jsonata(scope: Construct, id: string, props: CallAwsServiceCrossRegionJsonataProps): CallAwsServiceCrossRegion
Parameters
- scope
Construct
- id
string
- props
Call
Aws Service Cross Region Jsonata Props
Returns
A Step Functions task using JSONata to call an AWS service API across regions.
This task creates a Lambda function to call cross-region AWS API and invokes it.