Class ProxyResourceOptions
Inheritance
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ProxyResourceOptions : Object, IProxyResourceOptions, IResourceOptions
Syntax (vb)
Public Class ProxyResourceOptions
Inherits Object
Implements IProxyResourceOptions, IResourceOptions
Remarks
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
ProxyResourceOptions() |
Properties
AnyMethod | Adds an "ANY" method to this resource. |
DefaultCorsPreflightOptions | Adds a CORS preflight OPTIONS method to this resource and all child resources. |
DefaultIntegration | An integration to use as a default for all methods created within this API unless an integration is specified. |
DefaultMethodOptions | Method options to use as a default for all methods created within this API unless custom options are specified. |
Constructors
ProxyResourceOptions()
public ProxyResourceOptions()
Properties
AnyMethod
Adds an "ANY" method to this resource.
public Nullable<bool> AnyMethod { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
If set to false
, you will have to explicitly
add methods to this resource after it's created.
Default: true
DefaultCorsPreflightOptions
Adds a CORS preflight OPTIONS method to this resource and all child resources.
public ICorsOptions DefaultCorsPreflightOptions { get; set; }
Property Value
Remarks
You can add CORS at the resource-level using addCorsPreflight
.
Default: - CORS is disabled
DefaultIntegration
An integration to use as a default for all methods created within this API unless an integration is specified.
public Integration DefaultIntegration { get; set; }
Property Value
Remarks
Default: - Inherited from parent.
DefaultMethodOptions
Method options to use as a default for all methods created within this API unless custom options are specified.
public IMethodOptions DefaultMethodOptions { get; set; }
Property Value
Remarks
Default: - Inherited from parent.