Package software.amazon.awscdk.services.stepfunctions.tasks

Interface CallApiGatewayHttpApiEndpointProps

All Superinterfaces:

CallApiGatewayEndpointBaseProps, software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

All Known Implementing Classes:

CallApiGatewayHttpApiEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-31T18:44:19.558Z")
@Stability(Stable)
public interface CallApiGatewayHttpApiEndpointProps
extends software.amazon.jsii.JsiiSerializable, CallApiGatewayEndpointBaseProps

Properties for calling an HTTP API Endpoint.

Example:

 import software.amazon.awscdk.services.apigatewayv2.*;
 HttpApi httpApi = new HttpApi(this, "MyHttpApi");
 CallApiGatewayHttpApiEndpoint invokeTask = CallApiGatewayHttpApiEndpoint.Builder.create(this, "Call HTTP API")
         .apiId(httpApi.getApiId())
         .apiStack(Stack.of(httpApi))
         .method(HttpMethod.GET)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CallApiGatewayHttpApiEndpointProps.Builder	builder()
String	getApiId()	The Id of the API to call.
software.amazon.awscdk.core.Stack	getApiStack()	The Stack in which the API is defined.
default 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, getHeartbeat, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getTimeout

Method Details

getApiId

@Stability(Stable)
@NotNull
String getApiId()

The Id of the API to call.

getApiStack

@Stability(Stable)
@NotNull
software.amazon.awscdk.core.Stack getApiStack()

The Stack in which the API is defined.

getStageName

@Stability(Stable)
@Nullable
default String getStageName()

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

Default: '$default'

builder

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

Returns:

a CallApiGatewayHttpApiEndpointProps.Builder of CallApiGatewayHttpApiEndpointProps