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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.199Z")
 @Stability(value=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 and Description
static class	ProxyResourceOptions.Builder A builder for ProxyResourceOptions
static class	ProxyResourceOptions.Jsii$Proxy An implementation for ProxyResourceOptions

Method Summary

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

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

getDefaultCorsPreflightOptions, getDefaultIntegration, getDefaultMethodOptions

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAnyMethod

@Stability(value=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(value=Stable)
static ProxyResourceOptions.Builder builder()

Specified by:

builder in interface ResourceOptions

Returns:

a ProxyResourceOptions.Builder of ProxyResourceOptions