Package 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.97.0 (build 729de35)",
           date="2024-04-18T17:54:25.399Z")
@Stability(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	Description
static final class	CallApiGatewayRestApiEndpointProps.Builder	A builder for CallApiGatewayRestApiEndpointProps
static final class	CallApiGatewayRestApiEndpointProps.Jsii$Proxy	An implementation for CallApiGatewayRestApiEndpointProps

Method Summary

Modifier and Type	Method	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.jsii.JsiiSerializable

$jsii$toJson

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

getComment, getCredentials, getHeartbeat, getHeartbeatTimeout, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getStateName, getTaskTimeout, getTimeout

Method Details

getApi

@Stability(Stable)
@NotNull
IRestApi getApi()

API to call.

getStageName

@Stability(Stable)
@NotNull
String getStageName()

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

builder

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

Returns:

a CallApiGatewayRestApiEndpointProps.Builder of CallApiGatewayRestApiEndpointProps