class SpecRestApi (construct)

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

Implements IConstruct, IConstruct, IDependable, IResource, IRestApi

Represents a REST API in Amazon API Gateway, created with an OpenAPI specification.

Some properties normally accessible on @see {@link RestApi} - such as the description - must be declared in the specification. All Resources and Methods need to be defined as part of the OpenAPI specification file, and cannot be added via the CDK.

By default, the API will automatically be deployed and accessible from a public endpoint.

Example

declare const integration: apigateway.Integration;

const api = new apigateway.SpecRestApi(this, 'books-api', {
  apiDefinition: apigateway.ApiDefinition.fromAsset('path-to-file.json')
});

const booksResource = api.root.addResource('books')
booksResource.addMethod('GET', integration);

Initializer

new SpecRestApi(scope: Construct, id: string, props: SpecRestApiProps)

Parameters

• scope Construct
• id string
• props SpecRestApiProps

Construct Props

Name	Type	Description
apiDefinition	ApiDefinition	An OpenAPI definition compatible with API Gateway.
cloudWatchRole?	boolean	Automatically configure an AWS CloudWatch role for API Gateway.
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.
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.
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.
parameters?	{ [string]: string }	Custom header parameters for the request.
policy?	PolicyDocument	A policy document that contains the permissions for this RestApi.
restApiName?	string	A name for the API Gateway RestApi resource.
retainDeployments?	boolean	Retains old deployment resources when the API changes.

---

apiDefinition

Type: ApiDefinition

An OpenAPI definition compatible with API Gateway.

See also: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html

---

cloudWatchRole?

Type: boolean (optional, default: true)

Automatically configure an AWS CloudWatch role for API Gateway.

---

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.

---

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.

---

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.

---

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.

Properties

Name	Type	Description
deploymentStage	Stage	API Gateway stage that points to the latest deployment (if defined).
env	ResourceEnvironment	The environment this resource belongs to.
node	ConstructNode	The construct tree node associated with this construct.
restApiId	string	The ID of this API Gateway RestApi.
restApiName	string	A human friendly name for this Rest API.
restApiRootResourceId	string	The resource ID of the root resource.
root	IResource	Represents the root resource of this API endpoint ('/').
stack	Stack	The stack in which this resource is defined.
domainName?	DomainName	The first domain name mapped to this API, if defined through the domainName configuration prop, or added via addDomainName.
latestDeployment?	Deployment	API Gateway deployment that represents the latest changes of the API.

---

deploymentStage

Type: Stage

API Gateway stage that points to the latest deployment (if defined).

If deploy is disabled, you will need to explicitly assign this value in order to set up integrations.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

restApiId

Type: string

The ID of this API Gateway RestApi.

---

restApiName

Type: string

A human friendly name for this Rest API.

Note that this is different from restApiId.

---

restApiRootResourceId

Type: string

The resource ID of the root resource.

---

root

Type: IResource

Represents the root resource of this API endpoint ('/').

Resources and Methods are added to this resource.

---

stack

Type: Stack

The stack in which this resource is defined.

---

domainName?

Type: DomainName (optional)

The first domain name mapped to this API, if defined through the domainName configuration prop, or added via addDomainName.

---

latestDeployment?

Type: Deployment (optional)

API Gateway deployment that represents the latest changes of the API.

This resource will be automatically updated every time the REST API model changes. This will be undefined if deploy is false.

Methods

Name	Description
addApiKey(id, options?)	Add an ApiKey.
addDomainName(id, options)	Defines an API Gateway domain name and maps it to this API.
addGatewayResponse(id, options)	Adds a new gateway response.
addUsagePlan(id, props?)	Adds a usage plan.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
arnForExecuteApi(method?, path?, stage?)	Gets the "execute-api" ARN.
metric(metricName, props?)	Returns the given named metric for this API.
metricCacheHitCount(props?)	Metric for the number of requests served from the API cache in a given period.
metricCacheMissCount(props?)	Metric for the number of requests served from the backend in a given period, when API caching is enabled.
metricClientError(props?)	Metric for the number of client-side errors captured in a given period.
metricCount(props?)	Metric for the total number API requests in a given period.
metricIntegrationLatency(props?)	Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.
metricLatency(props?)	The time between when API Gateway receives a request from a client and when it returns a response to the client.
metricServerError(props?)	Metric for the number of server-side errors captured in a given period.
toString()	Returns a string representation of this construct.
urlForPath(path?)	Returns the URL for an HTTP path.

---

addApiKey(id, options?)

public addApiKey(id: string, options?: ApiKeyOptions): IApiKey

Parameters

• id string
• options ApiKeyOptions

Returns

• IApiKey

Add an ApiKey.

---

addDomainName(id, options)

public addDomainName(id: string, options: DomainNameOptions): DomainName

Parameters

• id string — The construct id.
• options DomainNameOptions — custom domain options.

Returns

• DomainName

Defines an API Gateway domain name and maps it to this API.

---

addGatewayResponse(id, options)

public addGatewayResponse(id: string, options: GatewayResponseOptions): GatewayResponse

Parameters

• id string
• options GatewayResponseOptions

Returns

• GatewayResponse

Adds a new gateway response.

---

addUsagePlan(id, props?)

public addUsagePlan(id: string, props?: UsagePlanProps): UsagePlan

Parameters

• id string
• props UsagePlanProps

Returns

• UsagePlan

Adds a usage plan.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

arnForExecuteApi(method?, path?, stage?)

public arnForExecuteApi(method?: string, path?: string, stage?: string): string

Parameters

• method string
• path string
• stage string

Returns

• string

Gets the "execute-api" ARN.

---

metric(metricName, props?)

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

• metricName string
• props MetricOptions

Returns

• Metric

Returns the given named metric for this API.

---

metricCacheHitCount(props?)

public metricCacheHitCount(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of requests served from the API cache in a given period.

Default: sum over 5 minutes

---

metricCacheMissCount(props?)

public metricCacheMissCount(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of requests served from the backend in a given period, when API caching is enabled.

Default: sum over 5 minutes

---

metricClientError(props?)

public metricClientError(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of client-side errors captured in a given period.

Default: sum over 5 minutes

---

metricCount(props?)

public metricCount(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the total number API requests in a given period.

Default: sample count over 5 minutes

---

metricIntegrationLatency(props?)

public metricIntegrationLatency(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.

Default: average over 5 minutes.

---

metricLatency(props?)

public metricLatency(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

The time between when API Gateway receives a request from a client and when it returns a response to the client.

The latency includes the integration latency and other API Gateway overhead.

Default: average over 5 minutes.

---

metricServerError(props?)

public metricServerError(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of server-side errors captured in a given period.

Default: sum over 5 minutes

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

urlForPath(path?)

public urlForPath(path?: string): string

Parameters

• path string

Returns

• string

Returns the URL for an HTTP path.

Fails if deploymentStage is not set either by deploy or explicitly.