public static final class CallApiGatewayHttpApiEndpoint.Builder
extends java.lang.Object
CallApiGatewayHttpApiEndpoint
.Modifier and Type | Method and Description |
---|---|
CallApiGatewayHttpApiEndpoint.Builder |
apiId(java.lang.String apiId)
The Id of the API to call.
|
CallApiGatewayHttpApiEndpoint.Builder |
apiPath(java.lang.String apiPath)
Path parameters appended after API endpoint.
|
CallApiGatewayHttpApiEndpoint.Builder |
apiStack(Stack apiStack)
The Stack in which the API is defined.
|
CallApiGatewayHttpApiEndpoint.Builder |
authType(AuthType authType)
Authentication methods.
|
CallApiGatewayHttpApiEndpoint |
build() |
CallApiGatewayHttpApiEndpoint.Builder |
comment(java.lang.String comment)
An optional description for this state.
|
static CallApiGatewayHttpApiEndpoint.Builder |
create(software.constructs.Construct scope,
java.lang.String id) |
CallApiGatewayHttpApiEndpoint.Builder |
headers(TaskInput headers)
HTTP request information that does not relate to contents of the request.
|
CallApiGatewayHttpApiEndpoint.Builder |
heartbeat(Duration heartbeat)
Timeout for the heartbeat.
|
CallApiGatewayHttpApiEndpoint.Builder |
inputPath(java.lang.String inputPath)
JSONPath expression to select part of the state to be the input to this state.
|
CallApiGatewayHttpApiEndpoint.Builder |
integrationPattern(IntegrationPattern integrationPattern)
AWS Step Functions integrates with services directly in the Amazon States Language.
|
CallApiGatewayHttpApiEndpoint.Builder |
method(HttpMethod method)
Http method for the API.
|
CallApiGatewayHttpApiEndpoint.Builder |
outputPath(java.lang.String outputPath)
JSONPath expression to select select a portion of the state output to pass to the next state.
|
CallApiGatewayHttpApiEndpoint.Builder |
queryParameters(TaskInput queryParameters)
Query strings attatched to end of request.
|
CallApiGatewayHttpApiEndpoint.Builder |
requestBody(TaskInput requestBody)
HTTP Request body.
|
CallApiGatewayHttpApiEndpoint.Builder |
resultPath(java.lang.String resultPath)
JSONPath expression to indicate where to inject the state's output.
|
CallApiGatewayHttpApiEndpoint.Builder |
resultSelector(java.util.Map<java.lang.String,? extends java.lang.Object> resultSelector)
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
|
CallApiGatewayHttpApiEndpoint.Builder |
stageName(java.lang.String stageName)
Name of the stage where the API is deployed to in API Gateway.
|
CallApiGatewayHttpApiEndpoint.Builder |
timeout(Duration timeout)
Timeout for the state machine.
|
public static CallApiGatewayHttpApiEndpoint.Builder create(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.CallApiGatewayHttpApiEndpoint.Builder
.public CallApiGatewayHttpApiEndpoint.Builder comment(java.lang.String comment)
Default: - No comment
comment
- An optional description for this state. This parameter is required.this
public CallApiGatewayHttpApiEndpoint.Builder heartbeat(Duration heartbeat)
Default: - None
heartbeat
- Timeout for the heartbeat. This parameter is required.this
public CallApiGatewayHttpApiEndpoint.Builder inputPath(java.lang.String inputPath)
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 '$')
inputPath
- JSONPath expression to select part of the state to be the input to this state. This parameter is required.this
public CallApiGatewayHttpApiEndpoint.Builder integrationPattern(IntegrationPattern integrationPattern)
You can control these AWS services using service integration patterns
Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.
integrationPattern
- AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.this
public CallApiGatewayHttpApiEndpoint.Builder outputPath(java.lang.String outputPath)
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 '$')
outputPath
- JSONPath expression to select select a portion of the state output to pass to the next state. This parameter is required.this
public CallApiGatewayHttpApiEndpoint.Builder resultPath(java.lang.String resultPath)
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 '$')
resultPath
- JSONPath expression to indicate where to inject the state's output. This parameter is required.this
public CallApiGatewayHttpApiEndpoint.Builder resultSelector(java.util.Map<java.lang.String,? extends java.lang.Object> resultSelector)
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
Default: - None
resultSelector
- The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.this
public CallApiGatewayHttpApiEndpoint.Builder timeout(Duration timeout)
Default: - None
timeout
- Timeout for the state machine. This parameter is required.this
public CallApiGatewayHttpApiEndpoint.Builder method(HttpMethod method)
method
- Http method for the API. This parameter is required.this
public CallApiGatewayHttpApiEndpoint.Builder apiPath(java.lang.String apiPath)
Default: - No path
apiPath
- Path parameters appended after API endpoint. This parameter is required.this
public CallApiGatewayHttpApiEndpoint.Builder authType(AuthType authType)
Default: AuthType.NO_AUTH
authType
- Authentication methods. This parameter is required.this
public CallApiGatewayHttpApiEndpoint.Builder headers(TaskInput headers)
Default: - No headers
headers
- HTTP request information that does not relate to contents of the request. This parameter is required.this
public CallApiGatewayHttpApiEndpoint.Builder queryParameters(TaskInput queryParameters)
Default: - No query parameters
queryParameters
- Query strings attatched to end of request. This parameter is required.this
public CallApiGatewayHttpApiEndpoint.Builder requestBody(TaskInput requestBody)
Default: - No request body
requestBody
- HTTP Request body. This parameter is required.this
public CallApiGatewayHttpApiEndpoint.Builder apiId(java.lang.String apiId)
apiId
- The Id of the API to call. This parameter is required.this
public CallApiGatewayHttpApiEndpoint.Builder apiStack(Stack apiStack)
apiStack
- The Stack in which the API is defined. This parameter is required.this
public CallApiGatewayHttpApiEndpoint.Builder stageName(java.lang.String stageName)
Default: '$default'
stageName
- Name of the stage where the API is deployed to in API Gateway. This parameter is required.this
public CallApiGatewayHttpApiEndpoint build()