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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceLogConfigurationType.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static LogConfigurationType.Builderbuilder()CloudWatchLogsConfigurationTypecloudWatchLogsConfiguration()The CloudWatch log group destination of user pool detailed activity logs, or of user activity log export with threat protection.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)EventSourceNameeventSource()The source of events that your user pool sends for logging.StringeventSourceAsString()The source of events that your user pool sends for logging.FirehoseConfigurationTypefirehoseConfiguration()The Amazon Data Firehose stream destination of user activity log export with threat protection.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()LogLevellogLevel()Theerrorlevelselection of logs that a user pool sends for detailed activity logging.StringlogLevelAsString()Theerrorlevelselection of logs that a user pool sends for detailed activity logging.S3ConfigurationTypes3Configuration()The Amazon S3 bucket destination of user activity log export with threat protection.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends LogConfigurationType.Builder>serializableBuilderClass()LogConfigurationType.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
logLevel
public final LogLevel logLevel()
The
errorlevelselection of logs that a user pool sends for detailed activity logging. To senduserNotificationactivity with information about message delivery, chooseERRORwithCloudWatchLogsConfiguration. To senduserAuthEventsactivity with user logs from threat protection with the Plus feature plan, chooseINFOwith one ofCloudWatchLogsConfiguration,FirehoseConfiguration, orS3Configuration.If the service returns an enum value that is not available in the current SDK version,
logLevelwill returnLogLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlogLevelAsString().- Returns:
- The
errorlevelselection of logs that a user pool sends for detailed activity logging. To senduserNotificationactivity with information about message delivery, chooseERRORwithCloudWatchLogsConfiguration. To senduserAuthEventsactivity with user logs from threat protection with the Plus feature plan, chooseINFOwith one ofCloudWatchLogsConfiguration,FirehoseConfiguration, orS3Configuration. - See Also:
LogLevel
-
logLevelAsString
public final String logLevelAsString()
The
errorlevelselection of logs that a user pool sends for detailed activity logging. To senduserNotificationactivity with information about message delivery, chooseERRORwithCloudWatchLogsConfiguration. To senduserAuthEventsactivity with user logs from threat protection with the Plus feature plan, chooseINFOwith one ofCloudWatchLogsConfiguration,FirehoseConfiguration, orS3Configuration.If the service returns an enum value that is not available in the current SDK version,
logLevelwill returnLogLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlogLevelAsString().- Returns:
- The
errorlevelselection of logs that a user pool sends for detailed activity logging. To senduserNotificationactivity with information about message delivery, chooseERRORwithCloudWatchLogsConfiguration. To senduserAuthEventsactivity with user logs from threat protection with the Plus feature plan, chooseINFOwith one ofCloudWatchLogsConfiguration,FirehoseConfiguration, orS3Configuration. - See Also:
LogLevel
-
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 touserAuthEvents.If the service returns an enum value that is not available in the current SDK version,
eventSourcewill returnEventSourceName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromeventSourceAsString().- 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 touserAuthEvents. - See Also:
EventSourceName
-
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 touserAuthEvents.If the service returns an enum value that is not available in the current SDK version,
eventSourcewill returnEventSourceName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromeventSourceAsString().- 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 touserAuthEvents. - See Also:
EventSourceName
-
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:
toBuilderin interfaceToCopyableBuilder<LogConfigurationType.Builder,LogConfigurationType>
-
builder
public static LogConfigurationType.Builder builder()
-
serializableBuilderClass
public static Class<? extends LogConfigurationType.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-