software.amazon.awscdk.services.apigateway

Class Stage

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.apigateway.Stage

All Implemented Interfaces:

IResource, IStage, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.217Z")
 @Stability(value=Stable)
public class Stage
extends Resource
implements IStage

Example:

 // production stage
 LogGroup prdLogGroup = new LogGroup(this, "PrdLogs");
 RestApi api = RestApi.Builder.create(this, "books")
         .deployOptions(StageOptions.builder()
                 .accessLogDestination(new LogGroupLogDestination(prdLogGroup))
                 .accessLogFormat(AccessLogFormat.jsonWithStandardFields())
                 .build())
         .build();
 Deployment deployment = Deployment.Builder.create(this, "Deployment").api(api).build();
 // development stage
 LogGroup devLogGroup = new LogGroup(this, "DevLogs");
 Stage.Builder.create(this, "dev")
         .deployment(deployment)
         .accessLogDestination(new LogGroupLogDestination(devLogGroup))
         .accessLogFormat(AccessLogFormat.jsonWithStandardFields(JsonWithStandardFieldProps.builder()
                 .caller(false)
                 .httpMethod(true)
                 .ip(true)
                 .protocol(true)
                 .requestTime(true)
                 .resourcePath(true)
                 .responseLength(true)
                 .status(true)
                 .user(true)
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Stage.Builder A fluent builder for Stage.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.IStage

IStage.Jsii$Default, IStage.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	Stage(software.constructs.Construct scope, String id, StageProps props)
protected	Stage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Stage(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
IRestApi	getRestApi() RestApi to which this stage is associated.
String	getStageArn() Returns the resource ARN for this stage:.
String	getStageName() Name of this stage.
Metric	metric(String metricName) Returns the given named metric for this stage.
Metric	metric(String metricName, MetricOptions props) Returns the given named metric for this stage.
Metric	metricCacheHitCount() Metric for the number of requests served from the API cache in a given period.
Metric	metricCacheHitCount(MetricOptions props) Metric for the number of requests served from the API cache in a given period.
Metric	metricCacheMissCount() Metric for the number of requests served from the backend in a given period, when API caching is enabled.
Metric	metricCacheMissCount(MetricOptions props) Metric for the number of requests served from the backend in a given period, when API caching is enabled.
Metric	metricClientError() Metric for the number of client-side errors captured in a given period.
Metric	metricClientError(MetricOptions props) Metric for the number of client-side errors captured in a given period.
Metric	metricCount() Metric for the total number API requests in a given period.
Metric	metricCount(MetricOptions props) Metric for the total number API requests in a given period.
Metric	metricIntegrationLatency() Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.
Metric	metricIntegrationLatency(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.
Metric	metricLatency() The time between when API Gateway receives a request from a client and when it returns a response to the client.
Metric	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	metricServerError() Metric for the number of server-side errors captured in a given period.
Metric	metricServerError(MetricOptions props) Metric for the number of server-side errors captured in a given period.
String	urlForPath() Returns the invoke URL for a certain path.
String	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.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Stage

protected Stage(software.amazon.jsii.JsiiObjectRef objRef)

Stage

protected Stage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Stage

@Stability(value=Stable)
public Stage(@NotNull
                                      software.constructs.Construct scope,
                                      @NotNull
                                      String id,
                                      @NotNull
                                      StageProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

metric

@Stability(value=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

@Stability(value=Stable)
 @NotNull
public Metric metric(@NotNull
                                                        String metricName)

Returns the given named metric for this stage.

Parameters:

metricName - This parameter is required.

metricCacheHitCount

@Stability(value=Stable)
 @NotNull
public Metric metricCacheHitCount(@Nullable
                                                                     MetricOptions props)

Metric for the number of requests served from the API cache in a given period.

Default: - sum over 5 minutes

Parameters:

props -

metricCacheHitCount

@Stability(value=Stable)
 @NotNull
public Metric metricCacheHitCount()

Metric for the number of requests served from the API cache in a given period.

Default: - sum over 5 minutes

metricCacheMissCount

@Stability(value=Stable)
 @NotNull
public Metric metricCacheMissCount(@Nullable
                                                                      MetricOptions props)

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

@Stability(value=Stable)
 @NotNull
public Metric 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

@Stability(value=Stable)
 @NotNull
public Metric metricClientError(@Nullable
                                                                   MetricOptions props)

Metric for the number of client-side errors captured in a given period.

Default: - sum over 5 minutes

Parameters:

props -

metricClientError

@Stability(value=Stable)
 @NotNull
public Metric metricClientError()

Metric for the number of client-side errors captured in a given period.

Default: - sum over 5 minutes

metricCount

@Stability(value=Stable)
 @NotNull
public Metric metricCount(@Nullable
                                                             MetricOptions props)

Metric for the total number API requests in a given period.

Default: - sample count over 5 minutes

Parameters:

props -

metricCount

@Stability(value=Stable)
 @NotNull
public Metric metricCount()

Metric for the total number API requests in a given period.

Default: - sample count over 5 minutes

metricIntegrationLatency

@Stability(value=Stable)
 @NotNull
public Metric metricIntegrationLatency(@Nullable
                                                                          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.

Default: - average over 5 minutes.

Parameters:

props -

metricIntegrationLatency

@Stability(value=Stable)
 @NotNull
public Metric 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

@Stability(value=Stable)
 @NotNull
public Metric metricLatency(@Nullable
                                                               MetricOptions props)

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

@Stability(value=Stable)
 @NotNull
public Metric 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

@Stability(value=Stable)
 @NotNull
public Metric metricServerError(@Nullable
                                                                   MetricOptions props)

Metric for the number of server-side errors captured in a given period.

Default: - sum over 5 minutes

Parameters:

props -

metricServerError

@Stability(value=Stable)
 @NotNull
public Metric metricServerError()

Metric for the number of server-side errors captured in a given period.

Default: - sum over 5 minutes

urlForPath

@Stability(value=Stable)
 @NotNull
public String urlForPath(@Nullable
                                                            String path)

Returns the invoke URL for a certain path.

Parameters:

path - The resource path.

urlForPath

@Stability(value=Stable)
 @NotNull
public String urlForPath()

Returns the invoke URL for a certain path.

getRestApi

@Stability(value=Stable)
 @NotNull
public IRestApi getRestApi()

RestApi to which this stage is associated.

Specified by:

getRestApi in interface IStage

getStageArn

@Stability(value=Stable)
 @NotNull
public String 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

@Stability(value=Stable)
 @NotNull
public String getStageName()

Name of this stage.

Specified by:

getStageName in interface IStage