SplunkLogDriverProps¶
-
class
aws_cdk.aws_ecs.
SplunkLogDriverProps
(*, env=None, env_regex=None, labels=None, tag=None, token, url, ca_name=None, ca_path=None, format=None, gzip=None, gzip_level=None, index=None, insecure_skip_verify=None, source=None, source_type=None, verify_connection=None)¶ Bases:
aws_cdk.aws_ecs.BaseLogDriverProps
Specifies the splunk log driver configuration options.
- Parameters
env (
Optional
[List
[str
]]) – 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 envenv_regex (
Optional
[str
]) – 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 envRegexlabels (
Optional
[List
[str
]]) – 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 labelstag (
Optional
[str
]) – 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 IDtoken (
SecretValue
) – Splunk HTTP Event Collector token.url (
str
) – 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.ca_name (
Optional
[str
]) – Name to use for validating server certificate. Default: - The hostname of the splunk-urlca_path (
Optional
[str
]) – Path to root certificate. Default: - caPath not set.format (
Optional
[SplunkLogFormat
]) – Message format. Can be inline, json or raw. Default: - inlinegzip (
Optional
[bool
]) – Enable/disable gzip compression to send events to Splunk Enterprise or Splunk Cloud instance. Default: - falsegzip_level (
Union
[int
,float
,None
]) – Set compression level for gzip. Valid values are -1 (default), 0 (no compression), 1 (best speed) … 9 (best compression). Default: - -1 (Default Compression)index (
Optional
[str
]) – Event index. Default: - index not set.insecure_skip_verify (
Optional
[str
]) – Ignore server certificate validation. Default: - insecureSkipVerify not set.source (
Optional
[str
]) – Event source. Default: - source not set.source_type (
Optional
[str
]) – Event source type. Default: - sourceType not set.verify_connection (
Optional
[bool
]) – Verify on start, that docker can connect to Splunk server. Default: - true
Attributes
-
ca_name
¶ Name to use for validating server certificate.
- Default
The hostname of the splunk-url
- Return type
Optional
[str
]
-
ca_path
¶ Path to root certificate.
- Default
caPath not set.
- Return type
Optional
[str
]
-
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
- Return type
Optional
[List
[str
]]
-
env_regex
¶ 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
- Return type
Optional
[str
]
-
format
¶ Message format.
Can be inline, json or raw.
- Default
inline
- Return type
Optional
[SplunkLogFormat
]
-
gzip
¶ Enable/disable gzip compression to send events to Splunk Enterprise or Splunk Cloud instance.
- Default
false
- Return type
Optional
[bool
]
-
gzip_level
¶ Set compression level for gzip.
Valid values are -1 (default), 0 (no compression), 1 (best speed) … 9 (best compression).
- Default
-1 (Default Compression)
- Return type
Union
[int
,float
,None
]
-
index
¶ Event index.
- Default
index not set.
- Return type
Optional
[str
]
-
insecure_skip_verify
¶ Ignore server certificate validation.
- Default
insecureSkipVerify not set.
- Return type
Optional
[str
]
-
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
- Return type
Optional
[List
[str
]]
-
source
¶ Event source.
- Default
source not set.
- Return type
Optional
[str
]
-
source_type
¶ Event source type.
- Default
sourceType not set.
- Return type
Optional
[str
]
-
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
- Return type
Optional
[str
]
-
token
¶ Splunk HTTP Event Collector token.
- Return type
-
url
¶ //your_splunk_instance:8088 or https://input-prd-p-XXXXXXX.cloud.splunk.com:8088 or https://http-inputs-XXXXXXXX.splunkcloud.com.
- Type
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
- Type
https
- Return type
str
-
verify_connection
¶ Verify on start, that docker can connect to Splunk server.
- Default
true
- Return type
Optional
[bool
]