Package software.amazon.awscdk.services.apigateway

Class StepFunctionsRestApi

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.apigateway.RestApiBase

software.amazon.awscdk.services.apigateway.RestApi

software.amazon.awscdk.services.apigateway.StepFunctionsRestApi

All Implemented Interfaces:

IConstruct, IDependable, IResource, IRestApi, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:45.121Z")
@Stability(Stable)
public class StepFunctionsRestApi
extends RestApi

Defines an API Gateway REST API with a Synchrounous Express State Machine as a proxy integration.

Example:

 Pass stateMachineDefinition = new Pass(this, "PassState");
 IStateMachine stateMachine = StateMachine.Builder.create(this, "StateMachine")
         .definition(stateMachineDefinition)
         .stateMachineType(StateMachineType.EXPRESS)
         .build();
 StepFunctionsRestApi.Builder.create(this, "StepFunctionsRestApi")
         .deploy(true)
         .stateMachine(stateMachine)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StepFunctionsRestApi.Builder	A fluent builder for StepFunctionsRestApi.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.IRestApi

IRestApi.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StepFunctionsRestApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	StepFunctionsRestApi(software.amazon.jsii.JsiiObjectRef objRef)
	StepFunctionsRestApi(software.constructs.Construct scope, String id, StepFunctionsRestApiProps props)

Method Summary

Methods inherited from class software.amazon.awscdk.services.apigateway.RestApi

addModel, addRequestValidator, fromRestApiAttributes, fromRestApiId, getMethods, getRestApiId, getRestApiRootResourceId, getRoot, getUrl, validate

Methods inherited from class software.amazon.awscdk.services.apigateway.RestApiBase

addApiKey, addApiKey, addDomainName, addGatewayResponse, addUsagePlan, addUsagePlan, arnForExecuteApi, arnForExecuteApi, arnForExecuteApi, arnForExecuteApi, configureCloudWatchRole, configureDeployment, getCloudWatchAccount, getDeploymentStage, getDomainName, getLatestDeployment, getRestApiName, metric, metric, metricCacheHitCount, metricCacheHitCount, metricCacheMissCount, metricCacheMissCount, metricClientError, metricClientError, metricCount, metricCount, metricIntegrationLatency, metricIntegrationLatency, metricLatency, metricLatency, metricServerError, metricServerError, setCloudWatchAccount, setDeploymentStage, urlForPath, urlForPath

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

StepFunctionsRestApi

protected StepFunctionsRestApi(software.amazon.jsii.JsiiObjectRef objRef)

StepFunctionsRestApi

protected StepFunctionsRestApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

StepFunctionsRestApi

@Stability(Stable)
public StepFunctionsRestApi(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 StepFunctionsRestApiProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.