Class ProxyResource
java.lang.Object
software.amazon.jsii.JsiiObject
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
,IResource
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:45.026Z")
@Stability(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());
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource
IResource.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.IResource
IResource.Jsii$Default
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
ProxyResource
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
ProxyResource
(software.amazon.jsii.JsiiObjectRef objRef) ProxyResource
(software.constructs.Construct scope, String id, ProxyResourceProps props) -
Method Summary
Modifier and TypeMethodDescriptionDefines a new method for this resource.addMethod
(String httpMethod, Integration integration) Defines a new method for this resource.addMethod
(String httpMethod, Integration integration, MethodOptions options) Defines a new method for this resource.Ifprops.anyMethod
istrue
, 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 software.constructs.Construct
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.core.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.core.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
ProxyResource
protected ProxyResource(software.amazon.jsii.JsiiObjectRef objRef) -
ProxyResource
protected ProxyResource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
ProxyResource
@Stability(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 Details
-
addMethod
@Stability(Stable) @NotNull public Method addMethod(@NotNull String httpMethod, @Nullable Integration integration, @Nullable MethodOptions options) Defines a new method for this resource.- Specified by:
addMethod
in interfaceIResource
- Overrides:
addMethod
in classResourceBase
- Parameters:
httpMethod
- This parameter is required.integration
-options
-- Returns:
- The newly created
Method
object.
-
addMethod
@Stability(Stable) @NotNull public Method addMethod(@NotNull String httpMethod, @Nullable Integration integration) Defines a new method for this resource.- Specified by:
addMethod
in interfaceIResource
- Overrides:
addMethod
in classResourceBase
- Parameters:
httpMethod
- This parameter is required.integration
-- Returns:
- The newly created
Method
object.
-
addMethod
Defines a new method for this resource.- Specified by:
addMethod
in interfaceIResource
- Overrides:
addMethod
in classResourceBase
- Parameters:
httpMethod
- This parameter is required.- Returns:
- The newly created
Method
object.
-
getAnyMethod
Ifprops.anyMethod
istrue
, this will be the reference to the 'ANY' method associated with this proxy resource.
-