interface ApiEventProperty

Language	Type name
.NET	`Amazon.CDK.AWS.SAM.CfnFunction.ApiEventProperty`
Java	`software.amazon.awscdk.services.sam.CfnFunction.ApiEventProperty`
Python	`aws_cdk.aws_sam.CfnFunction.ApiEventProperty`
TypeScript	`@aws-cdk/aws-sam` » `CfnFunction` » `ApiEventProperty`

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as sam from '@aws-cdk/aws-sam';

declare const customStatements: any;
const apiEventProperty: sam.CfnFunction.ApiEventProperty = {
  method: 'method',
  path: 'path',

  // the properties below are optional
  auth: {
    apiKeyRequired: false,
    authorizationScopes: ['authorizationScopes'],
    authorizer: 'authorizer',
    resourcePolicy: {
      awsAccountBlacklist: ['awsAccountBlacklist'],
      awsAccountWhitelist: ['awsAccountWhitelist'],
      customStatements: [customStatements],
      intrinsicVpcBlacklist: ['intrinsicVpcBlacklist'],
      intrinsicVpceBlacklist: ['intrinsicVpceBlacklist'],
      intrinsicVpceWhitelist: ['intrinsicVpceWhitelist'],
      intrinsicVpcWhitelist: ['intrinsicVpcWhitelist'],
      ipRangeBlacklist: ['ipRangeBlacklist'],
      ipRangeWhitelist: ['ipRangeWhitelist'],
      sourceVpcBlacklist: ['sourceVpcBlacklist'],
      sourceVpcWhitelist: ['sourceVpcWhitelist'],
    },
  },
  requestModel: {
    model: 'model',

    // the properties below are optional
    required: false,
    validateBody: false,
    validateParameters: false,
  },
  requestParameters: ['requestParameters'],
  restApiId: 'restApiId',
};

Properties

Name	Type	Description
method	`string`	`CfnFunction.ApiEventProperty.Method`.
path	`string`	`CfnFunction.ApiEventProperty.Path`.
auth?	`IResolvable` `\|` `AuthProperty`	`CfnFunction.ApiEventProperty.Auth`.
requestModel?	`IResolvable` `\|` `RequestModelProperty`	`CfnFunction.ApiEventProperty.RequestModel`.
requestParameters?	`IResolvable` `\| string \|` `IResolvable` `\|` `RequestParameterProperty[]`	`CfnFunction.ApiEventProperty.RequestParameters`.
restApiId?	`string`	`CfnFunction.ApiEventProperty.RestApiId`.