software.amazon.awscdk.services.apigateway

Interface IResource

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IResource.Jsii$Default

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.165Z")
 @Stability(value=Stable)
public interface IResource
extends software.amazon.jsii.JsiiSerializable, IResource

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IResource.Jsii$Default Internal default implementation for IResource.
static class	IResource.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

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(String httpMethod) Defines a new method for this resource.
Method	addMethod(String httpMethod, Integration target) Defines a new method for this resource.
Method	addMethod(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(String pathPart) Defines a new child resource where this resource is the parent.
Resource	addResource(String pathPart, ResourceOptions options) Defines a new child resource where this resource is the parent.
IRestApi	getApi() The rest API that this resource is part of.
default CorsOptions	getDefaultCorsPreflightOptions() Default options for CORS preflight OPTIONS method.
default Integration	getDefaultIntegration() An integration to use as a default for all methods created within this API unless an integration is specified.
default MethodOptions	getDefaultMethodOptions() Method options to use as a default for all methods created within this API unless custom options are specified.
default IResource	getParentResource() The parent of this resource or undefined for the root resource.
String	getPath() The full path of this resource.
IResource	getResource(String pathPart) Retrieves a child resource by path part.
String	getResourceId() The ID of the resource.
Resource	resourceForPath(String path) Gets or create all resources leading up to the specified path.

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApi

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

@Stability(value=Stable)
 @NotNull
String getPath()

The full path of this resource.

getResourceId

@Stability(value=Stable)
 @NotNull
String getResourceId()

The ID of the resource.

getDefaultCorsPreflightOptions

@Stability(value=Stable)
 @Nullable
default CorsOptions getDefaultCorsPreflightOptions()

Default options for CORS preflight OPTIONS method.

getDefaultIntegration

@Stability(value=Stable)
 @Nullable
default Integration getDefaultIntegration()

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

getDefaultMethodOptions

@Stability(value=Stable)
 @Nullable
default MethodOptions getDefaultMethodOptions()

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

getParentResource

@Stability(value=Stable)
 @Nullable
default IResource getParentResource()

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

addCorsPreflight

@Stability(value=Stable)
 @NotNull
Method addCorsPreflight(@NotNull
                                                           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

@Stability(value=Stable)
 @NotNull
Method addMethod(@NotNull
                                                    String httpMethod,
                                                    @Nullable
                                                    Integration target,
                                                    @Nullable
                                                    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

@Stability(value=Stable)
 @NotNull
Method addMethod(@NotNull
                                                    String httpMethod,
                                                    @Nullable
                                                    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

@Stability(value=Stable)
 @NotNull
Method addMethod(@NotNull
                                                    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

@Stability(value=Stable)
 @NotNull
ProxyResource addProxy(@Nullable
                                                          ProxyResourceOptions options)

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

Parameters:

options - Default integration and method options.

addProxy

@Stability(value=Stable)
 @NotNull
ProxyResource addProxy()

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

addResource

@Stability(value=Stable)
 @NotNull
Resource addResource(@NotNull
                                                        String pathPart,
                                                        @Nullable
                                                        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

@Stability(value=Stable)
 @NotNull
Resource addResource(@NotNull
                                                        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

@Stability(value=Stable)
 @Nullable
IResource getResource(@NotNull
                                                          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

@Stability(value=Stable)
 @NotNull
Resource resourceForPath(@NotNull
                                                            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.