interface IHttpApi

Language	Type name
.NET	Amazon.CDK.AWS.Apigatewayv2.IHttpApi
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#IHttpApi
Java	software.amazon.awscdk.services.apigatewayv2.IHttpApi
Python	aws_cdk.aws_apigatewayv2.IHttpApi
TypeScript (source)	aws-cdk-lib » aws_apigatewayv2 » IHttpApi

Implemented by HttpApi

Obtainable from HttpApi.fromHttpApiAttributes()

Represents an HTTP API.

Properties

Name	Type	Description
apiEndpoint	string	The default endpoint for an API.
apiId	string	The identifier of this API Gateway API.
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.
defaultAuthorizationScopes?	string[]	Default OIDC scopes attached to all routes in the gateway, unless explicitly configured on the route.
defaultAuthorizer?	IHttpRouteAuthorizer	Default Authorizer applied to all routes in the gateway.

---

apiEndpoint

Type: string

The default endpoint for an API.

---

apiId

Type: string

The identifier of this API Gateway API.

---

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.

---

stack

Type: Stack

The stack in which this resource is defined.

---

defaultAuthorizationScopes?

Type: string[] (optional, default: no default authorization scopes)

Default OIDC scopes attached to all routes in the gateway, unless explicitly configured on the route.

The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation.

---

defaultAuthorizer?

Type: IHttpRouteAuthorizer (optional, default: no default authorizer)

Default Authorizer applied to all routes in the gateway.

Methods

Name	Description
addVpcLink(options)	Add a new VpcLink.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
arnForExecuteApi(method?, path?, stage?)	Get the "execute-api" ARN.
metric(metricName, props?)	Return the given named metric for this Api Gateway.
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.
metricDataProcessed(props?)	Metric for the amount of data processed in bytes.
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.

---

addVpcLink(options)

public addVpcLink(options: VpcLinkProps): VpcLink

Parameters

• options VpcLinkProps

Returns

• VpcLink

Add a new VpcLink.

---

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

Get the "execute-api" ARN.

When 'ANY' is passed to the method, an ARN with the method set to '*' is obtained.

---

metric(metricName, props?)

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

Parameters

• metricName string
• props MetricOptions

Returns

• Metric

Return the given named metric for this Api Gateway.

---

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.

---

metricCount(props?)

public metricCount(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

---

metricDataProcessed(props?)

public metricDataProcessed(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the amount of data processed in bytes.

---

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.

---

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.

---

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.