Class ProxyResource

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

Inheritance
System.Object
Resource
ResourceBase
Resource
ProxyResource
Implements
Constructs.IConstruct
Constructs.IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ProxyResource : Resource, IResource, IResource
Syntax (vb)
Public Class ProxyResource
    Inherits Resource
    Implements IResource, IResource
Remarks

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

ExampleMetadata: infused

Examples
Resource resource;
Function handler;

var proxy = resource.AddProxy(new ProxyResourceOptions {
    DefaultIntegration = new LambdaIntegration(handler),

    // "false" will require explicitly adding methods on the `proxy` resource
    AnyMethod = true
});

Synopsis

Constructors

ProxyResource(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
ProxyResource(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
ProxyResource(Construct, String, IProxyResourceProps)

Properties

AnyMethod

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

Methods

AddMethod(String, Integration, IMethodOptions)

Defines a new method for this resource.

Constructors

ProxyResource(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected ProxyResource(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

ProxyResource(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected ProxyResource(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

ProxyResource(Construct, String, IProxyResourceProps)

public ProxyResource(Construct scope, string id, IProxyResourceProps props)
Parameters
scope Constructs.Construct
id System.String
props IProxyResourceProps

Properties

AnyMethod

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

public virtual Method AnyMethod { get; }
Property Value

Method

Methods

AddMethod(String, Integration, IMethodOptions)

Defines a new method for this resource.

public override Method AddMethod(string httpMethod, Integration integration = null, IMethodOptions options = null)
Parameters
httpMethod System.String
integration Integration
options IMethodOptions
Returns

Method

Overrides

Implements

Constructs.IConstruct
Constructs.IDependable