software.amazon.awscdk.services.apigateway

Class IResource.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

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

Enclosing interface:

IResource

@Internal
public static final class IResource.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IResource.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.IResource

IResource.Jsii$Default, IResource.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
Method	addCorsPreflight(CorsOptions options) (experimental) Adds an OPTIONS method to this resource which responds to Cross-Origin Resource Sharing (CORS) preflight requests.
Method	addMethod(String httpMethod) (experimental) Defines a new method for this resource.
Method	addMethod(String httpMethod, Integration target) (experimental) Defines a new method for this resource.
Method	addMethod(String httpMethod, Integration target, MethodOptions options) (experimental) Defines a new method for this resource.
ProxyResource	addProxy() (experimental) Adds a greedy proxy resource ("{proxy+}") and an ANY method to this route.
ProxyResource	addProxy(ProxyResourceOptions options) (experimental) Adds a greedy proxy resource ("{proxy+}") and an ANY method to this route.
Resource	addResource(String pathPart) (experimental) Defines a new child resource where this resource is the parent.
Resource	addResource(String pathPart, ResourceOptions options) (experimental) Defines a new child resource where this resource is the parent.
IRestApi	getApi() (experimental) The rest API that this resource is part of.
CorsOptions	getDefaultCorsPreflightOptions() (experimental) Default options for CORS preflight OPTIONS method.
Integration	getDefaultIntegration() (experimental) An integration to use as a default for all methods created within this API unless an integration is specified.
MethodOptions	getDefaultMethodOptions() (experimental) Method options to use as a default for all methods created within this API unless custom options are specified.
ResourceEnvironment	getEnv() (experimental) The environment this resource belongs to.
software.constructs.Node	getNode() The tree node.
IResource	getParentResource() (experimental) The parent of this resource or undefined for the root resource.
String	getPath() (experimental) The full path of this resource.
IResource	getResource(String pathPart) (experimental) Retrieves a child resource by path part.
String	getResourceId() (experimental) The ID of the resource.
Stack	getStack() (experimental) The stack in which this resource is defined.
Resource	resourceForPath(String path) (experimental) Gets or create all resources leading up to the specified path.

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 software.constructs.IConstruct

Specified by:

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

getEnv

@Stability(value=Experimental)
 @NotNull
public final ResourceEnvironment getEnv()

(experimental) 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=Experimental)
 @NotNull
public final Stack getStack()

(experimental) The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getApi

@Stability(value=Experimental)
 @NotNull
public final IRestApi getApi()

(experimental) The rest API that this resource is part of.

The reason we need the RestApi object itself and not just the ID is because the model is being tracked by the top-level RestApi object for the purpose of calculating it's hash to determine the ID of the deployment. This allows us to automatically update the deployment when the model of the REST API changes.

getPath

@Stability(value=Experimental)
 @NotNull
public final String getPath()

(experimental) The full path of this resource.

getResourceId

@Stability(value=Experimental)
 @NotNull
public final String getResourceId()

(experimental) The ID of the resource.

getDefaultCorsPreflightOptions

@Stability(value=Experimental)
 @Nullable
public final CorsOptions getDefaultCorsPreflightOptions()

(experimental) Default options for CORS preflight OPTIONS method.

getDefaultIntegration

@Stability(value=Experimental)
 @Nullable
public final Integration getDefaultIntegration()

(experimental) An integration to use as a default for all methods created within this API unless an integration is specified.

getDefaultMethodOptions

@Stability(value=Experimental)
 @Nullable
public final MethodOptions getDefaultMethodOptions()

(experimental) Method options to use as a default for all methods created within this API unless custom options are specified.

getParentResource

@Stability(value=Experimental)
 @Nullable
public final IResource getParentResource()

(experimental) The parent of this resource or undefined for the root resource.

addCorsPreflight

@Stability(value=Experimental)
 @NotNull
public final Method addCorsPreflight(@NotNull
                                                                              CorsOptions options)

(experimental) Adds an OPTIONS method to this resource which responds to Cross-Origin Resource Sharing (CORS) preflight requests.

Cross-Origin Resource Sharing (CORS) is a mechanism that uses additional HTTP headers to tell browsers to give a web application running at one origin, access to selected resources from a different origin. A web application executes a cross-origin HTTP request when it requests a resource that has a different origin (domain, protocol, or port) from its own.

Parameters:

options - CORS options. This parameter is required.

Returns:

a `Method` object

See Also:

https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS

addMethod

@Stability(value=Experimental)
 @NotNull
public final Method addMethod(@NotNull
                                                                       String httpMethod,
                                                                       @Nullable
                                                                       Integration target,
                                                                       @Nullable
                                                                       MethodOptions options)

(experimental) Defines a new method for this resource.

Parameters:

httpMethod - The HTTP method. This parameter is required.

target - The target backend integration for this method.

options - Method options, such as authentication.

Returns:

The newly created `Method` object.

addMethod

@Stability(value=Experimental)
 @NotNull
public final Method addMethod(@NotNull
                                                                       String httpMethod,
                                                                       @Nullable
                                                                       Integration target)

(experimental) Defines a new method for this resource.

Parameters:

httpMethod - The HTTP method. This parameter is required.

target - The target backend integration for this method.

Returns:

The newly created `Method` object.

addMethod

@Stability(value=Experimental)
 @NotNull
public final Method addMethod(@NotNull
                                                                       String httpMethod)

(experimental) Defines a new method for this resource.

Parameters:

httpMethod - The HTTP method. This parameter is required.

Returns:

The newly created `Method` object.

addProxy

@Stability(value=Experimental)
 @NotNull
public final ProxyResource addProxy(@Nullable
                                                                             ProxyResourceOptions options)

(experimental) Adds a greedy proxy resource ("{proxy+}") and an ANY method to this route.

Parameters:

options - Default integration and method options.

addProxy

@Stability(value=Experimental)
 @NotNull
public final ProxyResource addProxy()

(experimental) Adds a greedy proxy resource ("{proxy+}") and an ANY method to this route.

addResource

@Stability(value=Experimental)
 @NotNull
public final Resource addResource(@NotNull
                                                                           String pathPart,
                                                                           @Nullable
                                                                           ResourceOptions options)

(experimental) Defines a new child resource where this resource is the parent.

Parameters:

pathPart - The path part for the child resource. This parameter is required.

options - Resource options.

Returns:

A Resource object

addResource

@Stability(value=Experimental)
 @NotNull
public final Resource addResource(@NotNull
                                                                           String pathPart)

(experimental) Defines a new child resource where this resource is the parent.

Parameters:

pathPart - The path part for the child resource. This parameter is required.

Returns:

A Resource object

getResource

@Stability(value=Experimental)
 @Nullable
public final IResource getResource(@NotNull
                                                                             String pathPart)

(experimental) Retrieves a child resource by path part.

Parameters:

pathPart - The path part of the child resource. This parameter is required.

Returns:

the child resource or undefined if not found

resourceForPath

@Stability(value=Experimental)
 @NotNull
public final Resource resourceForPath(@NotNull
                                                                               String path)

(experimental) Gets or create all resources leading up to the specified path.

• Path may only start with "/" if this method is called on the root resource.
• All resources are created using default options.

Parameters:

path - The relative path. This parameter is required.

Returns:

a new or existing resource.