software.amazon.awscdk.services.apigateway

Class IRestApi.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigateway.IRestApi.Jsii$Proxy

All Implemented Interfaces:

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

Enclosing interface:

IRestApi

@Internal
public static final class IRestApi.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IRestApi.Jsii$Default

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

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.apigateway.IRestApi

IRestApi.Jsii$Default, IRestApi.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.
String	arnForExecuteApi() Gets the "execute-api" ARN.
String	arnForExecuteApi(String method) Gets the "execute-api" ARN.
String	arnForExecuteApi(String method, String path) Gets the "execute-api" ARN.
String	arnForExecuteApi(String method, String path, String stage) Gets the "execute-api" ARN.
Stage	getDeploymentStage() API Gateway stage that points to the latest deployment (if defined).
ResourceEnvironment	getEnv() The environment this resource belongs to.
Deployment	getLatestDeployment() API Gateway deployment that represents the latest changes of the API.
software.constructs.Node	getNode() The tree node.
String	getRestApiId() The ID of this API Gateway RestApi.
String	getRestApiName() The name of this API Gateway RestApi.
String	getRestApiRootResourceId() The resource ID of the root resource.
IResource	getRoot() Represents the root resource ("/") of this API.
Stack	getStack() The stack in which this resource is defined.
void	setDeploymentStage(Stage value) API Gateway stage that points to the latest deployment (if defined).

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 Detail

Jsii$Proxy

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

Method Detail

getNode

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

The tree node.

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface IRestApi.Jsii$Default

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

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

getEnv

@Stability(value=Stable)
 @NotNull
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 IRestApi.Jsii$Default

getStack

@Stability(value=Stable)
 @NotNull
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 IRestApi.Jsii$Default

getRestApiId

@Stability(value=Stable)
 @NotNull
public final String getRestApiId()

The ID of this API Gateway RestApi.

Specified by:

getRestApiId in interface IRestApi

Specified by:

getRestApiId in interface IRestApi.Jsii$Default

getRestApiName

@Stability(value=Stable)
 @NotNull
public final String getRestApiName()

The name of this API Gateway RestApi.

Specified by:

getRestApiName in interface IRestApi

Specified by:

getRestApiName in interface IRestApi.Jsii$Default

getRestApiRootResourceId

@Stability(value=Stable)
 @NotNull
public final String getRestApiRootResourceId()

The resource ID of the root resource.

Specified by:

getRestApiRootResourceId in interface IRestApi

Specified by:

getRestApiRootResourceId in interface IRestApi.Jsii$Default

getRoot

@Stability(value=Stable)
 @NotNull
public final IResource getRoot()

Represents the root resource ("/") of this API. Use it to define the API model:.

api.root.addMethod('ANY', redirectToHomePage); // "ANY /" api.root.addResource('friends').addMethod('GET', getFriendsHandler); // "GET /friends"

Specified by:

getRoot in interface IRestApi

Specified by:

getRoot in interface IRestApi.Jsii$Default

getLatestDeployment

@Stability(value=Stable)
 @Nullable
public final Deployment getLatestDeployment()

API Gateway deployment that represents the latest changes of the API.

This resource will be automatically updated every time the REST API model changes. undefined when no deployment is configured.

Specified by:

getLatestDeployment in interface IRestApi

Specified by:

getLatestDeployment in interface IRestApi.Jsii$Default

getDeploymentStage

@Stability(value=Stable)
 @NotNull
public final Stage getDeploymentStage()

API Gateway stage that points to the latest deployment (if defined).

Specified by:

getDeploymentStage in interface IRestApi

Specified by:

getDeploymentStage in interface IRestApi.Jsii$Default

setDeploymentStage

@Stability(value=Stable)
public final void setDeploymentStage(@NotNull
                                                              Stage value)

API Gateway stage that points to the latest deployment (if defined).

Specified by:

setDeploymentStage in interface IRestApi

Specified by:

setDeploymentStage in interface IRestApi.Jsii$Default

applyRemovalPolicy

@Stability(value=Stable)
public final 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

Specified by:

applyRemovalPolicy in interface IRestApi.Jsii$Default

Parameters:

policy - This parameter is required.

arnForExecuteApi

@Stability(value=Stable)
 @NotNull
public final String arnForExecuteApi(@Nullable
                                                                        String method,
                                                                        @Nullable
                                                                        String path,
                                                                        @Nullable
                                                                        String stage)

Gets the "execute-api" ARN.

Default: "*" returns the execute API ARN for all methods/resources in this API.

Specified by:

arnForExecuteApi in interface IRestApi

Specified by:

arnForExecuteApi in interface IRestApi.Jsii$Default

Parameters:

method - The method (default `*`).

path - The resource path.

stage - The stage (default `*`).

Returns:

The "execute-api" ARN.

arnForExecuteApi

@Stability(value=Stable)
 @NotNull
public final String arnForExecuteApi(@Nullable
                                                                        String method,
                                                                        @Nullable
                                                                        String path)

Gets the "execute-api" ARN.

Default: "*" returns the execute API ARN for all methods/resources in this API.

Specified by:

arnForExecuteApi in interface IRestApi

Parameters:

method - The method (default `*`).

path - The resource path.

Returns:

The "execute-api" ARN.

arnForExecuteApi

@Stability(value=Stable)
 @NotNull
public final String arnForExecuteApi(@Nullable
                                                                        String method)

Gets the "execute-api" ARN.

Default: "*" returns the execute API ARN for all methods/resources in this API.

Specified by:

arnForExecuteApi in interface IRestApi

Parameters:

method - The method (default `*`).

Returns:

The "execute-api" ARN.

arnForExecuteApi

@Stability(value=Stable)
 @NotNull
public final String arnForExecuteApi()

Gets the "execute-api" ARN.

Default: "*" returns the execute API ARN for all methods/resources in this API.

Specified by:

arnForExecuteApi in interface IRestApi

Returns:

The "execute-api" ARN.