Uses of Interface
software.amazon.awscdk.services.apigateway.IStage
-
Uses of IStage in software.amazon.awscdk.services.apigateway
Modifier and TypeInterfaceDescriptionstatic interface
Internal default implementation forIStage
.Modifier and TypeClassDescriptionstatic final class
A proxy class which represents a concrete javascript instance of this type.class
Example:class
Base class for an ApiGateway Stage.Modifier and TypeMethodDescriptionstatic IStage
Stage.fromStageAttributes
(software.constructs.Construct scope, String id, StageAttributes attrs) Import a Stage by its attributes.Modifier and TypeMethodDescriptionApiKeyProps.getStages()
A list of Stages this api key is associated with.ApiKeyProps.Jsii$Proxy.getStages()
RateLimitedApiKeyProps.Jsii$Proxy.getStages()
Modifier and TypeMethodDescriptionvoid
DomainName.addApiMapping
(IStage targetStage) Maps this domain to an API endpoint.void
DomainName.addApiMapping
(IStage targetStage, ApiMappingOptions options) Maps this domain to an API endpoint.Binds this destination to the Firehose delivery stream.Binds this destination to the RestApi Stage.default AccessLogDestinationConfig
Binds this destination to the RestApi Stage.Binds this destination to the RestApi Stage.Binds this destination to the CloudWatch Logs.Returns the given named metric for this API method.Method.metric
(String metricName, IStage stage, MetricOptions props) Returns the given named metric for this API method.Method.metricCacheHitCount
(IStage stage) Metric for the number of requests served from the API cache in a given period.Method.metricCacheHitCount
(IStage stage, MetricOptions props) Metric for the number of requests served from the API cache in a given period.Method.metricCacheMissCount
(IStage stage) Metric for the number of requests served from the backend in a given period, when API caching is enabled.Method.metricCacheMissCount
(IStage stage, MetricOptions props) Metric for the number of requests served from the backend in a given period, when API caching is enabled.Method.metricClientError
(IStage stage) Metric for the number of client-side errors captured in a given period.Method.metricClientError
(IStage stage, MetricOptions props) Metric for the number of client-side errors captured in a given period.Method.metricCount
(IStage stage) Metric for the total number API requests in a given period.Method.metricCount
(IStage stage, MetricOptions props) Metric for the total number API requests in a given period.Method.metricIntegrationLatency
(IStage stage) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.Method.metricIntegrationLatency
(IStage stage, MetricOptions props) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.Method.metricLatency
(IStage stage) The time between when API Gateway receives a request from a client and when it returns a response to the client.Method.metricLatency
(IStage stage, MetricOptions props) The time between when API Gateway receives a request from a client and when it returns a response to the client.Method.metricServerError
(IStage stage) Metric for the number of server-side errors captured in a given period.Method.metricServerError
(IStage stage, MetricOptions props) Metric for the number of server-side errors captured in a given period.Modifier and TypeMethodDescriptionA list of Stages this api key is associated with.Sets the value ofApiKeyProps.getStages()
A list of Stages this api key is associated with.Sets the value ofApiKeyProps.getStages()