Package software.amazon.awssdk.services.fsx.model

Class WindowsAuditLogConfiguration

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

The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system. For more information, see File access auditing.

See Also:

  • Method Details

    • fileAccessAuditLogLevel

      public final WindowsAccessAuditLogLevel fileAccessAuditLogLevel()

      Sets which attempt type is logged by Amazon FSx for file and folder accesses.

      • SUCCESS_ONLY - only successful attempts to access files or folders are logged.

      • FAILURE_ONLY - only failed attempts to access files or folders are logged.

      • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.

      • DISABLED - access auditing of files and folders is turned off.

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

      Returns:
      Sets which attempt type is logged by Amazon FSx for file and folder accesses.

      • SUCCESS_ONLY - only successful attempts to access files or folders are logged.

      • FAILURE_ONLY - only failed attempts to access files or folders are logged.

      • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.

      • DISABLED - access auditing of files and folders is turned off.

      See Also:

    • fileAccessAuditLogLevelAsString

      public final String fileAccessAuditLogLevelAsString()

      Sets which attempt type is logged by Amazon FSx for file and folder accesses.

      • SUCCESS_ONLY - only successful attempts to access files or folders are logged.

      • FAILURE_ONLY - only failed attempts to access files or folders are logged.

      • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.

      • DISABLED - access auditing of files and folders is turned off.

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

      Returns:
      Sets which attempt type is logged by Amazon FSx for file and folder accesses.

      • SUCCESS_ONLY - only successful attempts to access files or folders are logged.

      • FAILURE_ONLY - only failed attempts to access files or folders are logged.

      • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.

      • DISABLED - access auditing of files and folders is turned off.

      See Also:

    • fileShareAccessAuditLogLevel

      public final WindowsAccessAuditLogLevel fileShareAccessAuditLogLevel()

      Sets which attempt type is logged by Amazon FSx for file share accesses.

      • SUCCESS_ONLY - only successful attempts to access file shares are logged.

      • FAILURE_ONLY - only failed attempts to access file shares are logged.

      • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.

      • DISABLED - access auditing of file shares is turned off.

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

      Returns:
      Sets which attempt type is logged by Amazon FSx for file share accesses.

      • SUCCESS_ONLY - only successful attempts to access file shares are logged.

      • FAILURE_ONLY - only failed attempts to access file shares are logged.

      • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.

      • DISABLED - access auditing of file shares is turned off.

      See Also:

    • fileShareAccessAuditLogLevelAsString

      public final String fileShareAccessAuditLogLevelAsString()

      Sets which attempt type is logged by Amazon FSx for file share accesses.

      • SUCCESS_ONLY - only successful attempts to access file shares are logged.

      • FAILURE_ONLY - only failed attempts to access file shares are logged.

      • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.

      • DISABLED - access auditing of file shares is turned off.

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

      Returns:
      Sets which attempt type is logged by Amazon FSx for file share accesses.

      • SUCCESS_ONLY - only successful attempts to access file shares are logged.

      • FAILURE_ONLY - only failed attempts to access file shares are logged.

      • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.

      • DISABLED - access auditing of file shares is turned off.

      See Also:

    • auditLogDestination

      public final String auditLogDestination()

      The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN.

      The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehose delivery stream must begin with the aws-fsx prefix.

      The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

      Returns:
      The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN.

      The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehose delivery stream must begin with the aws-fsx prefix.

      The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

    • toBuilder

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

    • builder

      public static WindowsAuditLogConfiguration.Builder builder()

    • serializableBuilderClass

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