CallApiGatewayEndpointBaseProps
- class aws_cdk.aws_stepfunctions_tasks.CallApiGatewayEndpointBaseProps(*, comment=None, query_language=None, state_name=None, credentials=None, heartbeat=None, heartbeat_timeout=None, integration_pattern=None, task_timeout=None, timeout=None, assign=None, input_path=None, output_path=None, outputs=None, result_path=None, result_selector=None, method, api_path=None, auth_type=None, headers=None, query_parameters=None, request_body=None)
Bases:
TaskStateBaseProps
,CallApiGatewayEndpointBaseOptions
Base CallApiGatewayEndpoint Task Props.
- Parameters:
comment (
Optional
[str
]) – A comment describing this state. Default: No commentquery_language (
Optional
[QueryLanguage
]) – The name of the query language used by the state. If the state does not contain aqueryLanguage
field, then it will use the query language specified in the top-levelqueryLanguage
field. Default: - JSONPathstate_name (
Optional
[str
]) – Optional name for this state. Default: - The construct ID will be used as state namecredentials (
Union
[Credentials
,Dict
[str
,Any
],None
]) – Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations. Default: - None (Task is executed using the State Machine’s execution role)heartbeat (
Optional
[Duration
]) – (deprecated) Timeout for the heartbeat. Default: - Noneheartbeat_timeout (
Optional
[Timeout
]) – Timeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface Default: - Noneintegration_pattern (
Optional
[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. Default: -IntegrationPattern.REQUEST_RESPONSE
for most tasks.IntegrationPattern.RUN_JOB
for the following exceptions:BatchSubmitJob
,EmrAddStep
,EmrCreateCluster
,EmrTerminationCluster
, andEmrContainersStartJobRun
.task_timeout (
Optional
[Timeout
]) – Timeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface Default: - Nonetimeout (
Optional
[Duration
]) – (deprecated) Timeout for the task. Default: - Noneassign (
Optional
[Mapping
[str
,Any
]]) – Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps. Default: - Not assign variablesinput_path (
Optional
[str
]) – 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 {}. Default: $output_path (
Optional
[str
]) – 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 {}. Default: $outputs (
Any
) – 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. Default: - $states.result or $states.errorOutputresult_path (
Optional
[str
]) – 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. Default: $result_selector (
Optional
[Mapping
[str
,Any
]]) – 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. Default: - Nonemethod (
HttpMethod
) – Http method for the API.api_path (
Optional
[str
]) – Path parameters appended after API endpoint. Default: - No pathauth_type (
Optional
[AuthType
]) – Authentication methods. Default: AuthType.NO_AUTHheaders (
Optional
[TaskInput
]) – HTTP request information that does not relate to contents of the request. Default: - No headersquery_parameters (
Optional
[TaskInput
]) – Query strings attatched to end of request. Default: - No query parametersrequest_body (
Optional
[TaskInput
]) – HTTP Request body. Default: - No request body
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk as cdk from aws_cdk import aws_stepfunctions as stepfunctions from aws_cdk import aws_stepfunctions_tasks as stepfunctions_tasks # assign: Any # outputs: Any # result_selector: Any # task_input: stepfunctions.TaskInput # task_role: stepfunctions.TaskRole # timeout: stepfunctions.Timeout call_api_gateway_endpoint_base_props = stepfunctions_tasks.CallApiGatewayEndpointBaseProps( method=stepfunctions_tasks.HttpMethod.GET, # the properties below are optional api_path="apiPath", assign={ "assign_key": assign }, auth_type=stepfunctions_tasks.AuthType.NO_AUTH, comment="comment", credentials=stepfunctions.Credentials( role=task_role ), headers=task_input, heartbeat=cdk.Duration.minutes(30), heartbeat_timeout=timeout, input_path="inputPath", integration_pattern=stepfunctions.IntegrationPattern.REQUEST_RESPONSE, output_path="outputPath", outputs=outputs, query_language=stepfunctions.QueryLanguage.JSON_PATH, query_parameters=task_input, request_body=task_input, result_path="resultPath", result_selector={ "result_selector_key": result_selector }, state_name="stateName", task_timeout=timeout, timeout=cdk.Duration.minutes(30) )
Attributes
- api_path
Path parameters appended after API endpoint.
- Default:
No path
- assign
Workflow variables to store in this step.
Using workflow variables, you can store data in a step and retrieve that data in future steps.
- Default:
Not assign variables
- See:
- auth_type
Authentication methods.
- Default:
AuthType.NO_AUTH
- comment
A comment describing this state.
- Default:
No comment
- credentials
Credentials for an IAM Role that the State Machine assumes for executing the task.
This enables cross-account resource invocations.
- Default:
None (Task is executed using the State Machine’s execution role)
- See:
- headers
HTTP request information that does not relate to contents of the request.
- Default:
No headers
- heartbeat
(deprecated) Timeout for the heartbeat.
- Default:
None
- Deprecated:
use
heartbeatTimeout
- Stability:
deprecated
- heartbeat_timeout
Timeout for the heartbeat.
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
- Default:
None
- input_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 {}.
- Default:
$
- integration_pattern
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.
- Default:
IntegrationPattern.REQUEST_RESPONSE
for most tasks.
IntegrationPattern.RUN_JOB
for the following exceptions:BatchSubmitJob
,EmrAddStep
,EmrCreateCluster
,EmrTerminationCluster
, andEmrContainersStartJobRun
.
- method
Http method for the API.
- output_path
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 {}.
- Default:
$
- outputs
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.
- Default:
$states.result or $states.errorOutput
- See:
- query_language
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-levelqueryLanguage
field.- Default:
JSONPath
- query_parameters
Query strings attatched to end of request.
- Default:
No query parameters
- request_body
HTTP Request body.
- Default:
No request body
- result_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.
- Default:
$
- result_selector
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.
- state_name
Optional name for this state.
- Default:
The construct ID will be used as state name
- task_timeout
Timeout for the task.
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
- Default:
None
- timeout
(deprecated) Timeout for the task.
- Default:
None
- Deprecated:
use
taskTimeout
- Stability:
deprecated