Package software.amazon.awscdk.services.ecs

Class SplunkLogDriverProps.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.SplunkLogDriverProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SplunkLogDriverProps>

Enclosing interface:

SplunkLogDriverProps

@Stability(Stable)
public static final class SplunkLogDriverProps.Builder
extends Object
implements software.amazon.jsii.Builder<SplunkLogDriverProps>

A builder for SplunkLogDriverProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SplunkLogDriverProps	build()	Builds the configured instance.
SplunkLogDriverProps.Builder	caName(String caName)	Sets the value of SplunkLogDriverProps.getCaName()
SplunkLogDriverProps.Builder	caPath(String caPath)	Sets the value of SplunkLogDriverProps.getCaPath()
SplunkLogDriverProps.Builder	env(List<String> env)	Sets the value of BaseLogDriverProps.getEnv()
SplunkLogDriverProps.Builder	envRegex(String envRegex)	Sets the value of BaseLogDriverProps.getEnvRegex()
SplunkLogDriverProps.Builder	format(SplunkLogFormat format)	Sets the value of SplunkLogDriverProps.getFormat()
SplunkLogDriverProps.Builder	gzip(Boolean gzip)	Sets the value of SplunkLogDriverProps.getGzip()
SplunkLogDriverProps.Builder	gzipLevel(Number gzipLevel)	Sets the value of SplunkLogDriverProps.getGzipLevel()
SplunkLogDriverProps.Builder	index(String index)	Sets the value of SplunkLogDriverProps.getIndex()
SplunkLogDriverProps.Builder	insecureSkipVerify(String insecureSkipVerify)	Sets the value of SplunkLogDriverProps.getInsecureSkipVerify()
SplunkLogDriverProps.Builder	labels(List<String> labels)	Sets the value of BaseLogDriverProps.getLabels()
SplunkLogDriverProps.Builder	secretToken(Secret secretToken)	Sets the value of SplunkLogDriverProps.getSecretToken()
SplunkLogDriverProps.Builder	source(String source)	Sets the value of SplunkLogDriverProps.getSource()
SplunkLogDriverProps.Builder	sourceType(String sourceType)	Sets the value of SplunkLogDriverProps.getSourceType()
SplunkLogDriverProps.Builder	tag(String tag)	Sets the value of BaseLogDriverProps.getTag()
SplunkLogDriverProps.Builder	url(String url)	Sets the value of SplunkLogDriverProps.getUrl()
SplunkLogDriverProps.Builder	verifyConnection(Boolean verifyConnection)	Sets the value of SplunkLogDriverProps.getVerifyConnection()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

secretToken

@Stability(Stable)
public SplunkLogDriverProps.Builder secretToken(Secret secretToken)

Sets the value of SplunkLogDriverProps.getSecretToken()

Parameters:

secretToken - Splunk HTTP Event Collector token (Secret). This parameter is required. 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.

Returns:

this

url

@Stability(Stable)
public SplunkLogDriverProps.Builder url(String url)

Sets the value of SplunkLogDriverProps.getUrl()

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 SplunkLogDriverProps.Builder caName(String caName)

Sets the value of SplunkLogDriverProps.getCaName()

Parameters:

caName - Name to use for validating server certificate.

Returns:

this

caPath

@Stability(Stable)
public SplunkLogDriverProps.Builder caPath(String caPath)

Sets the value of SplunkLogDriverProps.getCaPath()

Parameters:

caPath - Path to root certificate.

Returns:

this

format

@Stability(Stable)
public SplunkLogDriverProps.Builder format(SplunkLogFormat format)

Sets the value of SplunkLogDriverProps.getFormat()

Parameters:

format - Message format. Can be inline, json or raw.

Returns:

this

gzip

@Stability(Stable)
public SplunkLogDriverProps.Builder gzip(Boolean gzip)

Sets the value of SplunkLogDriverProps.getGzip()

Parameters:

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

Returns:

this

gzipLevel

@Stability(Stable)
public SplunkLogDriverProps.Builder gzipLevel(Number gzipLevel)

Sets the value of SplunkLogDriverProps.getGzipLevel()

Parameters:

gzipLevel - Set compression level for gzip. Valid values are -1 (default), 0 (no compression), 1 (best speed) ... 9 (best compression).

Returns:

this

index

@Stability(Stable)
public SplunkLogDriverProps.Builder index(String index)

Sets the value of SplunkLogDriverProps.getIndex()

Parameters:

index - Event index.

Returns:

this

insecureSkipVerify

@Stability(Stable)
public SplunkLogDriverProps.Builder insecureSkipVerify(String insecureSkipVerify)

Sets the value of SplunkLogDriverProps.getInsecureSkipVerify()

Parameters:

insecureSkipVerify - Ignore server certificate validation.

Returns:

this

source

@Stability(Stable)
public SplunkLogDriverProps.Builder source(String source)

Sets the value of SplunkLogDriverProps.getSource()

Parameters:

source - Event source.

Returns:

this

sourceType

@Stability(Stable)
public SplunkLogDriverProps.Builder sourceType(String sourceType)

Sets the value of SplunkLogDriverProps.getSourceType()

Parameters:

sourceType - Event source type.

Returns:

this

verifyConnection

@Stability(Stable)
public SplunkLogDriverProps.Builder verifyConnection(Boolean verifyConnection)

Sets the value of SplunkLogDriverProps.getVerifyConnection()

Parameters:

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

Returns:

this

env

@Stability(Stable)
public SplunkLogDriverProps.Builder env(List<String> env)

Sets the value of BaseLogDriverProps.getEnv()

Parameters:

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.

Returns:

this

envRegex

@Stability(Stable)
public SplunkLogDriverProps.Builder envRegex(String envRegex)

Sets the value of BaseLogDriverProps.getEnvRegex()

Parameters:

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.

Returns:

this

labels

@Stability(Stable)
public SplunkLogDriverProps.Builder labels(List<String> labels)

Sets the value of BaseLogDriverProps.getLabels()

Parameters:

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.

Returns:

this

tag

@Stability(Stable)
public SplunkLogDriverProps.Builder tag(String tag)

Sets the value of BaseLogDriverProps.getTag()

Parameters:

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.

Returns:

this

build

@Stability(Stable)
public SplunkLogDriverProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<SplunkLogDriverProps>

Returns:

a new instance of SplunkLogDriverProps

Throws:

NullPointerException - if any required attribute was not provided