interface HttpApiEventProperty

Language	Type name
.NET	Amazon.CDK.AWS.SAM.CfnFunction.HttpApiEventProperty
Java	software.amazon.awscdk.services.sam.CfnFunction.HttpApiEventProperty
Python	aws_cdk.aws_sam.CfnFunction.HttpApiEventProperty
TypeScript	@aws-cdk/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 * as sam from '@aws-cdk/aws-sam';
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	CfnFunction.HttpApiEventProperty.ApiId.
auth?	IResolvable | HttpApiFunctionAuthProperty	CfnFunction.HttpApiEventProperty.Auth.
method?	string	CfnFunction.HttpApiEventProperty.Method.
path?	string	CfnFunction.HttpApiEventProperty.Path.
payloadFormatVersion?	string	CfnFunction.HttpApiEventProperty.PayloadFormatVersion.
routeSettings?	IResolvable | RouteSettingsProperty	CfnFunction.HttpApiEventProperty.RouteSettings.
timeoutInMillis?	number	CfnFunction.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.