@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.
Modifier and Type | Class and Description |
---|---|
static interface |
FirelensConfiguration.Builder |
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.
|
copy
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()
.
fluentd
or fluentbit
.FirelensConfigurationType
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()
.
fluentd
or fluentbit
.FirelensConfigurationType
public final boolean hasOptions()
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.
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.
"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.public FirelensConfiguration.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<FirelensConfiguration.Builder,FirelensConfiguration>
public static FirelensConfiguration.Builder builder()
public static Class<? extends FirelensConfiguration.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.