StepFunctionsRestApi
Defines an API Gateway REST API with a Synchrounous Express State Machine as a proxy integration.
Import
import { StepFunctionsRestApi } from 'aws-cdk-lib/aws-apigateway';Or use the module namespace:
import * as apigateway from 'aws-cdk-lib/aws-apigateway';
// apigateway.StepFunctionsRestApiProperties
Configuration passed to the constructor as StepFunctionsRestApiProps.
stateMachineRequiredIStateMachineThe 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`.
authorizerOptionalbooleanIf 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
headersOptionalbooleanCheck 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
pathOptionalbooleanCheck 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
querystringOptionalbooleanCheck 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
requestContextOptionalRequestContextWhich 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
roleOptionalIRoleAn IAM role that API Gateway will assume to start the execution of the state machine.
Default: - a new role is created
useDefaultMethodResponsesOptionalbooleanWhether to add default response models with 200, 400, and 500 status codes to the method.
Default: true
5 properties inherited from RestApiProps
apiKeySourceTypeOptionalinherited from RestApiPropsApiKeySourceTypeThe source of the API key for metering requests according to a usage plan.
Default: - Metering is disabled.
binaryMediaTypesOptionalinherited from RestApiPropsstring[]The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream".
Default: - RestApi supports only UTF-8-encoded text payloads.
cloneFromOptionalinherited from RestApiPropsIRestApiThe ID of the API Gateway RestApi resource that you want to clone.
Default: - None.
minCompressionSizeOptionalinherited from RestApiPropsSizeA Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
Default: - Compression is disabled.
minimumCompressionSizeOptionalDeprecatedinherited from RestApiPropsnumberA nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
Default: - Compression is disabled.
Deprecated: - superseded by `minCompressionSize`
3 properties inherited from ResourceOptions
defaultCorsPreflightOptionsOptionalinherited from ResourceOptionsCorsOptionsAdds a CORS preflight OPTIONS method to this resource and all child resources. You can add CORS at the resource-level using `addCorsPreflight`.
Default: - CORS is disabled
defaultIntegrationOptionalinherited from ResourceOptionsIntegrationAn integration to use as a default for all methods created within this API unless an integration is specified.
Default: - Inherited from parent.
defaultMethodOptionsOptionalinherited from ResourceOptionsMethodOptionsMethod options to use as a default for all methods created within this API unless custom options are specified.
Default: - Inherited from parent.
15 properties inherited from RestApiBaseProps
cloudWatchRoleOptionalinherited from RestApiBasePropsbooleanAutomatically configure an AWS CloudWatch role for API Gateway.
Default: - false if `@aws-cdk/aws-apigateway:disableCloudWatchRole` is enabled, true otherwise
cloudWatchRoleRemovalPolicyOptionalinherited from RestApiBasePropsRemovalPolicyThe removal policy applied to the AWS CloudWatch role when this resource is removed from the application. Requires `cloudWatchRole` to be enabled.
Default: - RemovalPolicy.RETAIN
deployOptionalinherited from RestApiBasePropsbooleanIndicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes. Since API Gateway deployments are immutable, When this option is enabled (by default), an AWS::ApiGateway::Deployment resource will automatically created with a logical ID that hashes the API model (methods, resources and options). This means that when the model changes, the logical ID of this CloudFormation resource will change, and a new deployment will be created. If this is set, `latestDeployment` will refer to the `Deployment` object and `deploymentStage` will refer to a `Stage` that points to this deployment. To customize the stage options, use the `deployOptions` property. A CloudFormation Output will also be defined with the root URL endpoint of this REST API.
Default: true
deployOptionsOptionalinherited from RestApiBasePropsStageOptionsOptions for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled. If `deploy` is disabled, this value cannot be set.
Default: - Based on defaults of `StageOptions`.
descriptionOptionalinherited from RestApiBasePropsstringA description of the RestApi construct.
Default: - 'Automatically created by the RestApi construct'
disableExecuteApiEndpointOptionalinherited from RestApiBasePropsbooleanSpecifies whether clients can invoke the API using the default execute-api endpoint. To require that clients use a custom domain name to invoke the API, disable the default endpoint.
Default: false
domainNameOptionalinherited from RestApiBasePropsDomainNameOptionsConfigure a custom domain name and map it to this API.
Default: - no domain name is defined, use `addDomainName` or directly define a `DomainName`.
endpointConfigurationOptionalinherited from RestApiBasePropsEndpointConfigurationThe EndpointConfiguration property type specifies the endpoint types of a REST API.
Default: EndpointType.EDGE
endpointExportNameOptionalinherited from RestApiBasePropsstringExport name for the CfnOutput containing the API endpoint.
Default: - when no export name is given, output will be created without export
endpointTypesOptionalinherited from RestApiBasePropsEndpointType[]A list of the endpoint types of the API. Use this property when creating an API.
Default: EndpointType.EDGE
failOnWarningsOptionalinherited from RestApiBasePropsbooleanIndicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
Default: false
parametersOptionalinherited from RestApiBaseProps{ [key: string]: string }Custom header parameters for the request.
Default: - No parameters.
policyOptionalinherited from RestApiBasePropsPolicyDocumentA policy document that contains the permissions for this RestApi.
Default: - No policy.
restApiNameOptionalinherited from RestApiBasePropsstringA name for the API Gateway RestApi resource.
Default: - ID of the RestApi construct.
retainDeploymentsOptionalinherited from RestApiBasePropsbooleanRetains old deployment resources when the API changes. This allows manually reverting stages to point to old deployments via the AWS Console.
Default: false
Get the Amazon API Gateway Cheat Sheet
Everything you need to know about Amazon API Gateway on one page. HD quality, print-friendly.
Download Free InfographicQuick Facts
aws-apigateway