Class LustreLogCreateConfiguration

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

The Lustre logging configuration used when creating or updating an Amazon FSx for Lustre file system. An Amazon File Cache is created with Lustre logging enabled by default, with a setting of WARN_ERROR for the logging events. which can't be changed.

Lustre logging writes the enabled logging events for your file system or cache to Amazon CloudWatch Logs.

See Also:

  • Method Details

    • level

      public final LustreAccessAuditLogLevel level()

      Sets which data repository events are logged by Amazon FSx.

      • WARN_ONLY - only warning events are logged.

      • ERROR_ONLY - only error events are logged.

      • WARN_ERROR - both warning events and error events are logged.

      • DISABLED - logging of data repository events is turned off.

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

      Returns:
      Sets which data repository events are logged by Amazon FSx.

      • WARN_ONLY - only warning events are logged.

      • ERROR_ONLY - only error events are logged.

      • WARN_ERROR - both warning events and error events are logged.

      • DISABLED - logging of data repository events is turned off.

      See Also:

    • levelAsString

      public final String levelAsString()

      Sets which data repository events are logged by Amazon FSx.

      • WARN_ONLY - only warning events are logged.

      • ERROR_ONLY - only error events are logged.

      • WARN_ERROR - both warning events and error events are logged.

      • DISABLED - logging of data repository events is turned off.

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

      Returns:
      Sets which data repository events are logged by Amazon FSx.

      • WARN_ONLY - only warning events are logged.

      • ERROR_ONLY - only error events are logged.

      • WARN_ERROR - both warning events and error events are logged.

      • DISABLED - logging of data repository events is turned off.

      See Also:

    • destination

      public final String destination()

      The Amazon Resource Name (ARN) that specifies the destination of the logs.

      The destination can be any Amazon CloudWatch Logs log group ARN, with the following requirements:

      • The destination ARN that you provide must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

      • The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix.

      • If you do not provide a destination, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/lustre log group (for Amazon FSx for Lustre) or /aws/fsx/filecache (for Amazon File Cache).

      • If Destination is provided and the resource does not exist, the request will fail with a BadRequest error.

      • If Level is set to DISABLED, you cannot specify a destination in Destination.

      Returns:
      The Amazon Resource Name (ARN) that specifies the destination of the logs.

      The destination can be any Amazon CloudWatch Logs log group ARN, with the following requirements:

      • The destination ARN that you provide must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

      • The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix.

      • If you do not provide a destination, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/lustre log group (for Amazon FSx for Lustre) or /aws/fsx/filecache (for Amazon File Cache).

      • If Destination is provided and the resource does not exist, the request will fail with a BadRequest error.

      • If Level is set to DISABLED, you cannot specify a destination in Destination.

    • toBuilder

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

    • builder

      public static LustreLogCreateConfiguration.Builder builder()

    • serializableBuilderClass

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