Class CfnFunction.ApiEventProperty

Inheritance

System.Object

CfnFunction.ApiEventProperty

Implements

Namespace: Amazon.CDK.AWS.SAM

Assembly: Amazon.CDK.AWS.SAM.dll

Syntax (csharp)

public class ApiEventProperty : Object, CfnFunction.IApiEventProperty

Syntax (vb)

Public Class ApiEventProperty
    Inherits Object
    Implements CfnFunction.IApiEventProperty

Remarks

Link: https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api

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.AWS.SAM;

var customStatements;

var apiEventProperty = new ApiEventProperty {
    Method = "method",
    Path = "path",

    // the properties below are optional
    Auth = new AuthProperty {
        ApiKeyRequired = false,
        AuthorizationScopes = new [] { "authorizationScopes" },
        Authorizer = "authorizer",
        ResourcePolicy = new AuthResourcePolicyProperty {
            AwsAccountBlacklist = new [] { "awsAccountBlacklist" },
            AwsAccountWhitelist = new [] { "awsAccountWhitelist" },
            CustomStatements = new [] { customStatements },
            IntrinsicVpcBlacklist = new [] { "intrinsicVpcBlacklist" },
            IntrinsicVpceBlacklist = new [] { "intrinsicVpceBlacklist" },
            IntrinsicVpceWhitelist = new [] { "intrinsicVpceWhitelist" },
            IntrinsicVpcWhitelist = new [] { "intrinsicVpcWhitelist" },
            IpRangeBlacklist = new [] { "ipRangeBlacklist" },
            IpRangeWhitelist = new [] { "ipRangeWhitelist" },
            SourceVpcBlacklist = new [] { "sourceVpcBlacklist" },
            SourceVpcWhitelist = new [] { "sourceVpcWhitelist" }
        }
    },
    RequestModel = new RequestModelProperty {
        Model = "model",

        // the properties below are optional
        Required = false,
        ValidateBody = false,
        ValidateParameters = false
    },
    RequestParameters = new [] { "requestParameters" },
    RestApiId = "restApiId"
};

Synopsis

Constructors

ApiEventProperty()

Properties

Auth	`CfnFunction.ApiEventProperty.Auth`.
Method	`CfnFunction.ApiEventProperty.Method`.
Path	`CfnFunction.ApiEventProperty.Path`.
RequestModel	`CfnFunction.ApiEventProperty.RequestModel`.
RequestParameters	`CfnFunction.ApiEventProperty.RequestParameters`.
RestApiId	`CfnFunction.ApiEventProperty.RestApiId`.

Constructors

ApiEventProperty()

public ApiEventProperty()

Properties

Auth

CfnFunction.ApiEventProperty.Auth.

public object Auth { get; set; }

Property Value

System.Object

Remarks

Link: https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api

Method

CfnFunction.ApiEventProperty.Method.

public string Method { get; set; }

Property Value

System.String

Remarks

Link: https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api

Path

CfnFunction.ApiEventProperty.Path.

public string Path { get; set; }

Property Value

System.String

Remarks

Link: https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api

RequestModel

CfnFunction.ApiEventProperty.RequestModel.

public object RequestModel { get; set; }

Property Value

System.Object

Remarks

Link: https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api

RequestParameters

CfnFunction.ApiEventProperty.RequestParameters.

public object RequestParameters { get; set; }

Property Value

System.Object

Remarks

Link: https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api

RestApiId

CfnFunction.ApiEventProperty.RestApiId.

public string RestApiId { get; set; }

Property Value

System.String

Remarks

Link: https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api

Implements

CfnFunction.IApiEventProperty