Class HttpStage
(experimental) Represents a stage where an instance of the API is deployed.
Inherited Members
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class HttpStage : Resource, IHttpStage, IStage, IResource, IConstruct, IDependable
Syntax (vb)
Public Class HttpStage
Inherits Resource
Implements IHttpStage, IStage, IResource, IConstruct, IDependable
Remarks
Stability: Experimental
Resource: AWS::ApiGatewayV2::Stage
ExampleMetadata: infused
Examples
HttpApi api;
new HttpStage(this, "Stage", new HttpStageProps {
HttpApi = api,
StageName = "beta"
});
Synopsis
Constructors
HttpStage(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
HttpStage(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
HttpStage(Construct, String, IHttpStageProps) |
Properties
Api | (experimental) The API this stage is associated to. |
BaseApi | |
DomainUrl | (experimental) The custom domain URL to this stage. |
StageName | (experimental) The name of the stage; |
Url | (experimental) The URL to this stage. |
Methods
FromHttpStageAttributes(Construct, String, IHttpStageAttributes) | (experimental) Import an existing stage into this CDK app. |
Metric(String, IMetricOptions) | (experimental) Return the given named metric for this HTTP Api Gateway Stage. |
MetricClientError(IMetricOptions) | (experimental) Metric for the number of client-side errors captured in a given period. |
MetricCount(IMetricOptions) | (experimental) Metric for the total number API requests in a given period. |
MetricDataProcessed(IMetricOptions) | (experimental) Metric for the amount of data processed in bytes. |
MetricIntegrationLatency(IMetricOptions) | (experimental) 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) | (experimental) The time between when API Gateway receives a request from a client and when it returns a response to the client. |
MetricServerError(IMetricOptions) | (experimental) Metric for the number of server-side errors captured in a given period. |
Constructors
HttpStage(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected HttpStage(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
HttpStage(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected HttpStage(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
HttpStage(Construct, String, IHttpStageProps)
public HttpStage(Construct scope, string id, IHttpStageProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props IHttpStageProps
Remarks
Stability: Experimental
Properties
Api
(experimental) The API this stage is associated to.
public virtual IHttpApi Api { get; }
Property Value
Remarks
Stability: Experimental
BaseApi
DomainUrl
(experimental) The custom domain URL to this stage.
public virtual string DomainUrl { get; }
Property Value
System.String
Remarks
Stability: Experimental
StageName
(experimental) The name of the stage;
public virtual string StageName { get; }
Property Value
System.String
Remarks
its primary identifier.
Stability: Experimental
Url
(experimental) The URL to this stage.
public virtual string Url { get; }
Property Value
System.String
Remarks
Stability: Experimental
Methods
FromHttpStageAttributes(Construct, String, IHttpStageAttributes)
(experimental) Import an existing stage into this CDK app.
public static IHttpStage FromHttpStageAttributes(Construct scope, string id, IHttpStageAttributes attrs)
Parameters
- scope Constructs.Construct
- id System.String
- attrs IHttpStageAttributes
Returns
Remarks
Stability: Experimental
Metric(String, IMetricOptions)
(experimental) Return the given named metric for this HTTP Api Gateway Stage.
public virtual Metric Metric(string metricName, IMetricOptions props = null)
Parameters
- metricName System.String
- props IMetricOptions
Returns
Remarks
Stability: Experimental
MetricClientError(IMetricOptions)
(experimental) Metric for the number of client-side errors captured in a given period.
public virtual Metric MetricClientError(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Stability: Experimental
MetricCount(IMetricOptions)
(experimental) Metric for the total number API requests in a given period.
public virtual Metric MetricCount(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Stability: Experimental
MetricDataProcessed(IMetricOptions)
(experimental) Metric for the amount of data processed in bytes.
public virtual Metric MetricDataProcessed(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Stability: Experimental
MetricIntegrationLatency(IMetricOptions)
(experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.
public virtual Metric MetricIntegrationLatency(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Stability: Experimental
MetricLatency(IMetricOptions)
(experimental) The time between when API Gateway receives a request from a client and when it returns a response to the client.
public virtual Metric MetricLatency(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
The latency includes the integration latency and other API Gateway overhead.
Stability: Experimental
MetricServerError(IMetricOptions)
(experimental) Metric for the number of server-side errors captured in a given period.
public virtual Metric MetricServerError(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Stability: Experimental