software.amazon.awscdk.services.apigateway

Class StepFunctionsRestApi

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.apigateway.RestApiBase

software.amazon.awscdk.services.apigateway.RestApi

software.amazon.awscdk.services.apigateway.StepFunctionsRestApi

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.223Z")
 @Stability(value=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 and Description
static 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.services.apigateway.IRestApi

IRestApi.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

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

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

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

addApiKey, addApiKey, addDomainName, addGatewayResponse, addUsagePlan, addUsagePlan, arnForExecuteApi, arnForExecuteApi, arnForExecuteApi, arnForExecuteApi, 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.Resource

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

Methods inherited from class software.constructs.Construct

getNode, isConstruct, 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.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

StepFunctionsRestApi

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

StepFunctionsRestApi

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

StepFunctionsRestApi

@Stability(value=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.