software.amazon.awscdk.services.apigateway

Class Resource

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.apigateway.ResourceBase

software.amazon.awscdk.services.apigateway.Resource

All Implemented Interfaces:

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

Direct Known Subclasses:

ProxyResource

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:54:56.881Z")
 @Stability(value=Experimental)
public class Resource
extends ResourceBase

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Resource.Builder (experimental) A fluent builder for Resource.

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	Resource(software.constructs.Construct scope, String id, ResourceProps props)
protected	Resource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Resource(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static IResource	fromResourceAttributes(software.constructs.Construct scope, String id, ResourceAttributes attrs) (experimental) Import an existing resource.
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.
IResource	getParentResource() (experimental) The parent of this resource or undefined for the root resource.
String	getPath() (experimental) The full path of this resource.
String	getResourceId() (experimental) The ID of the resource.

Methods inherited from class software.amazon.awscdk.services.apigateway.ResourceBase

addCorsPreflight, addMethod, addMethod, addMethod, addProxy, addProxy, addResource, addResource, getResource, resourceForPath

Methods inherited from class software.amazon.awscdk.Resource

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

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Resource

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

Resource

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

Resource

@Stability(value=Experimental)
public Resource(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromResourceAttributes

@Stability(value=Experimental)
 @NotNull
public static IResource fromResourceAttributes(@NotNull
                                                                                        software.constructs.Construct scope,
                                                                                        @NotNull
                                                                                        String id,
                                                                                        @NotNull
                                                                                        ResourceAttributes attrs)

(experimental) Import an existing resource.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

getApi

@Stability(value=Experimental)
 @NotNull
public 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.

Specified by:

getApi in class ResourceBase

getPath

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

(experimental) The full path of this resource.

Specified by:

getPath in class ResourceBase

getResourceId

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

(experimental) The ID of the resource.

Specified by:

getResourceId in class ResourceBase

getDefaultCorsPreflightOptions

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

(experimental) Default options for CORS preflight OPTIONS method.

Specified by:

getDefaultCorsPreflightOptions in class ResourceBase

getDefaultIntegration

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

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

Specified by:

getDefaultIntegration in class ResourceBase

getDefaultMethodOptions

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

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

Specified by:

getDefaultMethodOptions in class ResourceBase

getParentResource

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

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

Specified by:

getParentResource in class ResourceBase