class RestApiBase

Language	Type name
.NET	`Amazon.CDK.AWS.APIGateway.RestApiBase`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#RestApiBase`
Java	`software.amazon.awscdk.services.apigateway.RestApiBase`
Python	`aws_cdk.aws_apigateway.RestApiBase`
TypeScript (source)	`aws-cdk-lib` » `aws_apigateway` » `RestApiBase`

Implements IConstruct, IDependable, IResource, IRestApi

Extends Resource

Implemented by LambdaRestApi, RestApi, SpecRestApi, StepFunctionsRestApi

Base implementation that are common to various implementations of IRestApi.

Example

declare const api: apigateway.RestApi;
new cloudfront.Distribution(this, 'Distribution', {
  defaultBehavior: { origin: new origins.RestApiOrigin(api) },
});

Initializer

new RestApiBase(scope: Construct, id: string, props?: RestApiBaseProps)

Parameters

scope Construct
id string
props RestApiBaseProps

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	`Node`	The tree node.
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.
url	`string`	The deployed root URL of this REST API.
cloudWatchAccount?	`CfnAccount`
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: Node

The tree node.

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.

url

Type: string

The deployed root URL of this REST API.

cloudWatchAccount?

Type: CfnAccount (optional)

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 to the deploymentStage.
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 to the deploymentStage.

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.