AWS CDK Reference

Appearance

v2.275.0

S3StorageProperty Struct ​

S3 storage configuration.

Source
Generated code
Type last changed
v2.268.0 · 2 Sep 2026

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_msk as msk } from 'aws-cdk-lib';
const s3StorageProperty: msk.CfnChannel.S3StorageProperty = {
  bucketArn: 'bucketArn',
  compressionType: 'compressionType',
  storageClass: 'storageClass',

  // the properties below are optional
  expectedBucketOwner: 'expectedBucketOwner',
  outputKeyTemplate: 'outputKeyTemplate',
  outputPrefix: 'outputPrefix',
};

Properties ​

bucketArnstringbucket_arnstrbucketArnStringBucketArnstringBucketArn*stringrequired#
ARN of the S3 bucket.
compressionTypestringcompression_typestrcompressionTypeStringCompressionTypestringCompressionType*stringrequired#
S3 compression type.
expectedBucketOwneroptionalstringexpected_bucket_owneroptionalstrexpectedBucketOwneroptionalStringExpectedBucketOwneroptionalstringExpectedBucketOwneroptional*string#
Optional 12-digit AWS account ID expected to own the S3 bucket.
outputKeyTemplateoptionalstringoutput_key_templateoptionalstroutputKeyTemplateoptionalStringOutputKeyTemplateoptionalstringOutputKeyTemplateoptional*string#
Template for S3 key for output objects, used for partitioning.
outputPrefixoptionalstringoutput_prefixoptionalstroutputPrefixoptionalStringOutputPrefixoptionalstringOutputPrefixoptional*string#
Optional prefix for output objects.
storageClassstringstorage_classstrstorageClassStringStorageClassstringStorageClass*stringrequired#
S3 storage class.