interface HttpApiEventProperty

Language	Type name
.NET	`Amazon.CDK.AWS.SAM.CfnFunction.HttpApiEventProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awssam#CfnFunction_HttpApiEventProperty`
Java	`software.amazon.awscdk.services.sam.CfnFunction.HttpApiEventProperty`
Python	`aws_cdk.aws_sam.CfnFunction.HttpApiEventProperty`
TypeScript	`aws-cdk-lib` » `aws_sam` » `CfnFunction` » `HttpApiEventProperty`

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sam as sam } from 'aws-cdk-lib';
const httpApiEventProperty: sam.CfnFunction.HttpApiEventProperty = {
  apiId: 'apiId',
  auth: {
    authorizationScopes: ['authorizationScopes'],
    authorizer: 'authorizer',
  },
  method: 'method',
  path: 'path',
  payloadFormatVersion: 'payloadFormatVersion',
  routeSettings: {
    dataTraceEnabled: false,
    detailedMetricsEnabled: false,
    loggingLevel: 'loggingLevel',
    throttlingBurstLimit: 123,
    throttlingRateLimit: 123,
  },
  timeoutInMillis: 123,
};

Properties

Name	Type	Description
apiId?	`string`
auth?	`IResolvable` `\|` `HttpApiFunctionAuthProperty`
method?	`string`
path?	`string`
payloadFormatVersion?	`string`
routeSettings?	`IResolvable` `\|` `RouteSettingsProperty`
timeoutInMillis?	`number`