Skip to content

LogConfigurationType

Source code in docs_src/capo_cognito_identity_provider/types/log_configuration_type.py
class LogConfigurationType(TypedDict, closed=True):
    log_level: "capo_cognito_identity_provider.types.log_level.LogLevel"
    """<p>The <code>errorlevel</code> selection of logs that a user pool sends for detailed activity logging. To send <code>userNotification</code> activity with <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html">information about message delivery</a>, choose <code>ERROR</code> with <code>CloudWatchLogsConfiguration</code>. To send <code>userAuthEvents</code> activity with user logs from threat protection with the Plus feature plan, choose <code>INFO</code> with one of <code>CloudWatchLogsConfiguration</code>, <code>FirehoseConfiguration</code>, or <code>S3Configuration</code>.</p>"""
    event_source: (
        "capo_cognito_identity_provider.types.event_source_name.EventSourceName"
    )
    """<p>The source of events that your user pool sends for logging. To send error-level logs about user notification activity, set to <code>userNotification</code>. To send info-level logs about threat-protection user activity in user pools with the Plus feature plan, set to <code>userAuthEvents</code>.</p>"""
    cloud_watch_logs_configuration: NotRequired[
        "capo_cognito_identity_provider.types.cloud_watch_logs_configuration_type.CloudWatchLogsConfigurationType"
    ]
    """<p>The CloudWatch log group destination of user pool detailed activity logs, or of user activity log export with threat protection.</p>"""
    s3_configuration: NotRequired[
        "capo_cognito_identity_provider.types.s3_configuration_type.S3ConfigurationType"
    ]
    """<p>The Amazon S3 bucket destination of user activity log export with threat protection. To activate this setting, your user pool must be on the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html"> Plus tier</a>.</p>"""
    firehose_configuration: NotRequired[
        "capo_cognito_identity_provider.types.firehose_configuration_type.FirehoseConfigurationType"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html"> Plus tier</a>.</p>"""

cloud_watch_logs_configuration instance-attribute

cloud_watch_logs_configuration: NotRequired[CloudWatchLogsConfigurationType]

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

event_source instance-attribute

event_source: EventSourceName

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.

firehose_configuration instance-attribute

firehose_configuration: NotRequired[FirehoseConfigurationType]

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.

log_level instance-attribute

log_level: 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.

s3_configuration instance-attribute

s3_configuration: NotRequired[S3ConfigurationType]

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.