interface IRestApi

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

Implemented by LambdaRestApi, RestApi, SpecRestApi, StepFunctionsRestApi

Obtainable from RestApi.fromRestApiAttributes(), RestApi.fromRestApiId()

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	The name of this API Gateway RestApi.
restApiRootResourceId	string	The resource ID of the root resource.
root	IResource	Represents the root resource ("/") of this API. Use it to define the API model:.
stack	Stack	The stack in which this resource is defined.
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).

---

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

The name of this API Gateway RestApi.

---

restApiRootResourceId

Type: string

The resource ID of the root resource.

---

root

Type: IResource

Represents the root resource ("/") of this API. Use it to define the API model:.

api.root.addMethod('ANY', redirectToHomePage); // "ANY /" api.root.addResource('friends').addMethod('GET', getFriendsHandler); // "GET /friends"

---

stack

Type: Stack

The stack in which this resource is defined.

---

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. undefined when no deployment is configured.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
arnForExecuteApi(method?, path?, stage?)	Gets the "execute-api" ARN.

---

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 — The method (default *).
• path string — The resource path.
• stage string — The stage (default *).

Returns

• string

Gets the "execute-api" ARN.