aws-cdk-lib.aws_sam.CfnFunction.HttpApiEventProperty

interface HttpApiEventProperty

LanguageType name
.NETAmazon.CDK.AWS.SAM.CfnFunction.HttpApiEventProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssam#CfnFunction_HttpApiEventProperty
Javasoftware.amazon.awscdk.services.sam.CfnFunction.HttpApiEventProperty
Pythonaws_cdk.aws_sam.CfnFunction.HttpApiEventProperty
TypeScript aws-cdk-lib » aws_sam » CfnFunction » HttpApiEventProperty

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

NameTypeDescription
apiId?stringCfnFunction.HttpApiEventProperty.ApiId.
auth?IResolvable | HttpApiFunctionAuthPropertyCfnFunction.HttpApiEventProperty.Auth.
method?stringCfnFunction.HttpApiEventProperty.Method.
path?stringCfnFunction.HttpApiEventProperty.Path.
payloadFormatVersion?stringCfnFunction.HttpApiEventProperty.PayloadFormatVersion.
routeSettings?IResolvable | RouteSettingsPropertyCfnFunction.HttpApiEventProperty.RouteSettings.
timeoutInMillis?numberCfnFunction.HttpApiEventProperty.TimeoutInMillis.

apiId?

Type: string (optional)

CfnFunction.HttpApiEventProperty.ApiId.


auth?

Type: IResolvable | HttpApiFunctionAuthProperty (optional)

CfnFunction.HttpApiEventProperty.Auth.


method?

Type: string (optional)

CfnFunction.HttpApiEventProperty.Method.


path?

Type: string (optional)

CfnFunction.HttpApiEventProperty.Path.


payloadFormatVersion?

Type: string (optional)

CfnFunction.HttpApiEventProperty.PayloadFormatVersion.


routeSettings?

Type: IResolvable | RouteSettingsProperty (optional)

CfnFunction.HttpApiEventProperty.RouteSettings.


timeoutInMillis?

Type: number (optional)

CfnFunction.HttpApiEventProperty.TimeoutInMillis.