software.amazon.awscdk.services.stepfunctions.tasks

Interface CallApiGatewayEndpointBaseProps

All Superinterfaces:

TaskStateBaseProps

All Known Subinterfaces:

CallApiGatewayHttpApiEndpointProps, CallApiGatewayRestApiEndpointProps

All Known Implementing Classes:

CallApiGatewayEndpointBaseProps.Jsii$Proxy, CallApiGatewayHttpApiEndpointProps.Jsii$Proxy, CallApiGatewayRestApiEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:50.152Z")
public interface CallApiGatewayEndpointBaseProps
extends TaskStateBaseProps

Base CallApiGatewayEdnpoint Task Props.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.stepfunctions.*;
 import software.amazon.awscdk.services.stepfunctions.tasks.*;
 import software.amazon.awscdk.core.*;
 Object resultSelector;
 TaskInput taskInput;
 CallApiGatewayEndpointBaseProps callApiGatewayEndpointBaseProps = CallApiGatewayEndpointBaseProps.builder()
         .method(HttpMethod.GET)
         // the properties below are optional
         .apiPath("apiPath")
         .authType(AuthType.NO_AUTH)
         .comment("comment")
         .headers(taskInput)
         .heartbeat(Duration.minutes(30))
         .inputPath("inputPath")
         .integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
         .outputPath("outputPath")
         .queryParameters(taskInput)
         .requestBody(taskInput)
         .resultPath("resultPath")
         .resultSelector(Map.of(
                 "resultSelectorKey", resultSelector))
         .timeout(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CallApiGatewayEndpointBaseProps.Builder A builder for CallApiGatewayEndpointBaseProps
static class	CallApiGatewayEndpointBaseProps.Jsii$Proxy An implementation for CallApiGatewayEndpointBaseProps

Method Summary

Modifier and Type	Method and Description
static CallApiGatewayEndpointBaseProps.Builder	builder()
default java.lang.String	getApiPath() Path parameters appended after API endpoint.
default AuthType	getAuthType() Authentication methods.
default TaskInput	getHeaders() HTTP request information that does not relate to contents of the request.
HttpMethod	getMethod() Http method for the API.
default TaskInput	getQueryParameters() Query strings attatched to end of request.
default TaskInput	getRequestBody() HTTP Request body.

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps

getComment, getHeartbeat, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getTimeout

Method Detail

getMethod

HttpMethod getMethod()

Http method for the API.

getApiPath

default java.lang.String getApiPath()

Path parameters appended after API endpoint.

Default: - No path

getAuthType

default AuthType getAuthType()

Authentication methods.

Default: AuthType.NO_AUTH

getHeaders

default TaskInput getHeaders()

HTTP request information that does not relate to contents of the request.

Default: - No headers

getQueryParameters

default TaskInput getQueryParameters()

Query strings attatched to end of request.

Default: - No query parameters

getRequestBody

default TaskInput getRequestBody()

HTTP Request body.

Default: - No request body

builder

static CallApiGatewayEndpointBaseProps.Builder builder()

Specified by:

builder in interface TaskStateBaseProps

Returns:

a CallApiGatewayEndpointBaseProps.Builder of CallApiGatewayEndpointBaseProps