interface IStage
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Apigatewayv2.IStage |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#IStage |
 Java | software.amazon.awscdk.services.apigatewayv2.IStage |
 Python | aws_cdk.aws_apigatewayv2.IStage |
 TypeScript (source) | aws-cdk-lib » aws_apigatewayv2 » IStage |
Implemented by
Http, Web
Represents a Stage.
Properties
| Name | Type | Description |
|---|---|---|
| env | Resource | The environment this resource belongs to. |
| node | Node | The tree node. |
| stack | Stack | The stack in which this resource is defined. |
| stage | string | The name of the stage; |
| url | string | The URL to this stage. |
env
Type:
Resource
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
| Name | Description |
|---|---|
| apply | Apply the given removal policy to this resource. |
| metric(metricName, props?) | Return the given named metric for this HTTP Api Gateway Stage. |
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
Return the given named metric for this HTTP Api Gateway Stage.