Package software.amazon.awscdk.services.kinesisfirehose

Class Datadog.Builder

java.lang.Object
software.amazon.awscdk.services.kinesisfirehose.Datadog.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<Datadog>
Enclosing class:
Datadog
@Stability(Stable) public static final class Datadog.Builder extends Object implements software.amazon.jsii.Builder<Datadog>
A fluent builder for Datadog.

  • Method Details

    • create

      @Stability(Stable) public static Datadog.Builder create()
      Returns:
      a new instance of Datadog.Builder.

    • loggingConfig

      @Stability(Stable) public Datadog.Builder loggingConfig(ILoggingConfig loggingConfig)
      Configuration that determines whether to log errors during data transformation or delivery failures, and specifies the CloudWatch log group for storing error logs.

      Default: - errors will be logged and a log group will be created for you.

      Parameters:
      loggingConfig - Configuration that determines whether to log errors during data transformation or delivery failures, and specifies the CloudWatch log group for storing error logs. This parameter is required.
      Returns:
      this

    • processor

      @Stability(Deprecated) @Deprecated public Datadog.Builder processor(IDataProcessor processor)
      Deprecated.
      Use processors instead.
      (deprecated) The data transformation that should be performed on the data before writing to the destination.

      Default: - no data transformation will occur.

      Parameters:
      processor - The data transformation that should be performed on the data before writing to the destination. This parameter is required.
      Returns:
      this

    • processors

      @Stability(Stable) public Datadog.Builder processors(List<? extends IDataProcessor> processors)
      The data transformation that should be performed on the data before writing to the destination.

      Default: - no data transformation will occur.

      Parameters:
      processors - The data transformation that should be performed on the data before writing to the destination. This parameter is required.
      Returns:
      this

    • role

      @Stability(Stable) public Datadog.Builder role(IRole role)
      The IAM role associated with this destination.

      Assumed by Amazon Data Firehose to invoke processors and write to destinations

      Default: - a role will be created with default permissions.

      Parameters:
      role - The IAM role associated with this destination. This parameter is required.
      Returns:
      this

    • s3Backup

      @Stability(Stable) public Datadog.Builder s3Backup(DestinationS3BackupProps s3Backup)
      The configuration for backing up source records to S3.

      Default: - source records will not be backed up to S3.

      Parameters:
      s3Backup - The configuration for backing up source records to S3. This parameter is required.
      Returns:
      this

    • apiKey

      @Stability(Stable) public Datadog.Builder apiKey(ISecret apiKey)
      The API key used to authenticate with Datadog.

      Delivered to Firehose through AWS Secrets Manager (Firehose retrieves it at runtime rather than embedding it in the template).

      Parameters:
      apiKey - The API key used to authenticate with Datadog. This parameter is required.
      Returns:
      this

    • endpoint

      @Stability(Stable) public Datadog.Builder endpoint(DatadogEndpoint endpoint)
      The Datadog endpoint to send data to.

      Parameters:
      endpoint - The Datadog endpoint to send data to. This parameter is required.
      Returns:
      this

    • backupMode

      @Stability(Stable) public Datadog.Builder backupMode(HttpBackupMode backupMode)
      Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to Datadog.

      Default: HttpBackupMode.FAILED

      Parameters:
      backupMode - Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to Datadog. This parameter is required.
      Returns:
      this

    • bufferingHints

      @Stability(Stable) public Datadog.Builder bufferingHints(HttpBufferingHints bufferingHints)
      Buffering hints for data delivery to the Datadog endpoint.

      Default: - interval of 60 seconds, size of 4 MiB

      Parameters:
      bufferingHints - Buffering hints for data delivery to the Datadog endpoint. This parameter is required.
      Returns:
      this

    • requestCompression

      @Stability(Stable) public Datadog.Builder requestCompression(HttpCompression requestCompression)
      Content encoding applied to the request body before delivery.

      Default: HttpCompression.GZIP

      Parameters:
      requestCompression - Content encoding applied to the request body before delivery. This parameter is required.
      Returns:
      this

    • retryOptions

      @Stability(Stable) public Datadog.Builder retryOptions(HttpRetryOptions retryOptions)
      Retry behavior when Kinesis Data Firehose cannot deliver data to Datadog.

      Default: - duration of 60 seconds

      Parameters:
      retryOptions - Retry behavior when Kinesis Data Firehose cannot deliver data to Datadog. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public Datadog.Builder tags(List<? extends HttpAttribute> tags)
      Datadog tags to apply for filtering.

      Default: - No tags.

      Parameters:
      tags - Datadog tags to apply for filtering. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public Datadog build()
      Specified by:
      build in interface software.amazon.jsii.Builder<Datadog>
      Returns:
      a newly built instance of Datadog.