Interface CfnFunction.IApiEventProperty

Namespace: Amazon.CDK.AWS.SAM

Assembly: Amazon.CDK.AWS.SAM.dll

Syntax (csharp)

public interface IApiEventProperty

Syntax (vb)

Public Interface 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

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.

Properties

Auth

CfnFunction.ApiEventProperty.Auth.

virtual object Auth { get; }

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.

string Method { get; }

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.

string Path { get; }

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.

virtual object RequestModel { get; }

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.

virtual object RequestParameters { get; }

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.

virtual string RestApiId { get; }

Property Value

System.String

Remarks

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