Class IApi.Jsii$Proxy
- All Implemented Interfaces:
IConstruct
,IConstruct.Jsii$Default
,IDependable
,IDependable.Jsii$Default
,IResource
,IResource.Jsii$Default
,IApi
,IApi.Jsii$Default
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IConstruct.Jsii$Default
- Enclosing interface:
IApi
-
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.amazon.awscdk.services.apigatewayv2.IApi
IApi.Jsii$Default, IApi.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default, IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IDependable
IDependable.Jsii$Default, IDependable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal void
applyRemovalPolicy
(RemovalPolicy policy) Apply the given removal policy to this resource.final String
(experimental) The default endpoint for an API.final String
getApiId()
(experimental) The identifier of this API Gateway API.final ResourceEnvironment
getEnv()
The environment this resource belongs to.final ConstructNode
getNode()
The construct tree node for this construct.final Stack
getStack()
The stack in which this resource is defined.final Metric
(experimental) Return the given named metric for this Api Gateway.final Metric
metric
(String metricName, MetricOptions props) (experimental) Return the given named metric for this Api Gateway.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, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
-
-
Method Details
-
getNode
The construct tree node for this construct.- Specified by:
getNode
in interfaceIApi.Jsii$Default
- Specified by:
getNode
in interfaceIConstruct
- Specified by:
getNode
in interfaceIConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
-
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 interfaceIApi.Jsii$Default
- Specified by:
getEnv
in interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIApi.Jsii$Default
- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
-
getApiEndpoint
(experimental) The default endpoint for an API.- Specified by:
getApiEndpoint
in interfaceIApi
- Specified by:
getApiEndpoint
in interfaceIApi.Jsii$Default
-
getApiId
(experimental) The identifier of this API Gateway API.- Specified by:
getApiId
in interfaceIApi
- Specified by:
getApiId
in interfaceIApi.Jsii$Default
-
applyRemovalPolicy
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 interfaceIApi.Jsii$Default
- Specified by:
applyRemovalPolicy
in interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
metric
@Stability(Experimental) @NotNull public final 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 interfaceIApi
- Specified by:
metric
in interfaceIApi.Jsii$Default
- Parameters:
metricName
- This parameter is required.props
-
-
metric
(experimental) Return the given named metric for this Api Gateway.Default: - average over 5 minutes
-