software.amazon.awscdk.services.apigateway

Class ProxyResource

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.apigateway.ResourceBase

software.amazon.awscdk.services.apigateway.Resource

software.amazon.awscdk.services.apigateway.ProxyResource

All Implemented Interfaces:

IConstruct, IDependable, IResource

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:47.704Z")
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 interface software.amazon.awscdk.services.apigateway.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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.
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, getRestApi

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

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

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

ProxyResource

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

ProxyResource

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

ProxyResource

public ProxyResource(software.constructs.Construct scope,
                     java.lang.String id,
                     ProxyResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

addMethod

public Method addMethod(java.lang.String httpMethod,
                        Integration integration,
                        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

public Method addMethod(java.lang.String httpMethod,
                        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

public Method addMethod(java.lang.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

public Method getAnyMethod()

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