Skip to content
v2.274.0

DeadLetterQueueS3ConfigurationProperty Struct ​

Configuration of the S3 bucket used to capture records that cannot be delivered to the primary destination.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kinesis as kinesis } from 'aws-cdk-lib';
const deadLetterQueueS3ConfigurationProperty: kinesis.CfnChannel.DeadLetterQueueS3ConfigurationProperty = {
  bucketArn: 'bucketArn',
  expectedBucketOwner: 'expectedBucketOwner',

  // the properties below are optional
  errorOutputPrefix: 'errorOutputPrefix',
};

Properties ​

bucketArnstringbucket_arnstrbucketArnStringBucketArnstringBucketArn*stringrequired#
The ARN of the S3 bucket for storing failed records.
errorOutputPrefixoptionalstringerror_output_prefixoptionalstrerrorOutputPrefixoptionalStringErrorOutputPrefixoptionalstringErrorOutputPrefixoptional*string#
Optional S3 key prefix under which error records are organized.

When omitted, the service uses the default 'kinesis-channel/errors/<channelName>/<channelId>/'.

expectedBucketOwnerstringexpected_bucket_ownerstrexpectedBucketOwnerStringExpectedBucketOwnerstringExpectedBucketOwner*stringrequired#
The AWS account ID of the expected owner of the dead-letter queue S3 bucket.

Used to verify bucket ownership before delivery.