aws-cdk-lib.aws_sam.CfnFunction.KinesisEventProperty

interface KinesisEventProperty

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

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 kinesisEventProperty: sam.CfnFunction.KinesisEventProperty = {
  startingPosition: 'startingPosition',
  stream: 'stream',

  // the properties below are optional
  batchSize: 123,
  enabled: false,
  functionResponseTypes: ['functionResponseTypes'],
};

Properties

NameTypeDescription
startingPositionstringCfnFunction.KinesisEventProperty.StartingPosition.
streamstringCfnFunction.KinesisEventProperty.Stream.
batchSize?numberCfnFunction.KinesisEventProperty.BatchSize.
enabled?boolean | IResolvableCfnFunction.KinesisEventProperty.Enabled.
functionResponseTypes?string[]CfnFunction.KinesisEventProperty.FunctionResponseTypes.

startingPosition

Type: string

CfnFunction.KinesisEventProperty.StartingPosition.


stream

Type: string

CfnFunction.KinesisEventProperty.Stream.


batchSize?

Type: number (optional)

CfnFunction.KinesisEventProperty.BatchSize.


enabled?

Type: boolean | IResolvable (optional)

CfnFunction.KinesisEventProperty.Enabled.


functionResponseTypes?

Type: string[] (optional)

CfnFunction.KinesisEventProperty.FunctionResponseTypes.