Show / Hide Table of Contents

Interface CfnFunctionPropsMixin.IApiEventProperty

Namespace: Amazon.CDK.Mixins.Preview.AWS.SAM.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public interface CfnFunctionPropsMixin.IApiEventProperty
Syntax (vb)
Public Interface CfnFunctionPropsMixin.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.Mixins.Preview.AWS.SAM.Mixins;

             var customStatements;

             var apiEventProperty = new ApiEventProperty {
                 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" }
                     }
                 },
                 Method = "method",
                 Path = "path",
                 RequestModel = new RequestModelProperty {
                     Model = "model",
                     Required = false,
                     ValidateBody = false,
                     ValidateParameters = false
                 },
                 RequestParameters = new [] { "requestParameters" },
                 RestApiId = "restApiId"
             };

Synopsis

Properties

Auth
Method
Path
RequestModel
RequestParameters
RestApiId

Properties

Auth

object? Auth { get; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnFunctionPropsMixin.IAuthProperty

Method

string? Method { get; }
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

string? Path { get; }
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

object? RequestModel { get; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnFunctionPropsMixin.IRequestModelProperty

RequestParameters

object? RequestParameters { get; }
Property Value

object

Remarks

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

Type union: either IResolvable or (either string or IResolvable or CfnFunctionPropsMixin.IRequestParameterProperty)[]

RestApiId

string? RestApiId { get; }
Property Value

string

Remarks

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

Back to top Generated by DocFX