Package software.amazon.awscdk.services.ecs

Interface SplunkLogDriverProps

All Superinterfaces:
BaseLogDriverProps, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
SplunkLogDriverProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:24:01.176Z") @Stability(Stable) public interface SplunkLogDriverProps extends software.amazon.jsii.JsiiSerializable, BaseLogDriverProps
Specifies the splunk log driver configuration options.

Source

Example: 

 Secret secret;
 // Create a Task Definition for the container to start
 Ec2TaskDefinition taskDefinition = new Ec2TaskDefinition(this, "TaskDef");
 taskDefinition.addContainer("TheContainer", ContainerDefinitionOptions.builder()
         .image(ContainerImage.fromRegistry("example-image"))
         .memoryLimitMiB(256)
         .logging(LogDrivers.splunk(SplunkLogDriverProps.builder()
                 .secretToken(secret)
                 .url("my-splunk-url")
                 .build()))
         .build());

  • Method Details

    • getSecretToken

      @Stability(Stable) @NotNull Secret getSecretToken()
      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.

    • getUrl

      @Stability(Stable) @NotNull String getUrl()
      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.

    • getCaName

      @Stability(Stable) @Nullable default String getCaName()
      Name to use for validating server certificate.

      Default: - The hostname of the splunk-url

    • getCaPath

      @Stability(Stable) @Nullable default String getCaPath()
      Path to root certificate.

      Default: - caPath not set.

    • getFormat

      @Stability(Stable) @Nullable default SplunkLogFormat getFormat()
      Message format.

      Can be inline, json or raw.

      Default: - inline

    • getGzip

      @Stability(Stable) @Nullable default Boolean getGzip()
      Enable/disable gzip compression to send events to Splunk Enterprise or Splunk Cloud instance.

      Default: - false

    • getGzipLevel

      @Stability(Stable) @Nullable default Number getGzipLevel()
      Set compression level for gzip.

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

      Default: - -1 (Default Compression)

    • getIndex

      @Stability(Stable) @Nullable default String getIndex()
      Event index.

      Default: - index not set.

    • getInsecureSkipVerify

      @Stability(Stable) @Nullable default String getInsecureSkipVerify()
      Ignore server certificate validation.

      Default: - insecureSkipVerify not set.

    • getSource

      @Stability(Stable) @Nullable default String getSource()
      Event source.

      Default: - source not set.

    • getSourceType

      @Stability(Stable) @Nullable default String getSourceType()
      Event source type.

      Default: - sourceType not set.

    • getVerifyConnection

      @Stability(Stable) @Nullable default Boolean getVerifyConnection()
      Verify on start, that docker can connect to Splunk server.

      Default: - true

    • builder

      @Stability(Stable) static SplunkLogDriverProps.Builder builder()
      Returns:
      a SplunkLogDriverProps.Builder of SplunkLogDriverProps