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(value="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 and Description
static interface	FirelensConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static FirelensConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOptions() Returns true if the Options property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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() Take this object and create a builder that contains all of the current property values of this object.
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

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()

Returns true if the Options property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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 AWS Fargate only support the file configuration file type.

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

You can use hasOptions() to see if a value was sent in this field.

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 AWS Fargate only support the file configuration file type.

toBuilder

public FirelensConfiguration.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<FirelensConfiguration.Builder,FirelensConfiguration>

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.