software.amazon.awscdk.services.apigateway

Class ResourceBase

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.apigateway.ResourceBase

All Implemented Interfaces:

IConstruct, IDependable, IResource

Direct Known Subclasses:

Resource

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:58.304Z")
public abstract class ResourceBase
extends Resource
implements IResource

Nested Class Summary

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

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ResourceBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ResourceBase(software.amazon.jsii.JsiiObjectRef objRef)
protected	ResourceBase(software.constructs.Construct scope, java.lang.String id)

Method Summary

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 integration) Defines a new method for this resource.
Method	addMethod(java.lang.String httpMethod, Integration integration, 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.
abstract IRestApi	getApi() The rest API that this resource is part of.
abstract CorsOptions	getDefaultCorsPreflightOptions() Default options for CORS preflight OPTIONS method.
abstract Integration	getDefaultIntegration() An integration to use as a default for all methods created within this API unless an integration is specified.
abstract MethodOptions	getDefaultMethodOptions() Method options to use as a default for all methods created within this API unless custom options are specified.
abstract IResource	getParentResource() The parent of this resource or undefined for the root resource.
abstract java.lang.String	getPath() The full path of this resource.
IResource	getResource(java.lang.String pathPart) Retrieves a child resource by path part.
abstract java.lang.String	getResourceId() The ID of the resource.
abstract RestApi	getRestApi() Deprecated. - Throws an error if this Resource is not associated with an instance of `RestApi`. Use `api` instead.
java.lang.String	getUrl() Deprecated. - Throws error in some use cases that have been enabled since this deprecation notice. Use `RestApi.urlForPath()` instead.
Resource	resourceForPath(java.lang.String path) Gets or create all resources leading up to the specified path.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

ResourceBase

protected ResourceBase(software.amazon.jsii.JsiiObjectRef objRef)

ResourceBase

protected ResourceBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ResourceBase

protected ResourceBase(software.constructs.Construct scope,
                       java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

addCorsPreflight

public 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 - This parameter is required.

Returns:

a `Method` object

See Also:

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

addMethod

public Method addMethod(java.lang.String httpMethod,
                        Integration integration,
                        MethodOptions options)

Defines a new method for this resource.

Parameters:

httpMethod - This parameter is required.

integration -

options -

Returns:

The newly created `Method` object.

addMethod

public Method addMethod(java.lang.String httpMethod,
                        Integration integration)

Defines a new method for this resource.

Parameters:

httpMethod - This parameter is required.

integration -

Returns:

The newly created `Method` object.

addMethod

public Method addMethod(java.lang.String httpMethod)

Defines a new method for this resource.

Parameters:

httpMethod - This parameter is required.

Returns:

The newly created `Method` object.

addProxy

public ProxyResource addProxy(ProxyResourceOptions options)

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

Parameters:

options -

addProxy

public ProxyResource addProxy()

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

addResource

public Resource addResource(java.lang.String pathPart,
                            ResourceOptions options)

Defines a new child resource where this resource is the parent.

Parameters:

pathPart - This parameter is required.

options -

Returns:

A Resource object

addResource

public Resource addResource(java.lang.String pathPart)

Defines a new child resource where this resource is the parent.

Parameters:

pathPart - This parameter is required.

Returns:

A Resource object

getResource

public IResource getResource(java.lang.String pathPart)

Retrieves a child resource by path part.

Parameters:

pathPart - This parameter is required.

Returns:

the child resource or undefined if not found

resourceForPath

public 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 - This parameter is required.

Returns:

a new or existing resource.

getApi

public abstract 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 abstract java.lang.String getPath()

The full path of this resource.

getResourceId

public abstract java.lang.String getResourceId()

The ID of the resource.

getRestApi

@Deprecated
public abstract 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.

getUrl

@Deprecated
public java.lang.String getUrl()

Deprecated. - Throws error in some use cases that have been enabled since this deprecation notice. Use `RestApi.urlForPath()` instead.

getDefaultCorsPreflightOptions

public abstract CorsOptions getDefaultCorsPreflightOptions()

Default options for CORS preflight OPTIONS method.

getDefaultIntegration

public abstract Integration getDefaultIntegration()

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

getDefaultMethodOptions

public abstract MethodOptions getDefaultMethodOptions()

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

getParentResource

public abstract IResource getParentResource()

The parent of this resource or undefined for the root resource.