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.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:57.177Z")
 @Stability(value=Experimental)
public interface CallApiGatewayHttpApiEndpointProps
extends software.amazon.jsii.JsiiSerializable, CallApiGatewayEndpointBaseProps

(experimental) Properties for calling an HTTP API Endpoint.

Example:

 import software.amazon.awscdk.core.*;
 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 and Description
static class	CallApiGatewayHttpApiEndpointProps.Builder A builder for CallApiGatewayHttpApiEndpointProps
static class	CallApiGatewayHttpApiEndpointProps.Jsii$Proxy An implementation for CallApiGatewayHttpApiEndpointProps

Method Summary

Modifier and Type	Method and Description
static CallApiGatewayHttpApiEndpointProps.Builder	builder()
String	getApiId() (experimental) The Id of the API to call.
Stack	getApiStack() (experimental) The Stack in which the API is defined.
default String	getStageName() (experimental) 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

getApiId

@Stability(value=Experimental)
 @NotNull
String getApiId()

(experimental) The Id of the API to call.

getApiStack

@Stability(value=Experimental)
 @NotNull
Stack getApiStack()

(experimental) The Stack in which the API is defined.

getStageName

@Stability(value=Experimental)
 @Nullable
default String getStageName()

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

Default: '$default'

builder

@Stability(value=Experimental)
static CallApiGatewayHttpApiEndpointProps.Builder builder()

Specified by:

builder in interface CallApiGatewayEndpointBaseProps

Specified by:

builder in interface TaskStateBaseProps

Returns:

a CallApiGatewayHttpApiEndpointProps.Builder of CallApiGatewayHttpApiEndpointProps