Class CallApiGatewayHttpApiEndpoint.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CallApiGatewayHttpApiEndpoint>
- Enclosing class:
CallApiGatewayHttpApiEndpoint
CallApiGatewayHttpApiEndpoint
.-
Method Summary
Modifier and TypeMethodDescriptionThe Id of the API to call.Path parameters appended after API endpoint.The Stack in which the API is defined.Authentication methods.build()
An optional description for this state.credentials
(Credentials credentials) Credentials for an IAM Role that the State Machine assumes for executing the task.HTTP request information that does not relate to contents of the request.Deprecated.heartbeatTimeout
(Timeout heartbeatTimeout) Timeout for the heartbeat.JSONPath expression to select part of the state to be the input to this state.integrationPattern
(IntegrationPattern integrationPattern) AWS Step Functions integrates with services directly in the Amazon States Language.method
(HttpMethod method) Http method for the API.outputPath
(String outputPath) JSONPath expression to select select a portion of the state output to pass to the next state.queryParameters
(TaskInput queryParameters) Query strings attatched to end of request.requestBody
(TaskInput requestBody) HTTP Request body.resultPath
(String resultPath) JSONPath expression to indicate where to inject the state's output.resultSelector
(Map<String, ? extends Object> resultSelector) The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.Name of the stage where the API is deployed to in API Gateway.Optional name for this state.taskTimeout
(Timeout taskTimeout) Timeout for the task.Deprecated.usetaskTimeout
-
Method Details
-
create
@Stability(Stable) public static CallApiGatewayHttpApiEndpoint.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- This parameter is required.id
- Descriptive identifier for this chainable. This parameter is required.- Returns:
- a new instance of
CallApiGatewayHttpApiEndpoint.Builder
.
-
comment
An optional description for this state.Default: - No comment
- Parameters:
comment
- An optional description for this state. This parameter is required.- Returns:
this
-
credentials
@Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder credentials(Credentials 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)
- Parameters:
credentials
- Credentials for an IAM Role that the State Machine assumes for executing the task. This parameter is required.- Returns:
this
- See Also:
-
heartbeat
@Stability(Deprecated) @Deprecated public CallApiGatewayHttpApiEndpoint.Builder heartbeat(Duration heartbeat) Deprecated.useheartbeatTimeout
(deprecated) Timeout for the heartbeat.Default: - None
- Parameters:
heartbeat
- Timeout for the heartbeat. This parameter is required.- Returns:
this
-
heartbeatTimeout
@Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder heartbeatTimeout(Timeout heartbeatTimeout) Timeout for the heartbeat.[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
- Parameters:
heartbeatTimeout
- Timeout for the heartbeat. This parameter is required.- Returns:
this
-
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 {}.
Default: - The entire task input (JSON path '$')
- Parameters:
inputPath
- JSONPath expression to select part of the state to be the input to this state. This parameter is required.- Returns:
this
-
integrationPattern
@Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder integrationPattern(IntegrationPattern 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`, and `EmrContainersStartJobRun`.
- Parameters:
integrationPattern
- AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.- Returns:
this
- See Also:
-
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 {}.
Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
- Parameters:
outputPath
- JSONPath expression to select select a portion of the state output to pass to the next state. This parameter is required.- Returns:
this
-
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.
Default: - Replaces the entire input with the result (JSON path '$')
- Parameters:
resultPath
- JSONPath expression to indicate where to inject the state's output. This parameter is required.- Returns:
this
-
resultSelector
@Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder resultSelector(Map<String, ? extends Object> 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.
Default: - None
- Parameters:
resultSelector
- The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.- Returns:
this
- See Also:
-
stateName
Optional name for this state.Default: - The construct ID will be used as state name
- Parameters:
stateName
- Optional name for this state. This parameter is required.- Returns:
this
-
taskTimeout
Timeout for the task.[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
- Parameters:
taskTimeout
- Timeout for the task. This parameter is required.- Returns:
this
-
timeout
@Stability(Deprecated) @Deprecated public CallApiGatewayHttpApiEndpoint.Builder timeout(Duration timeout) Deprecated.usetaskTimeout
(deprecated) Timeout for the task.Default: - None
- Parameters:
timeout
- Timeout for the task. This parameter is required.- Returns:
this
-
method
Http method for the API.- Parameters:
method
- Http method for the API. This parameter is required.- Returns:
this
-
apiPath
Path parameters appended after API endpoint.Default: - No path
- Parameters:
apiPath
- Path parameters appended after API endpoint. This parameter is required.- Returns:
this
-
authType
Authentication methods.Default: AuthType.NO_AUTH
- Parameters:
authType
- Authentication methods. This parameter is required.- Returns:
this
-
headers
HTTP request information that does not relate to contents of the request.Default: - No headers
- Parameters:
headers
- HTTP request information that does not relate to contents of the request. This parameter is required.- Returns:
this
-
queryParameters
@Stability(Stable) public CallApiGatewayHttpApiEndpoint.Builder queryParameters(TaskInput queryParameters) Query strings attatched to end of request.Default: - No query parameters
- Parameters:
queryParameters
- Query strings attatched to end of request. This parameter is required.- Returns:
this
-
requestBody
HTTP Request body.Default: - No request body
- Parameters:
requestBody
- HTTP Request body. This parameter is required.- Returns:
this
-
apiId
The Id of the API to call.- Parameters:
apiId
- The Id of the API to call. This parameter is required.- Returns:
this
-
apiStack
The Stack in which the API is defined.- Parameters:
apiStack
- The Stack in which the API is defined. This parameter is required.- Returns:
this
-
stageName
Name of the stage where the API is deployed to in API Gateway.Default: '$default'
- Parameters:
stageName
- Name of the stage where the API is deployed to in API Gateway. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CallApiGatewayHttpApiEndpoint>
- Returns:
- a newly built instance of
CallApiGatewayHttpApiEndpoint
.
-
heartbeatTimeout