2.272.0

interface S3StorageConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.Kinesis.CfnChannel.S3StorageConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskinesis#CfnChannel_S3StorageConfigurationProperty
Javasoftware.amazon.awscdk.services.kinesis.CfnChannel.S3StorageConfigurationProperty
Pythonaws_cdk.aws_kinesis.CfnChannel.S3StorageConfigurationProperty
TypeScript aws-cdk-lib » aws_kinesis » CfnChannel » S3StorageConfigurationProperty

S3 storage configuration that describes the destination bucket and how delivered objects are stored.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3storageconfiguration.html

Example

// 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 s3StorageConfigurationProperty: kinesis.CfnChannel.S3StorageConfigurationProperty = {
  bucketArn: 'bucketArn',
  compressionType: 'compressionType',
  expectedBucketOwner: 'expectedBucketOwner',

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

Properties

NameTypeDescription
bucketArnstringThe ARN of the S3 bucket for record delivery.
compressionTypestringThe compression algorithm applied to delivered objects.
expectedBucketOwnerstringThe AWS account ID of the expected owner of the destination S3 bucket.
outputKeyTemplate?stringOptional template for the S3 object key path.
storageClass?stringThe S3 storage class for delivered objects.

bucketArn

Type: string

The ARN of the S3 bucket for record delivery.

Different channels can deliver to the same bucket. Buckets can be cross-account but must be in the same region as the channel.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3storageconfiguration.html#cfn-kinesis-channel-s3storageconfiguration-bucketarn

compressionType

Type: string

The compression algorithm applied to delivered objects.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3storageconfiguration.html#cfn-kinesis-channel-s3storageconfiguration-compressiontype

expectedBucketOwner

Type: string

The AWS account ID of the expected owner of the destination S3 bucket.

Used to verify bucket ownership before delivery.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3storageconfiguration.html#cfn-kinesis-channel-s3storageconfiguration-expectedbucketowner

outputKeyTemplate?

Type: string (optional)

Optional template for the S3 object key path.

Supports placeholders in the form !{name}: !{channel-name}, !{channel-id}, !{stream-name}, !{yyyy}, !{yy}, !{MM}, !{dd}, !{HH}, !{mm}, and !{extension} (a literal file extension can be supplied as !{extension:.json.gz}). When omitted, the service uses the default 'kinesis-channel/!{channel-name}/!{channel-id}/!{yyyy}/!{MM}/!{dd}/!{HH}/!{channel-name}-!{channel-id}-!{yyyy}-!{MM}-!{dd}-!{HH}-!{mm}!{extension}'.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3storageconfiguration.html#cfn-kinesis-channel-s3storageconfiguration-outputkeytemplate

storageClass?

Type: string (optional, default: "STANDARD")

The S3 storage class for delivered objects.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3storageconfiguration.html#cfn-kinesis-channel-s3storageconfiguration-storageclass

← PreviousNext →