public static interface IHttpStage.Jsii$Default extends IHttpStage, IStage.Jsii$Default
IHttpStage
.IHttpStage.Jsii$Default, IHttpStage.Jsii$Proxy
Modifier and Type | Method and Description |
---|---|
default void |
applyRemovalPolicy(RemovalPolicy policy)
Apply the given removal policy to this resource.
|
default IHttpApi |
getApi()
(experimental) The API this stage is associated to.
|
default java.lang.String |
getDomainUrl()
(experimental) The custom domain URL to this stage.
|
default ResourceEnvironment |
getEnv()
The environment this resource belongs to.
|
default ConstructNode |
getNode()
The construct tree node for this construct.
|
default Stack |
getStack()
The stack in which this resource is defined.
|
default java.lang.String |
getStageName()
(experimental) The name of the stage;
|
default java.lang.String |
getUrl()
(experimental) The URL to this stage.
|
default Metric |
metric(java.lang.String metricName,
MetricOptions props)
(experimental) Return the given named metric for this HTTP Api Gateway Stage.
|
default Metric |
metricClientError(MetricOptions props)
(experimental) Metric for the number of client-side errors captured in a given period.
|
default Metric |
metricCount(MetricOptions props)
(experimental) Metric for the total number API requests in a given period.
|
default Metric |
metricDataProcessed(MetricOptions props)
(experimental) Metric for the amount of data processed in bytes.
|
default Metric |
metricIntegrationLatency(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 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.
|
default Metric |
metricServerError(MetricOptions props)
(experimental) Metric for the number of server-side errors captured in a given period.
|
metricClientError, metricCount, metricDataProcessed, metricIntegrationLatency, metricLatency, metricServerError
default ConstructNode getNode()
getNode
in interface IConstruct
getNode
in interface IConstruct.Jsii$Default
getNode
in interface IResource.Jsii$Default
getNode
in interface IStage.Jsii$Default
default ResourceEnvironment getEnv()
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.
getEnv
in interface IResource
getEnv
in interface IResource.Jsii$Default
getEnv
in interface IStage.Jsii$Default
default Stack getStack()
getStack
in interface IResource
getStack
in interface IResource.Jsii$Default
getStack
in interface IStage.Jsii$Default
default java.lang.String getStageName()
its primary identifier.
getStageName
in interface IStage
getStageName
in interface IStage.Jsii$Default
default java.lang.String getUrl()
getUrl
in interface IStage
getUrl
in interface IStage.Jsii$Default
default IHttpApi getApi()
getApi
in interface IHttpStage
default java.lang.String getDomainUrl()
getDomainUrl
in interface IHttpStage
default void applyRemovalPolicy(RemovalPolicy policy)
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
).
applyRemovalPolicy
in interface IResource
applyRemovalPolicy
in interface IResource.Jsii$Default
applyRemovalPolicy
in interface IStage.Jsii$Default
policy
- This parameter is required.default Metric metric(java.lang.String metricName, MetricOptions props)
Default: - average over 5 minutes
metric
in interface IStage
metric
in interface IStage.Jsii$Default
metricName
- This parameter is required.props
- default Metric metricClientError(MetricOptions props)
Default: - sum over 5 minutes
metricClientError
in interface IHttpStage
props
- default Metric metricCount(MetricOptions props)
Default: - SampleCount over 5 minutes
metricCount
in interface IHttpStage
props
- default Metric metricDataProcessed(MetricOptions props)
Default: - sum over 5 minutes
metricDataProcessed
in interface IHttpStage
props
- default Metric metricIntegrationLatency(MetricOptions props)
Default: - no statistic
metricIntegrationLatency
in interface IHttpStage
props
- default Metric metricLatency(MetricOptions props)
The latency includes the integration latency and other API Gateway overhead.
Default: - no statistic
metricLatency
in interface IHttpStage
props
- default Metric metricServerError(MetricOptions props)
Default: - sum over 5 minutes
metricServerError
in interface IHttpStage
props
-