IResource.Jsii$Proxy

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.apigateway.IResource.Jsii$Proxy

All Implemented Interfaces:

IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default

Enclosing interface:

IResource
```
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 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)

Constructors
Modifier	Constructor and Description
`protected`	`Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Method`	`addCorsPreflight(CorsOptions options)` Adds an OPTIONS method to this resource which responds to Cross-Origin Resource Sharing (CORS) preflight requests.
`Method`	`addMethod(java.lang.String httpMethod)` Defines a new method for this resource.
`Method`	`addMethod(java.lang.String httpMethod, Integration target)` Defines a new method for this resource.
`Method`	`addMethod(java.lang.String httpMethod, Integration target, MethodOptions options)` Defines a new method for this resource.
`ProxyResource`	`addProxy()` Adds a greedy proxy resource ("{proxy+}") and an ANY method to this route.
`ProxyResource`	`addProxy(ProxyResourceOptions options)` Adds a greedy proxy resource ("{proxy+}") and an ANY method to this route.
`Resource`	`addResource(java.lang.String pathPart)` Defines a new child resource where this resource is the parent.
`Resource`	`addResource(java.lang.String pathPart, ResourceOptions options)` Defines a new child resource where this resource is the parent.
`void`	`applyRemovalPolicy(RemovalPolicy policy)` Apply the given removal policy to this resource.
`IRestApi`	`getApi()` The rest API that this resource is part of.
`CorsOptions`	`getDefaultCorsPreflightOptions()` Default options for CORS preflight OPTIONS method.
`Integration`	`getDefaultIntegration()` An integration to use as a default for all methods created within this API unless an integration is specified.
`MethodOptions`	`getDefaultMethodOptions()` Method options to use as a default for all methods created within this API unless custom options are specified.
`ResourceEnvironment`	`getEnv()` The environment this resource belongs to.
`ConstructNode`	`getNode()` The construct tree node for this construct.
`IResource`	`getParentResource()` The parent of this resource or undefined for the root resource.
`java.lang.String`	`getPath()` The full path of this resource.
`IResource`	`getResource(java.lang.String pathPart)` Retrieves a child resource by path part.
`java.lang.String`	`getResourceId()` The ID of the resource.
`RestApi`	`getRestApi()` Deprecated. - Throws an error if this Resource is not associated with an instance of `RestApi`. Use `api` instead.
`Stack`	`getStack()` The stack in which this resource is defined.
`Resource`	`resourceForPath(java.lang.String path)` Gets or create all resources leading up to the specified path.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Jsii$Proxy
```
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
```
- Method Detail
  - getNode
```
public final ConstructNode getNode()
```
    The construct tree node for this construct.
    
    Specified by:
    
    getNode in interface IConstruct
    
    Specified by:
    
    getNode in interface IConstruct.Jsii$Default
    
    Specified by:
    
    getNode in interface IResource.Jsii$Default
  - getEnv
```
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
  - getStack
```
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
  - getApi
```
public final IRestApi getApi()
```
    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
```
public final java.lang.String getPath()
```
    The full path of this resource.
  - getResourceId
```
public final java.lang.String getResourceId()
```
    The ID of the resource.
  - getRestApi
```
@Deprecated
public final RestApi getRestApi()
```
    Deprecated. - Throws an error if this Resource is not associated with an instance of `RestApi`. Use `api` instead.
    
    (deprecated) The rest API that this resource is part of.
  - getDefaultCorsPreflightOptions
```
public final CorsOptions getDefaultCorsPreflightOptions()
```
    Default options for CORS preflight OPTIONS method.
  - getDefaultIntegration
```
public final Integration getDefaultIntegration()
```
    An integration to use as a default for all methods created within this API unless an integration is specified.
  - getDefaultMethodOptions
```
public final MethodOptions getDefaultMethodOptions()
```
    Method options to use as a default for all methods created within this API unless custom options are specified.
  - getParentResource
```
public final IResource getParentResource()
```
    The parent of this resource or undefined for the root resource.
  - applyRemovalPolicy
```
public final void applyRemovalPolicy(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
    
    Parameters:
    
    policy - This parameter is required.
  - addCorsPreflight
```
public final Method addCorsPreflight(CorsOptions options)
```
    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
```
public final Method addMethod(java.lang.String httpMethod,
                              Integration target,
                              MethodOptions options)
```
    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
```
public final Method addMethod(java.lang.String httpMethod,
                              Integration target)
```
    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
```
public final Method addMethod(java.lang.String httpMethod)
```
    Defines a new method for this resource.
    
    Parameters:
    
    httpMethod - The HTTP method. This parameter is required.
    
    Returns:
    
    The newly created `Method` object.
  - addProxy
```
public final ProxyResource addProxy(ProxyResourceOptions options)
```
    Adds a greedy proxy resource ("{proxy+}") and an ANY method to this route.
    
    Parameters:
    
    options - Default integration and method options.
  - addProxy
```
public final ProxyResource addProxy()
```
    Adds a greedy proxy resource ("{proxy+}") and an ANY method to this route.
  - addResource
```
public final Resource addResource(java.lang.String pathPart,
                                  ResourceOptions options)
```
    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
```
public final Resource addResource(java.lang.String pathPart)
```
    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
```
public final IResource getResource(java.lang.String pathPart)
```
    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
```
public final Resource resourceForPath(java.lang.String path)
```
    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.

Class IResource.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.IResource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Jsii$Proxy

Method Detail

getNode

getEnv

getStack

getApi

getPath

getResourceId

getRestApi

getDefaultCorsPreflightOptions

getDefaultIntegration

getDefaultMethodOptions

getParentResource

applyRemovalPolicy

addCorsPreflight

addMethod

addMethod

addMethod

addProxy

addProxy

addResource

addResource

getResource

resourceForPath