Package software.amazon.awssdk.services.ecs.model

Class FirelensConfiguration

java.lang.Object

software.amazon.awssdk.services.ecs.model.FirelensConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FirelensConfiguration.Builder,FirelensConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class FirelensConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FirelensConfiguration.Builder,FirelensConfiguration>

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FirelensConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static FirelensConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOptions()	For responses, this returns true if the service returned a value for the Options property.
Map<String,String>	options()	The options to use when configuring the log router.
List<SdkField<?>>	sdkFields()
static Class<? extends FirelensConfiguration.Builder>	serializableBuilderClass()
FirelensConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
FirelensConfigurationType	type()	The log router to use.
String	typeAsString()	The log router to use.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

type

public final FirelensConfigurationType type()

The log router to use. The valid values are fluentd or fluentbit.

If the service returns an enum value that is not available in the current SDK version, type will return FirelensConfigurationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The log router to use. The valid values are fluentd or fluentbit.

See Also:

FirelensConfigurationType

typeAsString

public final String typeAsString()

The log router to use. The valid values are fluentd or fluentbit.

If the service returns an enum value that is not available in the current SDK version, type will return FirelensConfigurationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The log router to use. The valid values are fluentd or fluentbit.

See Also:

FirelensConfigurationType

hasOptions

public final boolean hasOptions()

For responses, this returns true if the service returned a value for the Options property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

options

public final Map<String,String> options()

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"} . For more information, see Creating a task definition that uses a FireLens configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOptions() method.

Returns:

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"} . For more information, see Creating a task definition that uses a FireLens configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

toBuilder

public FirelensConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FirelensConfiguration.Builder,FirelensConfiguration>

builder

public static FirelensConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends FirelensConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo