interface StepFunctionsRestApiProps

Language	Type name
.NET	Amazon.CDK.AWS.APIGateway.StepFunctionsRestApiProps
Java	software.amazon.awscdk.services.apigateway.StepFunctionsRestApiProps
Python	aws_cdk.aws_apigateway.StepFunctionsRestApiProps
TypeScript (source)	@aws-cdk/aws-apigateway » StepFunctionsRestApiProps

Properties for StepFunctionsRestApi.

Example

const stateMachineDefinition = new stepfunctions.Pass(this, 'PassState');

const stateMachine: stepfunctions.IStateMachine = new stepfunctions.StateMachine(this, 'StateMachine', {
  definition: stateMachineDefinition,
  stateMachineType: stepfunctions.StateMachineType.EXPRESS,
});

new apigateway.StepFunctionsRestApi(this, 'StepFunctionsRestApi', {
  deploy: true,
  stateMachine: stateMachine,
});

Properties

Name	Type	Description
stateMachine	IStateMachine	The default State Machine that handles all requests from this API.
apiKeySourceType?	ApiKeySourceType	The source of the API key for metering requests according to a usage plan.
authorizer?	boolean	If the whole authorizer object, including custom context values should be in the execution input.
binaryMediaTypes?	string[]	The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream".
cloneFrom?	IRestApi	The ID of the API Gateway RestApi resource that you want to clone.
cloudWatchRole?	boolean	Automatically configure an AWS CloudWatch role for API Gateway.
defaultCorsPreflightOptions?	CorsOptions	Adds a CORS preflight OPTIONS method to this resource and all child resources.
defaultIntegration?	Integration	An integration to use as a default for all methods created within this API unless an integration is specified.
defaultMethodOptions?	MethodOptions	Method options to use as a default for all methods created within this API unless custom options are specified.
deploy?	boolean	Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.
deployOptions?	StageOptions	Options for the API Gateway stage that will always point to the latest deployment when deploy is enabled.
description?	string	A description of the purpose of this API Gateway RestApi resource.
disableExecuteApiEndpoint?	boolean	Specifies whether clients can invoke the API using the default execute-api endpoint.
domainName?	DomainNameOptions	Configure a custom domain name and map it to this API.
endpointConfiguration?	EndpointConfiguration	The EndpointConfiguration property type specifies the endpoint types of a REST API.
endpointExportName?	string	Export name for the CfnOutput containing the API endpoint.
endpointTypes?	EndpointType[]	A list of the endpoint types of the API.
failOnWarnings?	boolean	Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
headers?	boolean	Check if header is to be included inside the execution input.
minimumCompressionSize?	number	A 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.
parameters?	{ [string]: string }	Custom header parameters for the request.
path?	boolean	Check if path is to be included inside the execution input.
policy?	PolicyDocument	A policy document that contains the permissions for this RestApi.
querystring?	boolean	Check if querystring is to be included inside the execution input.
requestContext?	RequestContext	Which details of the incoming request must be passed onto the underlying state machine, such as, account id, user identity, request id, etc.
restApiName?	string	A name for the API Gateway RestApi resource.
retainDeployments?	boolean	Retains old deployment resources when the API changes.
role?	IRole	An IAM role that API Gateway will assume to start the execution of the state machine.

---

stateMachine

Type: IStateMachine

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.

---

apiKeySourceType?

Type: ApiKeySourceType (optional, default: Metering is disabled.)

The source of the API key for metering requests according to a usage plan.

---

authorizer?

Type: boolean (optional, default: false)

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" } }

---

binaryMediaTypes?

Type: string[] (optional, default: RestApi supports only UTF-8-encoded text payloads.)

The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream".

---

cloneFrom?

Type: IRestApi (optional, default: None.)

The ID of the API Gateway RestApi resource that you want to clone.

---

cloudWatchRole?

Type: boolean (optional, default: true)

Automatically configure an AWS CloudWatch role for API Gateway.

---

defaultCorsPreflightOptions?

Type: CorsOptions (optional, default: CORS is disabled)

Adds a CORS preflight OPTIONS method to this resource and all child resources.

You can add CORS at the resource-level using addCorsPreflight.

---

defaultIntegration?

Type: Integration (optional, default: Inherited from parent.)

An integration to use as a default for all methods created within this API unless an integration is specified.

---

defaultMethodOptions?

Type: MethodOptions (optional, default: Inherited from parent.)

Method options to use as a default for all methods created within this API unless custom options are specified.

---

deploy?

Type: boolean (optional, default: true)

Indicates 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.

---

deployOptions?

Type: StageOptions (optional, default: Based on defaults of StageOptions.)

Options 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.

---

description?

Type: string (optional, default: No description.)

A description of the purpose of this API Gateway RestApi resource.

---

disableExecuteApiEndpoint?

Type: boolean (optional, default: false)

Specifies 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.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html

---

domainName?

Type: DomainNameOptions (optional, default: no domain name is defined, use addDomainName or directly define a DomainName.)

Configure a custom domain name and map it to this API.

---

endpointConfiguration?

Type: EndpointConfiguration (optional, default: EndpointType.EDGE)

The EndpointConfiguration property type specifies the endpoint types of a REST API.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html

---

endpointExportName?

Type: string (optional, default: when no export name is given, output will be created without export)

Export name for the CfnOutput containing the API endpoint.

---

endpointTypes?

Type: EndpointType[] (optional, default: EndpointType.EDGE)

A list of the endpoint types of the API.

Use this property when creating an API.

---

failOnWarnings?

Type: boolean (optional, default: false)

Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.

---

headers?

Type: boolean (optional, default: false)

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" } }

---

minimumCompressionSize?

Type: number (optional, default: Compression is disabled.)

A 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.

---

parameters?

Type: { [string]: string } (optional, default: No parameters.)

Custom header parameters for the request.

See also: https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html

---

path?

Type: boolean (optional, default: true)

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

The execution input will include a new key path:

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

---

policy?

Type: PolicyDocument (optional, default: No policy.)

A policy document that contains the permissions for this RestApi.

---

querystring?

Type: boolean (optional, default: true)

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

The execution input will include a new key queryString:

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

---

requestContext?

Type: RequestContext (optional, default: all parameters within request context will be set as false)

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" } }

---

restApiName?

Type: string (optional, default: ID of the RestApi construct.)

A name for the API Gateway RestApi resource.

---

retainDeployments?

Type: boolean (optional, default: false)

Retains old deployment resources when the API changes.

This allows manually reverting stages to point to old deployments via the AWS Console.

---

role?

Type: IRole (optional, default: a new role is created)

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