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.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:47.448Z")
@Stability(Stable)
public interface SplunkLogDriverProps
extends software.amazon.jsii.JsiiSerializable, BaseLogDriverProps

Specifies the splunk log driver configuration options.

Source

Example:

 // 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()
                 .token(SecretValue.secretsManager("my-splunk-token"))
                 .url("my-splunk-url")
                 .build()))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SplunkLogDriverProps.Builder	A builder for SplunkLogDriverProps
static final class	SplunkLogDriverProps.Jsii$Proxy	An implementation for SplunkLogDriverProps

Method Summary

Modifier and Type	Method	Description
static SplunkLogDriverProps.Builder	builder()
default String	getCaName()	Name to use for validating server certificate.
default String	getCaPath()	Path to root certificate.
default SplunkLogFormat	getFormat()	Message format.
default Boolean	getGzip()	Enable/disable gzip compression to send events to Splunk Enterprise or Splunk Cloud instance.
default Number	getGzipLevel()	Set compression level for gzip.
default String	getIndex()	Event index.
default String	getInsecureSkipVerify()	Ignore server certificate validation.
default Secret	getSecretToken()	Splunk HTTP Event Collector token (Secret).
default String	getSource()	Event source.
default String	getSourceType()	Event source type.
default SecretValue	getToken()	Deprecated. Use SplunkLogDriverProps.secretToken instead.
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.
default Boolean	getVerifyConnection()	Verify on start, that docker can connect to Splunk server.

Methods inherited from interface software.amazon.awscdk.services.ecs.BaseLogDriverProps

getEnv, getEnvRegex, getLabels, getTag

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

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.

getSecretToken

@Stability(Stable)
@Nullable
default 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.

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.

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.

getToken

@Stability(Deprecated)
@Deprecated
@Nullable
default SecretValue getToken()

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.

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