2.184.1

interface RestApiProps

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.RestApiProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#RestApiProps
Javasoftware.amazon.awscdk.services.apigateway.RestApiProps
Pythonaws_cdk.aws_apigateway.RestApiProps
TypeScript (source)aws-cdk-lib » aws_apigateway » RestApiProps

Props to create a new instance of RestApi.

Example

   const stateMachine = new stepfunctions.StateMachine(this, 'MyStateMachine', {
      stateMachineType: stepfunctions.StateMachineType.EXPRESS,
      definition: stepfunctions.Chain.start(new stepfunctions.Pass(this, 'Pass')),
   });

   const api = new apigateway.RestApi(this, 'Api', {
      restApiName: 'MyApi',
   });
   api.root.addMethod('GET', apigateway.StepFunctionsIntegration.startExecution(stateMachine));

Properties

NameTypeDescription
apiKeySourceType?ApiKeySourceTypeThe source of the API key for metering requests according to a usage plan.
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?IRestApiThe ID of the API Gateway RestApi resource that you want to clone.
cloudWatchRole?booleanAutomatically configure an AWS CloudWatch role for API Gateway.
cloudWatchRoleRemovalPolicy?RemovalPolicyThe removal policy applied to the AWS CloudWatch role when this resource is removed from the application.
defaultCorsPreflightOptions?CorsOptionsAdds a CORS preflight OPTIONS method to this resource and all child resources.
defaultIntegration?IntegrationAn integration to use as a default for all methods created within this API unless an integration is specified.
defaultMethodOptions?MethodOptionsMethod options to use as a default for all methods created within this API unless custom options are specified.
deploy?booleanIndicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.
deployOptions?StageOptionsOptions for the API Gateway stage that will always point to the latest deployment when deploy is enabled.
description?stringA description of the RestApi construct.
disableExecuteApiEndpoint?booleanSpecifies whether clients can invoke the API using the default execute-api endpoint.
domainName?DomainNameOptionsConfigure a custom domain name and map it to this API.
endpointConfiguration?EndpointConfigurationThe EndpointConfiguration property type specifies the endpoint types of a REST API.
endpointExportName?stringExport name for the CfnOutput containing the API endpoint.
endpointTypes?EndpointType[]A list of the endpoint types of the API.
failOnWarnings?booleanIndicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
minCompressionSize?SizeA 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.
minimumCompressionSize?⚠️numberA 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.
policy?PolicyDocumentA policy document that contains the permissions for this RestApi.
restApiName?stringA name for the API Gateway RestApi resource.
retainDeployments?booleanRetains old deployment resources when the API changes.

apiKeySourceType?

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

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

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: false if @aws-cdk/aws-apigateway:disableCloudWatchRole is enabled, true otherwise)

Automatically configure an AWS CloudWatch role for API Gateway.

cloudWatchRoleRemovalPolicy?

Type: RemovalPolicy (optional, default: RemovalPolicy.RETAIN)

The removal policy applied to the AWS CloudWatch role when this resource is removed from the application.

Requires cloudWatchRole to be enabled.

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: 'Automatically created by the RestApi construct')

A description of the RestApi construct.

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.

minCompressionSize?

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

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

minimumCompressionSize?⚠️

⚠️ Deprecated: - superseded by minCompressionSize

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

policy?

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

A policy document that contains the permissions for this RestApi.

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.

← PreviousNext →