software.amazon.awscdk.services.apigateway

Interface StepFunctionsRestApiProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, ResourceOptions, RestApiBaseProps, RestApiProps

All Known Implementing Classes:

StepFunctionsRestApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.238Z")
 @Stability(value=Stable)
public interface StepFunctionsRestApiProps
extends software.amazon.jsii.JsiiSerializable, RestApiProps

Properties for StepFunctionsRestApi.

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	Interface and Description
static class	StepFunctionsRestApiProps.Builder A builder for StepFunctionsRestApiProps
static class	StepFunctionsRestApiProps.Jsii$Proxy An implementation for StepFunctionsRestApiProps

Method Summary

Modifier and Type	Method and Description
static StepFunctionsRestApiProps.Builder	builder()
default Boolean	getAuthorizer() If the whole authorizer object, including custom context values should be in the execution input.
default Boolean	getHeaders() Check if header is to be included inside the execution input.
default Boolean	getPath() Check if path is to be included inside the execution input.
default Boolean	getQuerystring() Check if querystring is to be included inside the execution input.
default RequestContext	getRequestContext() Which details of the incoming request must be passed onto the underlying state machine, such as, account id, user identity, request id, etc.
default IRole	getRole() An IAM role that API Gateway will assume to start the execution of the state machine.
IStateMachine	getStateMachine() The default State Machine that handles all requests from this API.

Methods inherited from interface software.amazon.awscdk.services.apigateway.RestApiProps

getApiKeySourceType, getBinaryMediaTypes, getCloneFrom, getEndpointConfiguration, getMinimumCompressionSize

Methods inherited from interface software.amazon.awscdk.services.apigateway.ResourceOptions

getDefaultCorsPreflightOptions, getDefaultIntegration, getDefaultMethodOptions

Methods inherited from interface software.amazon.awscdk.services.apigateway.RestApiBaseProps

getCloudWatchRole, getDeploy, getDeployOptions, getDescription, getDisableExecuteApiEndpoint, getDomainName, getEndpointExportName, getEndpointTypes, getFailOnWarnings, getParameters, getPolicy, getRestApiName, getRetainDeployments

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getStateMachine

@Stability(value=Stable)
 @NotNull
IStateMachine getStateMachine()

The default State Machine that handles all requests from this API.

This stateMachine will be used as a the default integration for all methods in this API, unless specified otherwise in addMethod.

getAuthorizer

@Stability(value=Stable)
 @Nullable
default Boolean getAuthorizer()

If the whole authorizer object, including custom context values should be in the execution input.

The execution input will include a new key authorizer:

{ "body": {}, "authorizer": { "key": "value" } }

Default: false

getHeaders

@Stability(value=Stable)
 @Nullable
default Boolean getHeaders()

Check if header is to be included inside the execution input.

The execution input will include a new key headers:

{ "body": {}, "headers": { "header1": "value", "header2": "value" } }

Default: false

getPath

@Stability(value=Stable)
 @Nullable
default Boolean getPath()

Check if path is to be included inside the execution input.

The execution input will include a new key path:

{ "body": {}, "path": { "resourceName": "resourceValue" } }

Default: true

getQuerystring

@Stability(value=Stable)
 @Nullable
default Boolean getQuerystring()

Check if querystring is to be included inside the execution input.

The execution input will include a new key queryString:

{ "body": {}, "querystring": { "key": "value" } }

Default: true

getRequestContext

@Stability(value=Stable)
 @Nullable
default RequestContext getRequestContext()

Which details of the incoming request must be passed onto the underlying state machine, such as, account id, user identity, request id, etc.

The execution input will include a new key requestContext:

{ "body": {}, "requestContext": { "key": "value" } }

Default: - all parameters within request context will be set as false

getRole

@Stability(value=Stable)
 @Nullable
default IRole getRole()

An IAM role that API Gateway will assume to start the execution of the state machine.

Default: - a new role is created

builder

@Stability(value=Stable)
static StepFunctionsRestApiProps.Builder builder()

Specified by:

builder in interface ResourceOptions

Specified by:

builder in interface RestApiBaseProps

Specified by:

builder in interface RestApiProps

Returns:

a StepFunctionsRestApiProps.Builder of StepFunctionsRestApiProps