Class IHttpStage.Jsii$Proxy
- All Implemented Interfaces:
IConstruct
,IConstruct.Jsii$Default
,IDependable
,IDependable.Jsii$Default
,IResource
,IResource.Jsii$Default
,IHttpStage
,IHttpStage.Jsii$Default
,IStage
,IStage.Jsii$Default
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IConstruct.Jsii$Default
- Enclosing interface:
IHttpStage
-
Nested Class Summary
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, IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IDependable
IDependable.Jsii$Default, IDependable.Jsii$Proxy
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, IResource.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IStage
IStage.Jsii$Default, IStage.Jsii$Proxy
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal void
applyRemovalPolicy
(RemovalPolicy policy) Apply the given removal policy to this resource.final IHttpApi
getApi()
(experimental) The API this stage is associated to.final String
(experimental) The custom domain URL to this stage.final ResourceEnvironment
getEnv()
The environment this resource belongs to.final ConstructNode
getNode()
The construct tree node for this construct.final Stack
getStack()
The stack in which this resource is defined.final String
(experimental) The name of the stage;final String
getUrl()
(experimental) The URL to this stage.final Metric
(experimental) Return the given named metric for this HTTP Api Gateway Stage.final Metric
metric
(String metricName, MetricOptions props) (experimental) Return the given named metric for this HTTP Api Gateway Stage.final Metric
(experimental) Metric for the number of client-side errors captured in a given period.final Metric
metricClientError
(MetricOptions props) (experimental) Metric for the number of client-side errors captured in a given period.final Metric
(experimental) Metric for the total number API requests in a given period.final Metric
metricCount
(MetricOptions props) (experimental) Metric for the total number API requests in a given period.final Metric
(experimental) Metric for the amount of data processed in bytes.final Metric
metricDataProcessed
(MetricOptions props) (experimental) Metric for the amount of data processed in bytes.final Metric
(experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.final Metric
(experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.final Metric
(experimental) The time between when API Gateway receives a request from a client and when it returns a response to the client.final Metric
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.final Metric
(experimental) Metric for the number of server-side errors captured in a given period.final Metric
metricServerError
(MetricOptions props) (experimental) Metric for the number of server-side errors captured in a given period.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, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
-
-
Method Details
-
getNode
The construct tree node for this construct.- Specified by:
getNode
in interfaceIConstruct
- Specified by:
getNode
in interfaceIConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIHttpStage.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
- Specified by:
getNode
in interfaceIStage.Jsii$Default
-
getEnv
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.
- Specified by:
getEnv
in interfaceIHttpStage.Jsii$Default
- Specified by:
getEnv
in interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
- Specified by:
getEnv
in interfaceIStage.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIHttpStage.Jsii$Default
- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
- Specified by:
getStack
in interfaceIStage.Jsii$Default
-
getStageName
(experimental) The name of the stage;its primary identifier.
- Specified by:
getStageName
in interfaceIHttpStage.Jsii$Default
- Specified by:
getStageName
in interfaceIStage
- Specified by:
getStageName
in interfaceIStage.Jsii$Default
-
getUrl
(experimental) The URL to this stage.- Specified by:
getUrl
in interfaceIHttpStage.Jsii$Default
- Specified by:
getUrl
in interfaceIStage
- Specified by:
getUrl
in interfaceIStage.Jsii$Default
-
getApi
(experimental) The API this stage is associated to.- Specified by:
getApi
in interfaceIHttpStage
- Specified by:
getApi
in interfaceIHttpStage.Jsii$Default
-
getDomainUrl
(experimental) The custom domain URL to this stage.- Specified by:
getDomainUrl
in interfaceIHttpStage
- Specified by:
getDomainUrl
in interfaceIHttpStage.Jsii$Default
-
applyRemovalPolicy
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
).- Specified by:
applyRemovalPolicy
in interfaceIHttpStage.Jsii$Default
- Specified by:
applyRemovalPolicy
in interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Specified by:
applyRemovalPolicy
in interfaceIStage.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
metric
@Stability(Experimental) @NotNull public final Metric metric(@NotNull String metricName, @Nullable MetricOptions props) (experimental) Return the given named metric for this HTTP Api Gateway Stage.Default: - average over 5 minutes
- Specified by:
metric
in interfaceIHttpStage.Jsii$Default
- Specified by:
metric
in interfaceIStage
- Specified by:
metric
in interfaceIStage.Jsii$Default
- Parameters:
metricName
- This parameter is required.props
-
-
metric
(experimental) Return the given named metric for this HTTP Api Gateway Stage.Default: - average over 5 minutes
-
metricClientError
@Stability(Experimental) @NotNull public final Metric metricClientError(@Nullable MetricOptions props) (experimental) Metric for the number of client-side errors captured in a given period.Default: - sum over 5 minutes
- Specified by:
metricClientError
in interfaceIHttpStage
- Specified by:
metricClientError
in interfaceIHttpStage.Jsii$Default
- Parameters:
props
-
-
metricClientError
(experimental) Metric for the number of client-side errors captured in a given period.Default: - sum over 5 minutes
- Specified by:
metricClientError
in interfaceIHttpStage
-
metricCount
(experimental) Metric for the total number API requests in a given period.Default: - SampleCount over 5 minutes
- Specified by:
metricCount
in interfaceIHttpStage
- Specified by:
metricCount
in interfaceIHttpStage.Jsii$Default
- Parameters:
props
-
-
metricCount
(experimental) Metric for the total number API requests in a given period.Default: - SampleCount over 5 minutes
- Specified by:
metricCount
in interfaceIHttpStage
-
metricDataProcessed
@Stability(Experimental) @NotNull public final Metric metricDataProcessed(@Nullable MetricOptions props) (experimental) Metric for the amount of data processed in bytes.Default: - sum over 5 minutes
- Specified by:
metricDataProcessed
in interfaceIHttpStage
- Specified by:
metricDataProcessed
in interfaceIHttpStage.Jsii$Default
- Parameters:
props
-
-
metricDataProcessed
(experimental) Metric for the amount of data processed in bytes.Default: - sum over 5 minutes
- Specified by:
metricDataProcessed
in interfaceIHttpStage
-
metricIntegrationLatency
@Stability(Experimental) @NotNull public final 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.Default: - no statistic
- Specified by:
metricIntegrationLatency
in interfaceIHttpStage
- Specified by:
metricIntegrationLatency
in interfaceIHttpStage.Jsii$Default
- 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.Default: - no statistic
- 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.
Default: - no statistic
- Specified by:
metricLatency
in interfaceIHttpStage
- Specified by:
metricLatency
in interfaceIHttpStage.Jsii$Default
- 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.
Default: - no statistic
- Specified by:
metricLatency
in interfaceIHttpStage
-
metricServerError
@Stability(Experimental) @NotNull public final Metric metricServerError(@Nullable MetricOptions props) (experimental) Metric for the number of server-side errors captured in a given period.Default: - sum over 5 minutes
- Specified by:
metricServerError
in interfaceIHttpStage
- Specified by:
metricServerError
in interfaceIHttpStage.Jsii$Default
- Parameters:
props
-
-
metricServerError
(experimental) Metric for the number of server-side errors captured in a given period.Default: - sum over 5 minutes
- Specified by:
metricServerError
in interfaceIHttpStage
-