Class CfnFunction.ApiEventProperty

Inheritance

object

CfnFunction.ApiEventProperty

Implements

CfnFunction.IApiEventProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.SAM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnFunction.ApiEventProperty : CfnFunction.IApiEventProperty

Syntax (vb)

Public Class CfnFunction.ApiEventProperty Implements CfnFunction.IApiEventProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-apievent.html

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
Method
Path
RequestModel
RequestParameters
RestApiId

Constructors

ApiEventProperty()

public ApiEventProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-apievent.html

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"
             };

Properties

Auth

public object? Auth { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-apievent.html#cfn-serverless-function-apievent-auth

Method

public string Method { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-apievent.html#cfn-serverless-function-apievent-method

Path

public string Path { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-apievent.html#cfn-serverless-function-apievent-path

RequestModel

public object? RequestModel { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-apievent.html#cfn-serverless-function-apievent-requestmodel

RequestParameters

public object? RequestParameters { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-apievent.html#cfn-serverless-function-apievent-requestparameters

RestApiId

public string? RestApiId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-apievent.html#cfn-serverless-function-apievent-restapiid

Implements

CfnFunction.IApiEventProperty