Class CfnDeliveryStream.S3DestinationConfigurationProperty
The S3DestinationConfiguration
property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.
Inheritance
Namespace: Amazon.CDK.AWS.KinesisFirehose
Assembly: Amazon.CDK.AWS.KinesisFirehose.dll
Syntax (csharp)
public class S3DestinationConfigurationProperty : Object, CfnDeliveryStream.IS3DestinationConfigurationProperty
Syntax (vb)
Public Class S3DestinationConfigurationProperty
Inherits Object
Implements CfnDeliveryStream.IS3DestinationConfigurationProperty
Remarks
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.AWS.KinesisFirehose;
var s3DestinationConfigurationProperty = new S3DestinationConfigurationProperty {
BucketArn = "bucketArn",
RoleArn = "roleArn",
// the properties below are optional
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"
};
Synopsis
Constructors
S3DestinationConfigurationProperty() |
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 delivery 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). |
Constructors
S3DestinationConfigurationProperty()
public S3DestinationConfigurationProperty()
Properties
BucketArn
The Amazon Resource Name (ARN) of the Amazon S3 bucket to send data to.
public string BucketArn { get; set; }
Property Value
System.String
Remarks
BufferingHints
Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon S3 bucket.
public object BufferingHints { get; set; }
Property Value
System.Object
Remarks
CloudWatchLoggingOptions
The CloudWatch logging options for your delivery stream.
public object CloudWatchLoggingOptions { get; set; }
Property Value
System.Object
Remarks
CompressionFormat
The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket.
public string CompressionFormat { get; set; }
Property Value
System.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.
public object EncryptionConfiguration { get; set; }
Property Value
System.Object
Remarks
Kinesis Data Firehose uses AWS Key Management Service ( AWS KMS) to encrypt the data that it delivers to your Amazon S3 bucket.
ErrorOutputPrefix
A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.
public string ErrorOutputPrefix { get; set; }
Property Value
System.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.
public string Prefix { get; set; }
Property Value
System.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).
public string RoleArn { get; set; }
Property Value
System.String
Remarks
For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide .