software.amazon.awscdk.services.stepfunctions.tasks

Interface CallApiGatewayRestApiEndpointProps

All Superinterfaces:

CallApiGatewayEndpointBaseProps, software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

All Known Implementing Classes:

CallApiGatewayRestApiEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.72.0 (build 4b8828b)",
           date="2023-01-03T16:22:40.469Z")
 @Stability(value=Stable)
public interface CallApiGatewayRestApiEndpointProps
extends software.amazon.jsii.JsiiSerializable, CallApiGatewayEndpointBaseProps

Properties for calling an REST API Endpoint.

Example:

 import software.amazon.awscdk.services.apigateway.*;
 RestApi api;
 CallApiGatewayRestApiEndpoint.Builder.create(this, "Endpoint")
         .api(api)
         .stageName("Stage")
         .method(HttpMethod.PUT)
         .integrationPattern(IntegrationPattern.WAIT_FOR_TASK_TOKEN)
         .headers(TaskInput.fromObject(Map.of(
                 "TaskToken", JsonPath.array(JsonPath.getTaskToken()))))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CallApiGatewayRestApiEndpointProps.Builder	builder()
IRestApi	getApi() API to call.
String	getStageName() Name of the stage where the API is deployed to in API Gateway.

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.tasks.CallApiGatewayEndpointBaseProps

getApiPath, getAuthType, getHeaders, getMethod, getQueryParameters, getRequestBody

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

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApi

@Stability(value=Stable)
 @NotNull
IRestApi getApi()

API to call.

getStageName

@Stability(value=Stable)
 @NotNull
String getStageName()

Name of the stage where the API is deployed to in API Gateway.

builder

@Stability(value=Stable)
static CallApiGatewayRestApiEndpointProps.Builder builder()

Specified by:

builder in interface CallApiGatewayEndpointBaseProps

Specified by:

builder in interface TaskStateBaseProps

Returns:

a CallApiGatewayRestApiEndpointProps.Builder of CallApiGatewayRestApiEndpointProps