public static interface IRestApi.Jsii$Default extends IRestApi, IResource.Jsii$Default
IRestApi
.IRestApi.Jsii$Default, IRestApi.Jsii$Proxy
Modifier and Type | Method and Description |
---|---|
default void |
applyRemovalPolicy(RemovalPolicy policy)
Apply the given removal policy to this resource.
|
default java.lang.String |
arnForExecuteApi(java.lang.String method,
java.lang.String path,
java.lang.String stage)
Gets the "execute-api" ARN.
|
default Stage |
getDeploymentStage()
API Gateway stage that points to the latest deployment (if defined).
|
default ResourceEnvironment |
getEnv()
The environment this resource belongs to.
|
default Deployment |
getLatestDeployment()
API Gateway deployment that represents the latest changes of the API.
|
default ConstructNode |
getNode()
The construct tree node for this construct.
|
default java.lang.String |
getRestApiId()
The ID of this API Gateway RestApi.
|
default java.lang.String |
getRestApiRootResourceId()
The resource ID of the root resource.
|
default IResource |
getRoot()
Represents the root resource ("/") of this API.
|
default Stack |
getStack()
The stack in which this resource is defined.
|
default void |
setDeploymentStage(Stage value)
API Gateway stage that points to the latest deployment (if defined).
|
arnForExecuteApi, arnForExecuteApi, arnForExecuteApi
default ConstructNode getNode()
getNode
in interface IConstruct
getNode
in interface IConstruct.Jsii$Default
getNode
in interface IResource.Jsii$Default
default ResourceEnvironment getEnv()
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.
getEnv
in interface IResource
getEnv
in interface IResource.Jsii$Default
default Stack getStack()
getStack
in interface IResource
getStack
in interface IResource.Jsii$Default
default java.lang.String getRestApiId()
getRestApiId
in interface IRestApi
default java.lang.String getRestApiRootResourceId()
getRestApiRootResourceId
in interface IRestApi
default IResource getRoot()
api.root.addMethod('ANY', redirectToHomePage); // "ANY /" api.root.addResource('friends').addMethod('GET', getFriendsHandler); // "GET /friends"
default Deployment getLatestDeployment()
This resource will be automatically updated every time the REST API model changes.
undefined
when no deployment is configured.
getLatestDeployment
in interface IRestApi
default Stage getDeploymentStage()
getDeploymentStage
in interface IRestApi
default void setDeploymentStage(Stage value)
setDeploymentStage
in interface IRestApi
default void applyRemovalPolicy(RemovalPolicy policy)
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
).
applyRemovalPolicy
in interface IResource
applyRemovalPolicy
in interface IResource.Jsii$Default
policy
- This parameter is required.default java.lang.String arnForExecuteApi(java.lang.String method, java.lang.String path, java.lang.String stage)
Default: "*" returns the execute API ARN for all methods/resources in this API.
arnForExecuteApi
in interface IRestApi
method
- The method (default `*`).path
- The resource path.stage
- The stage (default `*`).