software.amazon.awscdk.services.apigatewayv2

Class IHttpStage.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigatewayv2.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

Enclosing interface:

IHttpStage

public static final class IHttpStage.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IHttpStage.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IHttpStage

IHttpStage.Jsii$Default, IHttpStage.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
IHttpApi	getApi() (experimental) The API this stage is associated to.
java.lang.String	getDomainUrl() (experimental) The custom domain URL to this stage.
ResourceEnvironment	getEnv() The environment this resource belongs to.
ConstructNode	getNode() The construct tree node for this construct.
Stack	getStack() The stack in which this resource is defined.
java.lang.String	getStageName() (experimental) The name of the stage;
java.lang.String	getUrl() (experimental) The URL to this stage.
Metric	metric(java.lang.String metricName) (experimental) Return the given named metric for this HTTP Api Gateway Stage.
Metric	metric(java.lang.String metricName, MetricOptions props) (experimental) Return the given named metric for this HTTP Api Gateway Stage.
Metric	metricClientError() (experimental) Metric for the number of client-side errors captured in a given period.
Metric	metricClientError(MetricOptions props) (experimental) Metric for the number of client-side errors captured in a given period.
Metric	metricCount() (experimental) Metric for the total number API requests in a given period.
Metric	metricCount(MetricOptions props) (experimental) Metric for the total number API requests in a given period.
Metric	metricDataProcessed() (experimental) Metric for the amount of data processed in bytes.
Metric	metricDataProcessed(MetricOptions props) (experimental) Metric for the amount of data processed in bytes.
Metric	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.
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.
Metric	metricLatency() (experimental) 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) (experimental) The time between when API Gateway receives a request from a client and when it returns a response to the client.
Metric	metricServerError() (experimental) Metric for the number of server-side errors captured in a given period.
Metric	metricServerError(MetricOptions props) (experimental) Metric for the number of server-side errors captured in a given period.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Detail

getNode

public final ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IConstruct

Specified by:

getNode in interface IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface IHttpStage.Jsii$Default

Specified by:

getNode in interface IStage.Jsii$Default

getEnv

public final ResourceEnvironment 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 interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

Specified by:

getEnv in interface IHttpStage.Jsii$Default

Specified by:

getEnv in interface IStage.Jsii$Default

getStack

public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IHttpStage.Jsii$Default

Specified by:

getStack in interface IStage.Jsii$Default

getStageName

public final java.lang.String getStageName()

(experimental) The name of the stage;

its primary identifier.

Specified by:

getStageName in interface IHttpStage.Jsii$Default

Specified by:

getStageName in interface IStage

Specified by:

getStageName in interface IStage.Jsii$Default

getUrl

public final java.lang.String getUrl()

(experimental) The URL to this stage.

Specified by:

getUrl in interface IHttpStage.Jsii$Default

Specified by:

getUrl in interface IStage

Specified by:

getUrl in interface IStage.Jsii$Default

getApi

public final IHttpApi getApi()

(experimental) The API this stage is associated to.

Specified by:

getApi in interface IHttpStage

Specified by:

getApi in interface IHttpStage.Jsii$Default

getDomainUrl

public final java.lang.String getDomainUrl()

(experimental) The custom domain URL to this stage.

Specified by:

getDomainUrl in interface IHttpStage

Specified by:

getDomainUrl in interface IHttpStage.Jsii$Default

applyRemovalPolicy

public final void applyRemovalPolicy(RemovalPolicy policy)

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 interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Specified by:

applyRemovalPolicy in interface IHttpStage.Jsii$Default

Specified by:

applyRemovalPolicy in interface IStage.Jsii$Default

Parameters:

policy - This parameter is required.

metric

public final Metric metric(java.lang.String metricName,
                           MetricOptions props)

(experimental) Return the given named metric for this HTTP Api Gateway Stage.

Default: - average over 5 minutes

Specified by:

metric in interface IHttpStage.Jsii$Default

Specified by:

metric in interface IStage

Specified by:

metric in interface IStage.Jsii$Default

Parameters:

metricName - This parameter is required.

props -

metric

public final Metric metric(java.lang.String metricName)

(experimental) Return the given named metric for this HTTP Api Gateway Stage.

Default: - average over 5 minutes

Specified by:

metric in interface IStage

Parameters:

metricName - This parameter is required.

metricClientError

public final Metric metricClientError(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 interface IHttpStage

Specified by:

metricClientError in interface IHttpStage.Jsii$Default

Parameters:

props -

metricClientError

public final Metric metricClientError()

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

Default: - sum over 5 minutes

Specified by:

metricClientError in interface IHttpStage

metricCount

public final Metric metricCount(MetricOptions props)

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

Default: - SampleCount over 5 minutes

Specified by:

metricCount in interface IHttpStage

Specified by:

metricCount in interface IHttpStage.Jsii$Default

Parameters:

props -

metricCount

public final Metric metricCount()

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

Default: - SampleCount over 5 minutes

Specified by:

metricCount in interface IHttpStage

metricDataProcessed

public final Metric metricDataProcessed(MetricOptions props)

(experimental) Metric for the amount of data processed in bytes.

Default: - sum over 5 minutes

Specified by:

metricDataProcessed in interface IHttpStage

Specified by:

metricDataProcessed in interface IHttpStage.Jsii$Default

Parameters:

props -

metricDataProcessed

public final Metric metricDataProcessed()

(experimental) Metric for the amount of data processed in bytes.

Default: - sum over 5 minutes

Specified by:

metricDataProcessed in interface IHttpStage

metricIntegrationLatency

public final 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: - no statistic

Specified by:

metricIntegrationLatency in interface IHttpStage

Specified by:

metricIntegrationLatency in interface IHttpStage.Jsii$Default

Parameters:

props -

metricIntegrationLatency

public final Metric 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 interface IHttpStage

metricLatency

public 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.

The latency includes the integration latency and other API Gateway overhead.

Default: - no statistic

Specified by:

metricLatency in interface IHttpStage

Specified by:

metricLatency in interface IHttpStage.Jsii$Default

Parameters:

props -

metricLatency

public final Metric 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 interface IHttpStage

metricServerError

public final Metric metricServerError(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 interface IHttpStage

Specified by:

metricServerError in interface IHttpStage.Jsii$Default

Parameters:

props -

metricServerError

public final Metric metricServerError()

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

Default: - sum over 5 minutes

Specified by:

metricServerError in interface IHttpStage