Interface CfnDeliveryStream.S3DestinationConfigurationProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnDeliveryStream.S3DestinationConfigurationProperty extends
The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 S3DestinationConfigurationProperty s3DestinationConfigurationProperty = S3DestinationConfigurationProperty.builder()
         // the properties below are optional
  • Method Details

    • getBucketArn

      @Stability(Stable) @NotNull String getBucketArn()
      The Amazon Resource Name (ARN) of the Amazon S3 bucket to send data to.
    • 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 .

    • getBufferingHints

      @Stability(Stable) @Nullable default Object getBufferingHints()
      Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon S3 bucket.
    • getCloudWatchLoggingOptions

      @Stability(Stable) @Nullable default Object getCloudWatchLoggingOptions()
      The CloudWatch logging options for your delivery stream.
    • 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 .

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

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

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

    • builder

      a CfnDeliveryStream.S3DestinationConfigurationProperty.Builder of CfnDeliveryStream.S3DestinationConfigurationProperty