@aws-cdk_aws-apigatewayv2-alpha.IHttpStage

interface IHttpStage ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Alpha.IHttpStage
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#IHttpStage
Javasoftware.amazon.awscdk.services.apigatewayv2.alpha.IHttpStage
Pythonaws_cdk.aws_apigatewayv2_alpha.IHttpStage
TypeScript (source)@aws-cdk/aws-apigatewayv2-alpha ยป IHttpStage

Implemented by HttpStage

Obtainable from HttpStage.fromHttpStageAttributes()

Represents the HttpStage.

Properties

NameTypeDescription
api๐Ÿ”นIHttpApiThe API this stage is associated to.
domainUrl๐Ÿ”นstringThe custom domain URL to this stage.
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
node๐Ÿ”นNodeThe tree node.
stack๐Ÿ”นStackThe stack in which this resource is defined.
stageName๐Ÿ”นstringThe name of the stage;
url๐Ÿ”นstringThe URL to this stage.

api๐Ÿ”น

Type: IHttpApi

The API this stage is associated to.


domainUrl๐Ÿ”น

Type: string

The custom domain URL to this stage.


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.


stageName๐Ÿ”น

Type: string

The name of the stage;

its primary identifier.


url๐Ÿ”น

Type: string

The URL to this stage.

Methods

NameDescription
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.
metric(metricName, props?)๐Ÿ”นReturn the given named metric for this HTTP Api Gateway Stage.
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.

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).


metric(metricName, props?)๐Ÿ”น

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

Parameters

  • metricName string
  • props MetricOptions

Returns

  • Metric

Return the given named metric for this HTTP Api Gateway Stage.


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.