SpecRestApi
Represents a REST API in Amazon API Gateway, created with an OpenAPI specification. Some properties normally accessible on
Import
import { SpecRestApi } from 'aws-cdk-lib/aws-apigateway';Or use the module namespace:
import * as apigateway from 'aws-cdk-lib/aws-apigateway';
// apigateway.SpecRestApiProperties
Configuration passed to the constructor as SpecRestApiProps.
apiDefinitionRequiredApiDefinitionAn OpenAPI definition compatible with API Gateway.
binaryMediaTypesOptionalstring[]The list of binary media mime-types that are supported by the SpecRestApi resource, such as "image/png" or "application/octet-stream".
Default: - SpecRestApi supports only UTF-8-encoded text payloads.
minCompressionSizeOptionalSizeA 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.
modeOptionalRestApiModeThe Mode that determines how API Gateway handles resource updates. Valid values are `overwrite` or `merge`. For `overwrite`, the new API definition replaces the existing one. The existing API identifier remains unchanged. For `merge`, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen: - For REST APIs created before March 29, 2021, the default is `overwrite` - For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-level RestApi properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
Default: - `merge` for REST APIs created after March 29, 2021, otherwise `overwrite`
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