Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class LogConfigurationType

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

The configuration of user event logs to an external Amazon Web Services service like Amazon Data Firehose, Amazon S3, or Amazon CloudWatch Logs.

See Also:

  • Method Details

    • logLevel

      public final LogLevel logLevel()

      The errorlevel selection of logs that a user pool sends for detailed activity logging. To send userNotification activity with information about message delivery, choose ERROR with CloudWatchLogsConfiguration. To send userAuthEvents activity with user logs from threat protection with the Plus feature plan, choose INFO with one of CloudWatchLogsConfiguration, FirehoseConfiguration, or S3Configuration.

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

      Returns:
      The errorlevel selection of logs that a user pool sends for detailed activity logging. To send userNotification activity with information about message delivery, choose ERROR with CloudWatchLogsConfiguration. To send userAuthEvents activity with user logs from threat protection with the Plus feature plan, choose INFO with one of CloudWatchLogsConfiguration, FirehoseConfiguration, or S3Configuration.
      See Also:

    • logLevelAsString

      public final String logLevelAsString()

      The errorlevel selection of logs that a user pool sends for detailed activity logging. To send userNotification activity with information about message delivery, choose ERROR with CloudWatchLogsConfiguration. To send userAuthEvents activity with user logs from threat protection with the Plus feature plan, choose INFO with one of CloudWatchLogsConfiguration, FirehoseConfiguration, or S3Configuration.

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

      Returns:
      The errorlevel selection of logs that a user pool sends for detailed activity logging. To send userNotification activity with information about message delivery, choose ERROR with CloudWatchLogsConfiguration. To send userAuthEvents activity with user logs from threat protection with the Plus feature plan, choose INFO with one of CloudWatchLogsConfiguration, FirehoseConfiguration, or S3Configuration.
      See Also:

    • eventSource

      public final EventSourceName eventSource()

      The source of events that your user pool sends for logging. To send error-level logs about user notification activity, set to userNotification. To send info-level logs about threat-protection user activity in user pools with the Plus feature plan, set to userAuthEvents.

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

      Returns:
      The source of events that your user pool sends for logging. To send error-level logs about user notification activity, set to userNotification. To send info-level logs about threat-protection user activity in user pools with the Plus feature plan, set to userAuthEvents.
      See Also:

    • eventSourceAsString

      public final String eventSourceAsString()

      The source of events that your user pool sends for logging. To send error-level logs about user notification activity, set to userNotification. To send info-level logs about threat-protection user activity in user pools with the Plus feature plan, set to userAuthEvents.

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

      Returns:
      The source of events that your user pool sends for logging. To send error-level logs about user notification activity, set to userNotification. To send info-level logs about threat-protection user activity in user pools with the Plus feature plan, set to userAuthEvents.
      See Also:

    • cloudWatchLogsConfiguration

      public final CloudWatchLogsConfigurationType cloudWatchLogsConfiguration()

      The CloudWatch log group destination of user pool detailed activity logs, or of user activity log export with threat protection.

      Returns:
      The CloudWatch log group destination of user pool detailed activity logs, or of user activity log export with threat protection.

    • s3Configuration

      public final S3ConfigurationType s3Configuration()

      The Amazon S3 bucket destination of user activity log export with threat protection. To activate this setting, your user pool must be on the Plus tier.

      Returns:
      The Amazon S3 bucket destination of user activity log export with threat protection. To activate this setting, your user pool must be on the Plus tier.

    • firehoseConfiguration

      public final FirehoseConfigurationType firehoseConfiguration()

      The Amazon Data Firehose stream destination of user activity log export with threat protection. To activate this setting, your user pool must be on the Plus tier.

      Returns:
      The Amazon Data Firehose stream destination of user activity log export with threat protection. To activate this setting, your user pool must be on the Plus tier.

    • toBuilder

      public LogConfigurationType.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<LogConfigurationType.Builder,LogConfigurationType>

    • builder

      public static LogConfigurationType.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LogConfigurationType.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo