Package software.amazon.awscdk.services.kinesisfirehose

Interface CfnDeliveryStream.S3DestinationConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeliveryStream.S3DestinationConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDeliveryStream

@Stability(Stable)
public static interface CfnDeliveryStream.S3DestinationConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kinesisfirehose.*;
 S3DestinationConfigurationProperty s3DestinationConfigurationProperty = S3DestinationConfigurationProperty.builder()
         .bucketArn("bucketArn")
         .roleArn("roleArn")
         // the properties below are optional
         .bufferingHints(BufferingHintsProperty.builder()
                 .intervalInSeconds(123)
                 .sizeInMBs(123)
                 .build())
         .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder()
                 .enabled(false)
                 .logGroupName("logGroupName")
                 .logStreamName("logStreamName")
                 .build())
         .compressionFormat("compressionFormat")
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .kmsEncryptionConfig(KMSEncryptionConfigProperty.builder()
                         .awskmsKeyArn("awskmsKeyArn")
                         .build())
                 .noEncryptionConfig("noEncryptionConfig")
                 .build())
         .errorOutputPrefix("errorOutputPrefix")
         .prefix("prefix")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDeliveryStream.S3DestinationConfigurationProperty.Builder	A builder for CfnDeliveryStream.S3DestinationConfigurationProperty
static final class	CfnDeliveryStream.S3DestinationConfigurationProperty.Jsii$Proxy	An implementation for CfnDeliveryStream.S3DestinationConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDeliveryStream.S3DestinationConfigurationProperty.Builder	builder()
String	getBucketArn()	The Amazon Resource Name (ARN) of the Amazon S3 bucket to send data to.
default Object	getBufferingHints()	Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon S3 bucket.
default Object	getCloudWatchLoggingOptions()	The CloudWatch logging options for your Firehose stream.
default String	getCompressionFormat()	The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket.
default Object	getEncryptionConfiguration()	Configures Amazon Simple Storage Service (Amazon S3) server-side encryption.
default String	getErrorOutputPrefix()	A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.
default String	getPrefix()	A prefix that Kinesis Data Firehose adds to the files that it delivers to the Amazon S3 bucket.
String	getRoleArn()	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).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucketArn

@Stability(Stable)
@NotNull
String getBucketArn()

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

See Also:

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

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

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).

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

See Also:

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

getBufferingHints

@Stability(Stable)
@Nullable
default Object getBufferingHints()

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

Returns union: either IResolvable or CfnDeliveryStream.BufferingHintsProperty

See Also:

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

getCloudWatchLoggingOptions

@Stability(Stable)
@Nullable
default Object getCloudWatchLoggingOptions()

The CloudWatch logging options for your Firehose stream.

Returns union: either IResolvable or CfnDeliveryStream.CloudWatchLoggingOptionsProperty

See Also:

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

getCompressionFormat

@Stability(Stable)
@Nullable
default String getCompressionFormat()

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

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

See Also:

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

getEncryptionConfiguration

@Stability(Stable)
@Nullable
default Object getEncryptionConfiguration()

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

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

Returns union: either IResolvable or CfnDeliveryStream.EncryptionConfigurationProperty

See Also:

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

getErrorOutputPrefix

@Stability(Stable)
@Nullable
default String getErrorOutputPrefix()

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

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

See Also:

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

getPrefix

@Stability(Stable)
@Nullable
default String getPrefix()

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

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

See Also:

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

builder

@Stability(Stable)
static CfnDeliveryStream.S3DestinationConfigurationProperty.Builder builder()

Returns:

a CfnDeliveryStream.S3DestinationConfigurationProperty.Builder of CfnDeliveryStream.S3DestinationConfigurationProperty