Package software.amazon.awscdk.services.kinesisfirehose

Class HttpEndpoint.Builder

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

  • Method Details

    • create

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

    • loggingConfig

      @Stability(Stable) public HttpEndpoint.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 HttpEndpoint.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 HttpEndpoint.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 HttpEndpoint.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 HttpEndpoint.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

    • endpointConfig

      @Stability(Stable) public HttpEndpoint.Builder endpointConfig(HttpEndpointConfig endpointConfig)
      Describes the configuration of the Http endpoint to which Kinesis Firehose delivers data.

      Parameters:
      endpointConfig - Describes the configuration of the Http endpoint to which Kinesis Firehose delivers data. This parameter is required.
      Returns:
      this

    • attributes

      @Stability(Stable) public HttpEndpoint.Builder attributes(List<? extends HttpAttribute> attributes)
      Describes the metadata sent to the Http endpoint destination.

      Default: - None

      Parameters:
      attributes - Describes the metadata sent to the Http endpoint destination. This parameter is required.
      Returns:
      this

    • backupMode

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

      Default: - Failed data only

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

    • bufferingHints

      @Stability(Stable) public HttpEndpoint.Builder bufferingHints(HttpBufferingHints bufferingHints)
      The buffering options that can be used before data is delivered to the specified destination.

      Default: - None

      Parameters:
      bufferingHints - The buffering options that can be used before data is delivered to the specified destination. This parameter is required.
      Returns:
      this

    • requestCompression

      @Stability(Stable) public HttpEndpoint.Builder requestCompression(HttpCompression requestCompression)
      Compress the body of a request before sending the request to the destination.

      Default: - None

      Parameters:
      requestCompression - Compress the body of a request before sending the request to the destination. This parameter is required.
      Returns:
      this

    • retryOptions

      @Stability(Stable) public HttpEndpoint.Builder retryOptions(HttpRetryOptions retryOptions)
      The total amount of time that Kinesis Data Firehose spends on retries.

      Default: - None

      Parameters:
      retryOptions - The total amount of time that Kinesis Data Firehose spends on retries. This parameter is required.
      Returns:
      this

    • build

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