Class ServiceConnectAccessLogConfiguration

java.lang.Object
software.amazon.awssdk.services.ecs.model.ServiceConnectAccessLogConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ServiceConnectAccessLogConfiguration.Builder,ServiceConnectAccessLogConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class ServiceConnectAccessLogConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ServiceConnectAccessLogConfiguration.Builder,ServiceConnectAccessLogConfiguration>

Configuration for Service Connect access logging. Access logs provide detailed information about requests made to your service, including request patterns, response codes, and timing data for debugging and monitoring purposes.

To enable access logs, you must also specify a logConfiguration in the serviceConnectConfiguration.

See Also:

  • Method Details

    • format

      public final ServiceConnectAccessLoggingFormat format()

      The format for Service Connect access log output. Choose TEXT for human-readable logs or JSON for structured data that integrates well with log analysis tools.

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

      Returns:
      The format for Service Connect access log output. Choose TEXT for human-readable logs or JSON for structured data that integrates well with log analysis tools.
      See Also:

    • formatAsString

      public final String formatAsString()

      The format for Service Connect access log output. Choose TEXT for human-readable logs or JSON for structured data that integrates well with log analysis tools.

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

      Returns:
      The format for Service Connect access log output. Choose TEXT for human-readable logs or JSON for structured data that integrates well with log analysis tools.
      See Also:

    • includeQueryParameters

      public final ServiceConnectIncludeQueryParameters includeQueryParameters()

      Specifies whether to include query parameters in Service Connect access logs.

      When enabled, query parameters from HTTP requests are included in the access logs. Consider security and privacy implications when enabling this feature, as query parameters may contain sensitive information such as request IDs and tokens. By default, this parameter is DISABLED.

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

      Returns:
      Specifies whether to include query parameters in Service Connect access logs.

      When enabled, query parameters from HTTP requests are included in the access logs. Consider security and privacy implications when enabling this feature, as query parameters may contain sensitive information such as request IDs and tokens. By default, this parameter is DISABLED.

      See Also:

    • includeQueryParametersAsString

      public final String includeQueryParametersAsString()

      Specifies whether to include query parameters in Service Connect access logs.

      When enabled, query parameters from HTTP requests are included in the access logs. Consider security and privacy implications when enabling this feature, as query parameters may contain sensitive information such as request IDs and tokens. By default, this parameter is DISABLED.

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

      Returns:
      Specifies whether to include query parameters in Service Connect access logs.

      When enabled, query parameters from HTTP requests are included in the access logs. Consider security and privacy implications when enabling this feature, as query parameters may contain sensitive information such as request IDs and tokens. By default, this parameter is DISABLED.

      See Also:

    • toBuilder

      public ServiceConnectAccessLogConfiguration.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<ServiceConnectAccessLogConfiguration.Builder,ServiceConnectAccessLogConfiguration>
      Returns:
      a builder for type T

    • builder

      public static ServiceConnectAccessLogConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ServiceConnectAccessLogConfiguration.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.