Package software.amazon.awscdk.services.apigateway

Interface ProxyResourceOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, ResourceOptions

All Known Subinterfaces:

ProxyResourceProps

All Known Implementing Classes:

ProxyResourceOptions.Jsii$Proxy, ProxyResourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.130.0 (build 048a5ee)",
           date="2026-05-19T19:44:34.798Z")
@Stability(Stable)
public interface ProxyResourceOptions
extends software.amazon.jsii.JsiiSerializable, ResourceOptions

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());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ProxyResourceOptions.Builder	A builder for ProxyResourceOptions
static final class	ProxyResourceOptions.Jsii$Proxy	An implementation for ProxyResourceOptions

Method Summary

Modifier and Type	Method	Description
static ProxyResourceOptions.Builder	builder()
default Boolean	getAnyMethod()	Adds an "ANY" method to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.apigateway.ResourceOptions

getDefaultCorsPreflightOptions, getDefaultIntegration, getDefaultMethodOptions

Method Details

getAnyMethod

@Stability(Stable)
@Nullable
default Boolean getAnyMethod()

Adds an "ANY" method to this resource.

If set to false, you will have to explicitly add methods to this resource after it's created.

Default: true

builder

@Stability(Stable)
static ProxyResourceOptions.Builder builder()

Returns:

a ProxyResourceOptions.Builder of ProxyResourceOptions