Interface IHttpApi

Represents an HTTP API.

Inherited Members

IApi.Metric(string, IMetricOptions)

IApi.ApiEndpoint

IApi.ApiId

IResource.ApplyRemovalPolicy(RemovalPolicy)

IResource.Stack

IHttpApiRef.IsHttpApi

IApiRef.ApiRef

IEnvironmentAware.Env

Namespace: Amazon.CDK.AWS.Apigatewayv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IHttpApi : IApi, IResource, IHttpApiRef, IApiRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Interface IHttpApi Inherits IApi, IResource, IHttpApiRef, IApiRef, IConstruct, IDependable, IEnvironmentAware

Synopsis

Properties

DefaultAuthorizationScopes	Default OIDC scopes attached to all routes in the gateway, unless explicitly configured on the route.
DefaultAuthorizer	Default Authorizer applied to all routes in the gateway.
DefaultStage	The default stage of this API.

Methods

AddVpcLink(IVpcLinkProps)	Add a new VpcLink.
ArnForExecuteApi(string?, string?, string?)	Get the "execute-api" ARN.
MetricClientError(IMetricOptions?)	Metric for the number of client-side errors captured in a given period.
MetricCount(IMetricOptions?)	Metric for the total number API requests in a given period.
MetricDataProcessed(IMetricOptions?)	Metric for the amount of data processed in bytes.
MetricIntegrationLatency(IMetricOptions?)	Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.
MetricLatency(IMetricOptions?)	The time between when API Gateway receives a request from a client and when it returns a response to the client.
MetricServerError(IMetricOptions?)	Metric for the number of server-side errors captured in a given period.

Properties

DefaultAuthorizationScopes

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

string[]? DefaultAuthorizationScopes { get; }

Property Value

string[]

Remarks

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

Default: - no default authorization scopes

Attribute: true

DefaultAuthorizer

Default Authorizer applied to all routes in the gateway.

IHttpRouteAuthorizer? DefaultAuthorizer { get; }

Property Value

IHttpRouteAuthorizer

Remarks

Default: - no default authorizer

Attribute: true

DefaultStage

The default stage of this API.

IHttpStage? DefaultStage { get; }

Property Value

IHttpStage

Remarks

Default: - a stage will be created

Attribute: true

Methods

AddVpcLink(IVpcLinkProps)

Add a new VpcLink.

VpcLink AddVpcLink(IVpcLinkProps options)

Parameters

options IVpcLinkProps

Returns

VpcLink

ArnForExecuteApi(string?, string?, string?)

Get the "execute-api" ARN.

string ArnForExecuteApi(string? method = null, string? path = null, string? stage = null)

Parameters

method string

path string

stage string

Returns

string

Remarks

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

Default: - The default behavior applies when no specific method, path, or stage is provided. In this case, the ARN will cover all methods, all resources, and all stages of this API. Specifically, if 'method' is not specified, it defaults to '', representing all methods. If 'path' is not specified, it defaults to '/', representing all paths. If 'stage' is not specified, it also defaults to '*', representing all stages.

MetricClientError(IMetricOptions?)

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

Metric MetricClientError(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: - sum over 5 minutes

MetricCount(IMetricOptions?)

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

Metric MetricCount(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: - SampleCount over 5 minutes

MetricDataProcessed(IMetricOptions?)

Metric for the amount of data processed in bytes.

Metric MetricDataProcessed(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: - sum over 5 minutes

MetricIntegrationLatency(IMetricOptions?)

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

Metric MetricIntegrationLatency(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: - no statistic

MetricLatency(IMetricOptions?)

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

Metric MetricLatency(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

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

Default: - no statistic

MetricServerError(IMetricOptions?)

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

Metric MetricServerError(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: - sum over 5 minutes