Interface IStage.Jsii$Default
- All Superinterfaces:
software.constructs.IConstruct
,software.constructs.IConstruct.Jsii$Default
,software.constructs.IDependable
,software.constructs.IDependable.Jsii$Default
,IResource
,IResource.Jsii$Default
,IStage
,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
IStage.Jsii$Proxy
- Enclosing interface:
IStage
IStage
.-
Nested Class Summary
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.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.IStage
IStage.Jsii$Default, IStage.Jsii$Proxy
-
Method Summary
Modifier and TypeMethodDescriptiondefault IApiKey
addApiKey
(String id, ApiKeyOptions options) Add an ApiKey to this Stage.default void
applyRemovalPolicy
(RemovalPolicy policy) Apply the given removal policy to this resource.default ResourceEnvironment
getEnv()
The environment this resource belongs to.default software.constructs.Node
getNode()
The tree node.default IRestApi
RestApi to which this stage is associated.default Stack
getStack()
The stack in which this resource is defined.default String
Name of this stage.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getNode
@Stability(Stable) @NotNull default software.constructs.Node getNode()The tree node.- Specified by:
getNode
in interfacesoftware.constructs.IConstruct
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct.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 interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
-
getRestApi
RestApi to which this stage is associated.- Specified by:
getRestApi
in interfaceIStage
-
getStageName
Name of this stage.- Specified by:
getStageName
in interfaceIStage
-
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 interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
addApiKey
@Stability(Stable) @NotNull default IApiKey addApiKey(@NotNull String id, @Nullable ApiKeyOptions options) Add an ApiKey to this Stage.
-