Interface CallApiGatewayEndpointBaseProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
,TaskStateBaseProps
- All Known Subinterfaces:
CallApiGatewayHttpApiEndpointProps
,CallApiGatewayRestApiEndpointProps
- All Known Implementing Classes:
CallApiGatewayEndpointBaseProps.Jsii$Proxy
,CallApiGatewayHttpApiEndpointProps.Jsii$Proxy
,CallApiGatewayRestApiEndpointProps.Jsii$Proxy
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 ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCallApiGatewayEndpointBaseProps
static final class
An implementation forCallApiGatewayEndpointBaseProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
Path parameters appended after API endpoint.default AuthType
Authentication methods.default TaskInput
HTTP request information that does not relate to contents of the request.Http method for the API.default TaskInput
Query strings attatched to end of request.default TaskInput
HTTP Request body.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps
getComment, getHeartbeat, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getTimeout
-
Method Details
-
getMethod
Http method for the API. -
getApiPath
Path parameters appended after API endpoint.Default: - No path
-
getAuthType
Authentication methods.Default: AuthType.NO_AUTH
-
getHeaders
HTTP request information that does not relate to contents of the request.Default: - No headers
-
getQueryParameters
Query strings attatched to end of request.Default: - No query parameters
-
getRequestBody
HTTP Request body.Default: - No request body
-
builder
-