@aws-cdk_aws-apigatewayv2-alpha.HttpStage

class HttpStage (construct) ๐Ÿ”น

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

Implements IConstruct, IDependable, IResource, IHttpStage, IStage

Represents a stage where an instance of the API is deployed.

Example

declare const api: apigwv2.HttpApi;

new apigwv2.HttpStage(this, 'Stage', {
  httpApi: api,
  stageName: 'beta',
});

Initializer

new HttpStage(scope: Construct, id: string, props: HttpStageProps)

Parameters

  • scope Construct
  • id string
  • props HttpStageProps

Construct Props

NameTypeDescription
httpApi๐Ÿ”นIHttpApiThe HTTP API to which this stage is associated.
autoDeploy?๐Ÿ”นbooleanWhether updates to an API automatically trigger a new deployment.
domainMapping?๐Ÿ”นDomainMappingOptionsThe options for custom domain and api mapping.
stageName?๐Ÿ”นstringThe name of the stage.
throttle?๐Ÿ”นThrottleSettingsThrottle settings for the routes of this stage.

httpApi๐Ÿ”น

Type: IHttpApi

The HTTP API to which this stage is associated.


autoDeploy?๐Ÿ”น

Type: boolean (optional, default: false)

Whether updates to an API automatically trigger a new deployment.


domainMapping?๐Ÿ”น

Type: DomainMappingOptions (optional, default: no custom domain and api mapping configuration)

The options for custom domain and api mapping.


stageName?๐Ÿ”น

Type: string (optional, default: '$default' the default stage of the API. This stage will have the URL at the root of the API endpoint.)

The name of the stage.

See StageName class for more details.


throttle?๐Ÿ”น

Type: ThrottleSettings (optional, default: no throttling configuration)

Throttle settings for the routes of this stage.

Properties

NameTypeDescription
api๐Ÿ”นIHttpApiThe API this stage is associated to.
baseApi๐Ÿ”นIApi
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.


baseApi๐Ÿ”น

Type: IApi


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.
toString()๐Ÿ”นReturns a string representation of this construct.
static fromHttpStageAttributes(scope, id, attrs)๐Ÿ”นImport an existing stage into this CDK app.

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.


toString()๐Ÿ”น

public toString(): string

Returns

  • string

Returns a string representation of this construct.


static fromHttpStageAttributes(scope, id, attrs)๐Ÿ”น

public static fromHttpStageAttributes(scope: Construct, id: string, attrs: HttpStageAttributes): IHttpStage

Parameters

  • scope Construct
  • id string
  • attrs HttpStageAttributes

Returns

  • IHttpStage

Import an existing stage into this CDK app.