interface IHttpStage
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Apigatewayv2.IHttpStage |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#IHttpStage |
![]() | software.amazon.awscdk.services.apigatewayv2.IHttpStage |
![]() | aws_cdk.aws_apigatewayv2.IHttpStage |
![]() | aws-cdk-lib » aws_apigatewayv2 » IHttpStage |
Implemented by
Http
Obtainable from
Http
.fromHttpStageAttributes()
Represents the HttpStage.
Properties
Name | Type | Description |
---|---|---|
api | IHttp | The API this stage is associated to. |
domain | string | The custom domain URL to this stage. |
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. |
api
Type:
IHttp
The API this stage is associated to.
domainUrl
Type:
string
The custom domain 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. |
metric | Metric for the number of client-side errors captured in a given period. |
metric | Metric for the total number API requests in a given period. |
metric | Metric for the amount of data processed in bytes. |
metric | Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend. |
metric | The time between when API Gateway receives a request from a client and when it returns a response to the client. |
metric | Metric for the number of server-side errors captured in a given period. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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
Metric
Options
Returns
Return the given named metric for this HTTP Api Gateway Stage.
metricClientError(props?)
public metricClientError(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of client-side errors captured in a given period.
metricCount(props?)
public metricCount(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the total number API requests in a given period.
metricDataProcessed(props?)
public metricDataProcessed(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the amount of data processed in bytes.
metricIntegrationLatency(props?)
public metricIntegrationLatency(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
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
Metric
Options
Returns
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
Metric
Options
Returns
Metric for the number of server-side errors captured in a given period.