Interface IProxyResourceProps

Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IProxyResourceProps : IProxyResourceOptions, IResourceOptions
Syntax (vb)
Public Interface IProxyResourceProps
    Inherits IProxyResourceOptions, IResourceOptions
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.APIGateway;

Authorizer authorizer;
Integration integration;
Model model;
RequestValidator requestValidator;
Resource resource;

var proxyResourceProps = new ProxyResourceProps {
    Parent = resource,

    // the properties below are optional
    AnyMethod = false,
    DefaultCorsPreflightOptions = new CorsOptions {
        AllowOrigins = new [] { "allowOrigins" },

        // the properties below are optional
        AllowCredentials = false,
        AllowHeaders = new [] { "allowHeaders" },
        AllowMethods = new [] { "allowMethods" },
        DisableCache = false,
        ExposeHeaders = new [] { "exposeHeaders" },
        MaxAge = Duration.Minutes(30),
        StatusCode = 123
    },
    DefaultIntegration = integration,
    DefaultMethodOptions = new MethodOptions {
        ApiKeyRequired = false,
        AuthorizationScopes = new [] { "authorizationScopes" },
        AuthorizationType = AuthorizationType.NONE,
        Authorizer = authorizer,
        MethodResponses = new [] { new MethodResponse {
            StatusCode = "statusCode",

            // the properties below are optional
            ResponseModels = new Dictionary<string, IModel> {
                { "responseModelsKey", model }
            },
            ResponseParameters = new Dictionary<string, boolean> {
                { "responseParametersKey", false }
            }
        } },
        OperationName = "operationName",
        RequestModels = new Dictionary<string, IModel> {
            { "requestModelsKey", model }
        },
        RequestParameters = new Dictionary<string, boolean> {
            { "requestParametersKey", false }
        },
        RequestValidator = requestValidator,
        RequestValidatorOptions = new RequestValidatorOptions {
            RequestValidatorName = "requestValidatorName",
            ValidateRequestBody = false,
            ValidateRequestParameters = false
        }
    }
};

Synopsis

Properties

Parent

The parent resource of this resource.

Properties

Parent

The parent resource of this resource.

IResource Parent { get; }
Property Value

IResource

Remarks

You can either pass another Resource object or a RestApi object here.