Package software.amazon.awscdk.services.ecs

Class SplunkLogDriver.Builder

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

  • Method Details

    • create

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

    • env

      @Stability(Stable) public SplunkLogDriver.Builder env(List<String> env)
      The env option takes an array of keys.

      If there is collision between label and env keys, the value of the env takes precedence. Adds additional fields to the extra attributes of a logging message.

      Default: - No env

      Parameters:
      env - The env option takes an array of keys. This parameter is required.
      Returns:
      this

    • envRegex

      @Stability(Stable) public SplunkLogDriver.Builder envRegex(String envRegex)
      The env-regex option is similar to and compatible with env.

      Its value is a regular expression to match logging-related environment variables. It is used for advanced log tag options.

      Default: - No envRegex

      Parameters:
      envRegex - The env-regex option is similar to and compatible with env. This parameter is required.
      Returns:
      this

    • labels

      @Stability(Stable) public SplunkLogDriver.Builder labels(List<String> labels)
      The labels option takes an array of keys.

      If there is collision between label and env keys, the value of the env takes precedence. Adds additional fields to the extra attributes of a logging message.

      Default: - No labels

      Parameters:
      labels - The labels option takes an array of keys. This parameter is required.
      Returns:
      this

    • tag

      @Stability(Stable) public SplunkLogDriver.Builder tag(String tag)
      By default, Docker uses the first 12 characters of the container ID to tag log messages.

      Refer to the log tag option documentation for customizing the log tag format.

      Default: - The first 12 characters of the container ID

      Parameters:
      tag - By default, Docker uses the first 12 characters of the container ID to tag log messages. This parameter is required.
      Returns:
      this

    • url

      @Stability(Stable) public SplunkLogDriver.Builder url(String url)
      Path to your Splunk Enterprise, self-service Splunk Cloud instance, or Splunk Cloud managed cluster (including port and scheme used by HTTP Event Collector) in one of the following formats: https://your_splunk_instance:8088 or https://input-prd-p-XXXXXXX.cloud.splunk.com:8088 or https://http-inputs-XXXXXXXX.splunkcloud.com.

      Parameters:
      url - Path to your Splunk Enterprise, self-service Splunk Cloud instance, or Splunk Cloud managed cluster (including port and scheme used by HTTP Event Collector) in one of the following formats: https://your_splunk_instance:8088 or https://input-prd-p-XXXXXXX.cloud.splunk.com:8088 or https://http-inputs-XXXXXXXX.splunkcloud.com. This parameter is required.
      Returns:
      this

    • caName

      @Stability(Stable) public SplunkLogDriver.Builder caName(String caName)
      Name to use for validating server certificate.

      Default: - The hostname of the splunk-url

      Parameters:
      caName - Name to use for validating server certificate. This parameter is required.
      Returns:
      this

    • caPath

      @Stability(Stable) public SplunkLogDriver.Builder caPath(String caPath)
      Path to root certificate.

      Default: - caPath not set.

      Parameters:
      caPath - Path to root certificate. This parameter is required.
      Returns:
      this

    • format

      @Stability(Stable) public SplunkLogDriver.Builder format(SplunkLogFormat format)
      Message format.

      Can be inline, json or raw.

      Default: - inline

      Parameters:
      format - Message format. This parameter is required.
      Returns:
      this

    • gzip

      @Stability(Stable) public SplunkLogDriver.Builder gzip(Boolean gzip)
      Enable/disable gzip compression to send events to Splunk Enterprise or Splunk Cloud instance.

      Default: - false

      Parameters:
      gzip - Enable/disable gzip compression to send events to Splunk Enterprise or Splunk Cloud instance. This parameter is required.
      Returns:
      this

    • gzipLevel

      @Stability(Stable) public SplunkLogDriver.Builder gzipLevel(Number gzipLevel)
      Set compression level for gzip.

      Valid values are -1 (default), 0 (no compression), 1 (best speed) ... 9 (best compression).

      Default: - -1 (Default Compression)

      Parameters:
      gzipLevel - Set compression level for gzip. This parameter is required.
      Returns:
      this

    • index

      @Stability(Stable) public SplunkLogDriver.Builder index(String index)
      Event index.

      Default: - index not set.

      Parameters:
      index - Event index. This parameter is required.
      Returns:
      this

    • insecureSkipVerify

      @Stability(Stable) public SplunkLogDriver.Builder insecureSkipVerify(String insecureSkipVerify)
      Ignore server certificate validation.

      Default: - insecureSkipVerify not set.

      Parameters:
      insecureSkipVerify - Ignore server certificate validation. This parameter is required.
      Returns:
      this

    • secretToken

      @Stability(Stable) public SplunkLogDriver.Builder secretToken(Secret secretToken)
      Splunk HTTP Event Collector token (Secret).

      The splunk-token is added to the SecretOptions property of the Log Driver Configuration. So the secret value will not be resolved or viewable as plain text.

      Please provide at least one of token or secretToken.

      Default: - If secret token is not provided, then the value provided in `token` will be used.

      Parameters:
      secretToken - Splunk HTTP Event Collector token (Secret). This parameter is required.
      Returns:
      this

    • source

      @Stability(Stable) public SplunkLogDriver.Builder source(String source)
      Event source.

      Default: - source not set.

      Parameters:
      source - Event source. This parameter is required.
      Returns:
      this

    • sourceType

      @Stability(Stable) public SplunkLogDriver.Builder sourceType(String sourceType)
      Event source type.

      Default: - sourceType not set.

      Parameters:
      sourceType - Event source type. This parameter is required.
      Returns:
      this

    • token

      @Stability(Deprecated) @Deprecated public SplunkLogDriver.Builder token(SecretValue token)
      Deprecated.
      Use SplunkLogDriverProps.secretToken instead.
      (deprecated) Splunk HTTP Event Collector token.

      The splunk-token is added to the Options property of the Log Driver Configuration. So the secret value will be resolved and viewable in plain text in the console.

      Please provide at least one of token or secretToken.

      Default: - token not provided.

      Parameters:
      token - Splunk HTTP Event Collector token. This parameter is required.
      Returns:
      this

    • verifyConnection

      @Stability(Stable) public SplunkLogDriver.Builder verifyConnection(Boolean verifyConnection)
      Verify on start, that docker can connect to Splunk server.

      Default: - true

      Parameters:
      verifyConnection - Verify on start, that docker can connect to Splunk server. This parameter is required.
      Returns:
      this

    • build

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