software.amazon.awscdk.services.apigateway

Class ProxyResource

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

software.amazon.awscdk.services.apigateway.ProxyResource

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.198Z")
 @Stability(value=Stable)
public class ProxyResource
extends Resource

Defines a {proxy+} greedy resource and an ANY method on a route.

Example:

 Resource resource;
 Function handler;
 ProxyResource proxy = resource.addProxy(ProxyResourceOptions.builder()
         .defaultIntegration(new LambdaIntegration(handler))
         // "false" will require explicitly adding methods on the `proxy` resource
         .anyMethod(true)
         .build());
 

See Also:

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-set-up-simple-proxy.html

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProxyResource.Builder A fluent builder for ProxyResource.

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
	ProxyResource(software.constructs.Construct scope, String id, ProxyResourceProps props)
protected	ProxyResource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ProxyResource(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Method	addMethod(String httpMethod) Defines a new method for this resource.
Method	addMethod(String httpMethod, Integration integration) Defines a new method for this resource.
Method	addMethod(String httpMethod, Integration integration, MethodOptions options) Defines a new method for this resource.
Method	getAnyMethod() If `props.anyMethod` is `true`, this will be the reference to the 'ANY' method associated with this proxy resource.

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

fromResourceAttributes, getApi, getDefaultCorsPreflightOptions, getDefaultIntegration, getDefaultMethodOptions, getParentResource, getPath, getResourceId

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

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

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, 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

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ProxyResource

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

ProxyResource

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

ProxyResource

@Stability(value=Stable)
public ProxyResource(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              ProxyResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

addMethod

@Stability(value=Stable)
 @NotNull
public Method addMethod(@NotNull
                                                           String httpMethod,
                                                           @Nullable
                                                           Integration integration,
                                                           @Nullable
                                                           MethodOptions options)

Defines a new method for this resource.

Overrides:

addMethod in class ResourceBase

Parameters:

httpMethod - This parameter is required.

integration -

options -

Returns:

The newly created `Method` object.

addMethod

@Stability(value=Stable)
 @NotNull
public Method addMethod(@NotNull
                                                           String httpMethod,
                                                           @Nullable
                                                           Integration integration)

Defines a new method for this resource.

Overrides:

addMethod in class ResourceBase

Parameters:

httpMethod - This parameter is required.

integration -

Returns:

The newly created `Method` object.

addMethod

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

Defines a new method for this resource.

Overrides:

addMethod in class ResourceBase

Parameters:

httpMethod - This parameter is required.

Returns:

The newly created `Method` object.

getAnyMethod

@Stability(value=Stable)
 @Nullable
public Method getAnyMethod()

If `props.anyMethod` is `true`, this will be the reference to the 'ANY' method associated with this proxy resource.