software.amazon.awscdk.services.apigatewayv2.alpha

Interface IApi.Jsii$Default

All Superinterfaces:

IApi, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IHttpApi.Jsii$Default, IWebSocketApi.Jsii$Default

All Known Implementing Classes:

IApi.Jsii$Proxy, IHttpApi.Jsii$Proxy, IWebSocketApi.Jsii$Proxy

Enclosing interface:

IApi

@Internal
public static interface IApi.Jsii$Default
extends IApi, IResource.Jsii$Default

Internal default implementation for IApi.

Nested Class Summary

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

IApi.Jsii$Default, IApi.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
default String	getApiEndpoint() (experimental) The default endpoint for an API.
default String	getApiId() (experimental) The identifier of this API Gateway API.
default ResourceEnvironment	getEnv() The environment this resource belongs to.
default software.constructs.Node	getNode() The tree node.
default Stack	getStack() The stack in which this resource is defined.
default Metric	metric(String metricName, MetricOptions props) (experimental) Return the given named metric for this Api Gateway.

Methods inherited from interface software.amazon.awscdk.services.apigatewayv2.alpha.IApi

metric

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

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

getStack

@Stability(value=Stable)
 @NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getApiEndpoint

@Stability(value=Experimental)
 @NotNull
default String getApiEndpoint()

(experimental) The default endpoint for an API.

Specified by:

getApiEndpoint in interface IApi

getApiId

@Stability(value=Experimental)
 @NotNull
default String getApiId()

(experimental) The identifier of this API Gateway API.

Specified by:

getApiId in interface IApi

applyRemovalPolicy

@Stability(value=Stable)
default void applyRemovalPolicy(@NotNull
                                                         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

Parameters:

policy - This parameter is required.

metric

@Stability(value=Experimental)
 @NotNull
default Metric metric(@NotNull
                                                               String metricName,
                                                               @Nullable
                                                               MetricOptions props)

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

Default: - average over 5 minutes

Specified by:

metric in interface IApi

Parameters:

metricName - This parameter is required.

props -