Class HttpStage
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.Resource
software.amazon.awscdk.services.apigatewayv2.HttpStage
- All Implemented Interfaces:
IConstruct
,IDependable
,IResource
,IHttpStage
,IStage
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-05-31T18:44:14.865Z")
@Stability(Experimental)
public class HttpStage
extends Resource
implements IHttpStage, IStage
(experimental) Represents a stage where an instance of the API is deployed.
Example:
HttpApi api; HttpStage.Builder.create(this, "Stage") .httpApi(api) .stageName("beta") .build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
(experimental) A fluent builder forHttpStage
.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IHttpStage
IHttpStage.Jsii$Default, IHttpStage.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource
IResource.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IStage
IStage.Jsii$Default, IStage.Jsii$Proxy
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
HttpStage
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
HttpStage
(software.amazon.jsii.JsiiObjectRef objRef) HttpStage
(software.constructs.Construct scope, String id, HttpStageProps props) -
Method Summary
Modifier and TypeMethodDescriptionstatic IHttpStage
fromHttpStageAttributes
(software.constructs.Construct scope, String id, HttpStageAttributes attrs) (experimental) Import an existing stage into this CDK app.getApi()
(experimental) The API this stage is associated to.protected IApi
(experimental) The custom domain URL to this stage.(experimental) The name of the stage;getUrl()
(experimental) The URL to this stage.(experimental) Return the given named metric for this HTTP Api Gateway Stage.metric
(String metricName, MetricOptions props) (experimental) Return the given named metric for this HTTP Api Gateway Stage.(experimental) Metric for the number of client-side errors captured in a given period.metricClientError
(MetricOptions props) (experimental) Metric for the number of client-side errors captured in a given period.(experimental) Metric for the total number API requests in a given period.metricCount
(MetricOptions props) (experimental) Metric for the total number API requests in a given period.(experimental) Metric for the amount of data processed in bytes.metricDataProcessed
(MetricOptions props) (experimental) Metric for the amount of data processed in bytes.(experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.(experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.(experimental) The time between when API Gateway receives a request from a client and when it returns a response to the client.metricLatency
(MetricOptions props) (experimental) The time between when API Gateway receives a request from a client and when it returns a response to the client.(experimental) Metric for the number of server-side errors captured in a given period.metricServerError
(MetricOptions props) (experimental) Metric for the number of server-side errors captured in a given period.Methods inherited from class software.amazon.awscdk.core.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.constructs.Construct
toString
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.awscdk.core.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.core.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
HttpStage
protected HttpStage(software.amazon.jsii.JsiiObjectRef objRef) -
HttpStage
protected HttpStage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
HttpStage
@Stability(Experimental) public HttpStage(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull HttpStageProps props) - Parameters:
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.
-
-
Method Details
-
fromHttpStageAttributes
@Stability(Experimental) @NotNull public static IHttpStage fromHttpStageAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull HttpStageAttributes attrs) (experimental) Import an existing stage into this CDK app.- Parameters:
scope
- This parameter is required.id
- This parameter is required.attrs
- This parameter is required.
-
metric
@Stability(Experimental) @NotNull public Metric metric(@NotNull String metricName, @Nullable MetricOptions props) (experimental) Return the given named metric for this HTTP Api Gateway Stage. -
metric
(experimental) Return the given named metric for this HTTP Api Gateway Stage. -
metricClientError
(experimental) Metric for the number of client-side errors captured in a given period.- Specified by:
metricClientError
in interfaceIHttpStage
- Parameters:
props
-
-
metricClientError
(experimental) Metric for the number of client-side errors captured in a given period.- Specified by:
metricClientError
in interfaceIHttpStage
-
metricCount
(experimental) Metric for the total number API requests in a given period.- Specified by:
metricCount
in interfaceIHttpStage
- Parameters:
props
-
-
metricCount
(experimental) Metric for the total number API requests in a given period.- Specified by:
metricCount
in interfaceIHttpStage
-
metricDataProcessed
(experimental) Metric for the amount of data processed in bytes.- Specified by:
metricDataProcessed
in interfaceIHttpStage
- Parameters:
props
-
-
metricDataProcessed
(experimental) Metric for the amount of data processed in bytes.- Specified by:
metricDataProcessed
in interfaceIHttpStage
-
metricIntegrationLatency
@Stability(Experimental) @NotNull public Metric metricIntegrationLatency(@Nullable MetricOptions props) (experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.- Specified by:
metricIntegrationLatency
in interfaceIHttpStage
- Parameters:
props
-
-
metricIntegrationLatency
(experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.- Specified by:
metricIntegrationLatency
in interfaceIHttpStage
-
metricLatency
(experimental) 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.
- Specified by:
metricLatency
in interfaceIHttpStage
- Parameters:
props
-
-
metricLatency
(experimental) 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.
- Specified by:
metricLatency
in interfaceIHttpStage
-
metricServerError
(experimental) Metric for the number of server-side errors captured in a given period.- Specified by:
metricServerError
in interfaceIHttpStage
- Parameters:
props
-
-
metricServerError
(experimental) Metric for the number of server-side errors captured in a given period.- Specified by:
metricServerError
in interfaceIHttpStage
-
getApi
(experimental) The API this stage is associated to.- Specified by:
getApi
in interfaceIHttpStage
-
getBaseApi
-
getDomainUrl
(experimental) The custom domain URL to this stage.- Specified by:
getDomainUrl
in interfaceIHttpStage
-
getStageName
(experimental) The name of the stage;its primary identifier.
- Specified by:
getStageName
in interfaceIStage
-
getUrl
(experimental) The URL to this stage.
-