Class StageBase
- All Implemented Interfaces:
IResource
,IStage
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
- Direct Known Subclasses:
Stage
-
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.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.IStage
IStage.Jsii$Default
-
Constructor Summary
ModifierConstructorDescriptionprotected
StageBase
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
StageBase
(software.amazon.jsii.JsiiObjectRef objRef) protected
protected
StageBase
(software.constructs.Construct scope, String id, ResourceProps props) -
Method Summary
Modifier and TypeMethodDescriptionAdd an ApiKey to this stage.addApiKey
(String id, ApiKeyOptions options) Add an ApiKey to this stage.abstract IRestApi
RestApi to which this stage is associated.Returns the resource ARN for this stage:.abstract String
Name of this stage.Returns the given named metric for this stage.metric
(String metricName, MetricOptions props) Returns the given named metric for this stage.Metric for the number of requests served from the API cache in a given period.metricCacheHitCount
(MetricOptions props) Metric for the number of requests served from the API cache in a given period.Metric for the number of requests served from the backend in a given period, when API caching is enabled.Metric for the number of requests served from the backend in a given period, when API caching is enabled.Metric for the number of client-side errors captured in a given period.metricClientError
(MetricOptions props) Metric for the number of client-side errors captured in a given period.Metric for the total number API requests in a given period.metricCount
(MetricOptions props) Metric for the total number API requests in a given period.Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.The time between when API Gateway receives a request from a client and when it returns a response to the client.metricLatency
(MetricOptions props) The time between when API Gateway receives a request from a client and when it returns a response to the client.Metric for the number of server-side errors captured in a given period.metricServerError
(MetricOptions props) Metric for the number of server-side errors captured in a given period.Returns the invoke URL for a certain path.urlForPath
(String path) Returns the invoke URL for a certain path.Methods inherited from class software.amazon.awscdk.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource
Methods inherited from class software.constructs.Construct
getNode, isConstruct, 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.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
StageBase
protected StageBase(software.amazon.jsii.JsiiObjectRef objRef) -
StageBase
protected StageBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
StageBase
@Stability(Stable) protected StageBase(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable ResourceProps props) - Parameters:
scope
- This parameter is required.id
- This parameter is required.props
-
-
StageBase
@Stability(Stable) protected StageBase(@NotNull software.constructs.Construct scope, @NotNull String id) - Parameters:
scope
- This parameter is required.id
- This parameter is required.
-
-
Method Details
-
addApiKey
@Stability(Stable) @NotNull public IApiKey addApiKey(@NotNull String id, @Nullable ApiKeyOptions options) Add an ApiKey to this stage. -
addApiKey
Add an ApiKey to this stage. -
metric
@Stability(Stable) @NotNull public Metric metric(@NotNull String metricName, @Nullable MetricOptions props) Returns the given named metric for this stage.- Parameters:
metricName
- This parameter is required.props
-
-
metric
Returns the given named metric for this stage.- Parameters:
metricName
- This parameter is required.
-
metricCacheHitCount
Metric for the number of requests served from the API cache in a given period.Default: - sum over 5 minutes
- Parameters:
props
-
-
metricCacheHitCount
Metric for the number of requests served from the API cache in a given period.Default: - sum over 5 minutes
-
metricCacheMissCount
Metric for the number of requests served from the backend in a given period, when API caching is enabled.Default: - sum over 5 minutes
- Parameters:
props
-
-
metricCacheMissCount
Metric for the number of requests served from the backend in a given period, when API caching is enabled.Default: - sum over 5 minutes
-
metricClientError
Metric for the number of client-side errors captured in a given period.Default: - sum over 5 minutes
- Parameters:
props
-
-
metricClientError
Metric for the number of client-side errors captured in a given period.Default: - sum over 5 minutes
-
metricCount
Metric for the total number API requests in a given period.Default: - sample count over 5 minutes
- Parameters:
props
-
-
metricCount
Metric for the total number API requests in a given period.Default: - sample count over 5 minutes
-
metricIntegrationLatency
Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.Default: - average over 5 minutes.
- Parameters:
props
-
-
metricIntegrationLatency
Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.Default: - average over 5 minutes.
-
metricLatency
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: - average over 5 minutes.
- Parameters:
props
-
-
metricLatency
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: - average over 5 minutes.
-
metricServerError
Metric for the number of server-side errors captured in a given period.Default: - sum over 5 minutes
- Parameters:
props
-
-
metricServerError
Metric for the number of server-side errors captured in a given period.Default: - sum over 5 minutes
-
urlForPath
Returns the invoke URL for a certain path.- Parameters:
path
- The resource path.
-
urlForPath
Returns the invoke URL for a certain path. -
getRestApi
RestApi to which this stage is associated.- Specified by:
getRestApi
in interfaceIStage
-
getStageArn
Returns the resource ARN for this stage:.arn:aws:apigateway:{region}::/restapis/{restApiId}/stages/{stageName}
Note that this is separate from the execute-api ARN for methods and resources within this stage.
-
getStageName
Name of this stage.- Specified by:
getStageName
in interfaceIStage
-