Package software.amazon.awscdk.services.kinesisfirehose.destinations

Class DestinationS3BackupProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.kinesisfirehose.destinations.DestinationS3BackupProps.Jsii$Proxy
All Implemented Interfaces:
CommonDestinationS3Props, DestinationS3BackupProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
DestinationS3BackupProps
@Stability(Experimental) @Internal public static final class DestinationS3BackupProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements DestinationS3BackupProps
An implementation for DestinationS3BackupProps

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.kinesisfirehose.destinations.DestinationS3BackupProps

    DestinationS3BackupProps.Builder, DestinationS3BackupProps.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(DestinationS3BackupProps.Builder builder)
    Constructor that initializes the object based on literal property values passed by the DestinationS3BackupProps.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final IBucket
    getBucket()
    (experimental) The S3 bucket that will store data and failed records.
    final Duration
    getBufferingInterval()
    (experimental) The length of time that Firehose buffers incoming data before delivering it to the S3 bucket.
    final Size
    getBufferingSize()
    (experimental) The size of the buffer that Kinesis Data Firehose uses for incoming data before delivering it to the S3 bucket.
    final Compression
    getCompression()
    (experimental) The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket.
    final String
    getDataOutputPrefix()
    (experimental) A prefix that Kinesis Data Firehose evaluates and adds to records before writing them to S3.
    final IKey
    getEncryptionKey()
    (experimental) The AWS KMS key used to encrypt the data that it delivers to your Amazon S3 bucket.
    final String
    getErrorOutputPrefix()
    (experimental) A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.
    final Boolean
    getLogging()
    (experimental) If true, log errors when data transformation or data delivery fails.
    final ILogGroup
    getLogGroup()
    (experimental) The CloudWatch log group where log streams will be created to hold error logs.
    final BackupMode
    getMode()
    (experimental) Indicates the mode by which incoming records should be backed up to S3, if any.
    final int
    hashCode()
     

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(DestinationS3BackupProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the DestinationS3BackupProps.Builder.

  • Method Details

    • getBucket

      public final IBucket getBucket()
      Description copied from interface: DestinationS3BackupProps
      (experimental) The S3 bucket that will store data and failed records.

      Default: - If `mode` is set to `BackupMode.ALL` or `BackupMode.FAILED`, a bucket will be created for you.

      Specified by:
      getBucket in interface DestinationS3BackupProps

    • getLogging

      public final Boolean getLogging()
      Description copied from interface: DestinationS3BackupProps
      (experimental) If true, log errors when data transformation or data delivery fails.

      If logGroup is provided, this will be implicitly set to true.

      Default: true - errors are logged.

      Specified by:
      getLogging in interface DestinationS3BackupProps

    • getLogGroup

      public final ILogGroup getLogGroup()
      Description copied from interface: DestinationS3BackupProps
      (experimental) The CloudWatch log group where log streams will be created to hold error logs.

      Default: - if `logging` is set to `true`, a log group will be created for you.

      Specified by:
      getLogGroup in interface DestinationS3BackupProps

    • getMode

      public final BackupMode getMode()
      Description copied from interface: DestinationS3BackupProps
      (experimental) Indicates the mode by which incoming records should be backed up to S3, if any.

      If bucket is provided, this will be implicitly set to BackupMode.ALL.

      Default: - If `bucket` is provided, the default will be `BackupMode.ALL`. Otherwise, source records are not backed up to S3.

      Specified by:
      getMode in interface DestinationS3BackupProps

    • getBufferingInterval

      public final Duration getBufferingInterval()
      Description copied from interface: CommonDestinationS3Props
      (experimental) The length of time that Firehose buffers incoming data before delivering it to the S3 bucket.

      Minimum: Duration.seconds(60) Maximum: Duration.seconds(900)

      Default: Duration.seconds(300)

      Specified by:
      getBufferingInterval in interface CommonDestinationS3Props

    • getBufferingSize

      public final Size getBufferingSize()
      Description copied from interface: CommonDestinationS3Props
      (experimental) The size of the buffer that Kinesis Data Firehose uses for incoming data before delivering it to the S3 bucket.

      Minimum: Size.mebibytes(1) Maximum: Size.mebibytes(128)

      Default: Size.mebibytes(5)

      Specified by:
      getBufferingSize in interface CommonDestinationS3Props

    • getCompression

      public final Compression getCompression()
      Description copied from interface: CommonDestinationS3Props
      (experimental) The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket.

      The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

      Default: - UNCOMPRESSED

      Specified by:
      getCompression in interface CommonDestinationS3Props

    • getDataOutputPrefix

      public final String getDataOutputPrefix()
      Description copied from interface: CommonDestinationS3Props
      (experimental) A prefix that Kinesis Data Firehose evaluates and adds to records before writing them to S3.

      This prefix appears immediately following the bucket name.

      Default: "YYYY/MM/DD/HH"

      Specified by:
      getDataOutputPrefix in interface CommonDestinationS3Props
      See Also:

    • getEncryptionKey

      public final IKey getEncryptionKey()
      Description copied from interface: CommonDestinationS3Props
      (experimental) The AWS KMS key used to encrypt the data that it delivers to your Amazon S3 bucket.

      Default: - Data is not encrypted.

      Specified by:
      getEncryptionKey in interface CommonDestinationS3Props

    • getErrorOutputPrefix

      public final String getErrorOutputPrefix()
      Description copied from interface: CommonDestinationS3Props
      (experimental) 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.

      Default: "YYYY/MM/DD/HH"

      Specified by:
      getErrorOutputPrefix in interface CommonDestinationS3Props
      See Also:

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object