Interface ISplunkLogDriverProps

Specifies the splunk log driver configuration options.

Inherited Members
Namespace: Amazon.CDK.AWS.ECS
Assembly: Amazon.CDK.AWS.ECS.dll
Syntax (csharp)
public interface ISplunkLogDriverProps : IBaseLogDriverProps
Syntax (vb)
Public Interface ISplunkLogDriverProps
    Inherits IBaseLogDriverProps
Remarks

Source

ExampleMetadata: infused

Examples
// Create a Task Definition for the container to start
var taskDefinition = new Ec2TaskDefinition(this, "TaskDef");
taskDefinition.AddContainer("TheContainer", new ContainerDefinitionOptions {
    Image = ContainerImage.FromRegistry("example-image"),
    MemoryLimitMiB = 256,
    Logging = LogDrivers.Splunk(new SplunkLogDriverProps {
        Token = SecretValue.SecretsManager("my-splunk-token"),
        Url = "my-splunk-url"
    })
});

Synopsis

Properties

CaName

Name to use for validating server certificate.
CaPath

Path to root certificate.
Format

Message format.
Gzip

Enable/disable gzip compression to send events to Splunk Enterprise or Splunk Cloud instance.
GzipLevel

Set compression level for gzip.
Index

Event index.
InsecureSkipVerify

Ignore server certificate validation.
SecretToken

Splunk HTTP Event Collector token (Secret).
Source

Event source.
SourceType

Event source type.
Token

(deprecated) Splunk HTTP Event Collector token.
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.
VerifyConnection

Verify on start, that docker can connect to Splunk server.

Properties

CaName

Name to use for validating server certificate.

virtual string CaName { get; }
Property Value

System.String

Remarks

Default: - The hostname of the splunk-url

CaPath

Path to root certificate.

virtual string CaPath { get; }
Property Value

System.String

Remarks

Default: - caPath not set.

Format

Message format.

virtual Nullable<SplunkLogFormat> Format { get; }
Property Value

System.Nullable<SplunkLogFormat>

Remarks

Can be inline, json or raw.

Default: - inline

Gzip

Enable/disable gzip compression to send events to Splunk Enterprise or Splunk Cloud instance.

virtual Nullable<bool> Gzip { get; }
Property Value

System.Nullable<System.Boolean>

Remarks

Default: - false

GzipLevel

Set compression level for gzip.

virtual Nullable<double> GzipLevel { get; }
Property Value

System.Nullable<System.Double>

Remarks

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

Default: - -1 (Default Compression)

Index

Event index.

virtual string Index { get; }
Property Value

System.String

Remarks

Default: - index not set.

InsecureSkipVerify

Ignore server certificate validation.

virtual string InsecureSkipVerify { get; }
Property Value

System.String

Remarks

Default: - insecureSkipVerify not set.

SecretToken

Splunk HTTP Event Collector token (Secret).

virtual Secret SecretToken { get; }
Property Value

Secret

Remarks

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.

Source

Event source.

virtual string Source { get; }
Property Value

System.String

Remarks

Default: - source not set.

SourceType

Event source type.

virtual string SourceType { get; }
Property Value

System.String

Remarks

Default: - sourceType not set.

Token

(deprecated) Splunk HTTP Event Collector token.

virtual SecretValue Token { get; }
Property Value

SecretValue

Remarks

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.

Stability: Deprecated

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.

string Url { get; }
Property Value

System.String

VerifyConnection

Verify on start, that docker can connect to Splunk server.

virtual Nullable<bool> VerifyConnection { get; }
Property Value

System.Nullable<System.Boolean>

Remarks

Default: - true