Table of Contents

Interface IStepFunctionsRestApiProps

Namespace
Amazon.CDK.AWS.APIGateway
Assembly
Amazon.CDK.AWS.APIGateway.dll

Properties for StepFunctionsRestApi.

public interface IStepFunctionsRestApiProps : IRestApiProps, IRestApiOptions, IRestApiBaseProps, IResourceOptions
Inherited Members

Examples

var stateMachineDefinition = new Pass(this, "PassState");

            var stateMachine = new StateMachine(this, "StateMachine", new StateMachineProps {
                Definition = stateMachineDefinition,
                StateMachineType = StateMachineType.EXPRESS
            });

            new StepFunctionsRestApi(this, "StepFunctionsRestApi", new StepFunctionsRestApiProps {
                Deploy = true,
                StateMachine = stateMachine
            });

Remarks

ExampleMetadata: infused

Properties

Authorizer

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

bool? Authorizer { get; }

Property Value

bool?

Remarks

The execution input will include a new key authorizer:

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

Default: false

Headers

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

bool? Headers { get; }

Property Value

bool?

Remarks

The execution input will include a new key headers:

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

Default: false

Path

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

bool? Path { get; }

Property Value

bool?

Remarks

The execution input will include a new key path:

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

Default: true

Querystring

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

bool? Querystring { get; }

Property Value

bool?

Remarks

The execution input will include a new key queryString:

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

Default: true

RequestContext

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

IRequestContext? RequestContext { get; }

Property Value

IRequestContext

Remarks

The execution input will include a new key requestContext:

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

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

Role

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

IRole? Role { get; }

Property Value

IRole

Remarks

Default: - a new role is created

StateMachine

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

IStateMachine StateMachine { get; }

Property Value

IStateMachine

Remarks

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