Interface CfnDeliveryStreamPropsMixin.IS3DestinationConfigurationProperty

The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.

Namespace: Amazon.CDK.Mixins.Preview.AWS.KinesisFirehose.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public interface CfnDeliveryStreamPropsMixin.IS3DestinationConfigurationProperty

Syntax (vb)

Public Interface CfnDeliveryStreamPropsMixin.IS3DestinationConfigurationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.KinesisFirehose.Mixins;

             var s3DestinationConfigurationProperty = new S3DestinationConfigurationProperty {
                 BucketArn = "bucketArn",
                 BufferingHints = new BufferingHintsProperty {
                     IntervalInSeconds = 123,
                     SizeInMBs = 123
                 },
                 CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
                     Enabled = false,
                     LogGroupName = "logGroupName",
                     LogStreamName = "logStreamName"
                 },
                 CompressionFormat = "compressionFormat",
                 EncryptionConfiguration = new EncryptionConfigurationProperty {
                     KmsEncryptionConfig = new KMSEncryptionConfigProperty {
                         AwskmsKeyArn = "awskmsKeyArn"
                     },
                     NoEncryptionConfig = "noEncryptionConfig"
                 },
                 ErrorOutputPrefix = "errorOutputPrefix",
                 Prefix = "prefix",
                 RoleArn = "roleArn"
             };

Synopsis

Properties

BucketArn	The Amazon Resource Name (ARN) of the Amazon S3 bucket to send data to.
BufferingHints	Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon S3 bucket.
CloudWatchLoggingOptions	The CloudWatch logging options for your Firehose stream.
CompressionFormat	The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket.
EncryptionConfiguration	Configures Amazon Simple Storage Service (Amazon S3) server-side encryption.
ErrorOutputPrefix	A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.
Prefix	A prefix that Kinesis Data Firehose adds to the files that it delivers to the Amazon S3 bucket.
RoleArn	The ARN of an AWS Identity and Access Management (IAM) role that grants Kinesis Data Firehose access to your Amazon S3 bucket and AWS KMS (if you enable data encryption).

Properties

BucketArn

The Amazon Resource Name (ARN) of the Amazon S3 bucket to send data to.

string? BucketArn { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-bucketarn

BufferingHints

Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon S3 bucket.

object? BufferingHints { get; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeliveryStreamPropsMixin.IBufferingHintsProperty

CloudWatchLoggingOptions

The CloudWatch logging options for your Firehose stream.

object? CloudWatchLoggingOptions { get; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeliveryStreamPropsMixin.ICloudWatchLoggingOptionsProperty

CompressionFormat

The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket.

string? CompressionFormat { get; }

Property Value

string

Remarks

For valid values, see the CompressionFormat content for the S3DestinationConfiguration data type in the Amazon Kinesis Data Firehose API Reference .

EncryptionConfiguration

Configures Amazon Simple Storage Service (Amazon S3) server-side encryption.

object? EncryptionConfiguration { get; }

Property Value

object

Remarks

Kinesis Data Firehose uses AWS Key Management Service ( AWS KMS) to encrypt the data that it delivers to your Amazon S3 bucket.

Type union: either IResolvable or CfnDeliveryStreamPropsMixin.IEncryptionConfigurationProperty

ErrorOutputPrefix

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.

string? ErrorOutputPrefix { get; }

Property Value

string

Remarks

This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects .

Prefix

A prefix that Kinesis Data Firehose adds to the files that it delivers to the Amazon S3 bucket.

string? Prefix { get; }

Property Value

string

Remarks

The prefix helps you identify the files that Kinesis Data Firehose delivered.

RoleArn

The ARN of an AWS Identity and Access Management (IAM) role that grants Kinesis Data Firehose access to your Amazon S3 bucket and AWS KMS (if you enable data encryption).

string? RoleArn { get; }

Property Value

string

Remarks

For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide .