Skip to content
AWS for Query.Farm

aws.cognito_idp.get_log_delivery_configuration

Example SQL Queries

SELECT * FROM
aws.cognito_idp.get_log_delivery_configuration
WHERE
"user_pool_id" = 'VALUE';

Description

Gets the logging configuration of a user pool.

Table Definition

Column NameColumn Data Type
user_pool_id Required Input Column

The ID of the user pool that has the logging configuration that you want to view.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
log_delivery_configuration

The logging configuration of the requested user pool.

STRUCT(
    "user_pool_id" VARCHAR,
    "log_configurations" STRUCT(
        "log_level" VARCHAR,
        "event_source" VARCHAR,
        "cloud_watch_logs_configuration" STRUCT(
            "log_group_arn" VARCHAR
        ),
        "s3_configuration" STRUCT(
            "bucket_arn" VARCHAR
        ),
        "firehose_configuration" STRUCT(
            "stream_arn" VARCHAR
        )
    )[]
)
Show child fields
log_delivery_configuration.log_configurations[]
Show child fields
log_delivery_configuration.log_configurations[].cloud_watch_logs_configuration

The CloudWatch log group destination of user pool detailed activity logs, or of user activity log export with advanced security features.

Show child fields
log_delivery_configuration.log_configurations[].cloud_watch_logs_configuration.log_group_arn

The Amazon Resource Name (arn) of a CloudWatch Logs log group where your user pool sends logs. The log group must not be encrypted with Key Management Service and must be in the same Amazon Web Services account as your user pool.

To send logs to log groups with a resource policy of a size greater than 5120 characters, configure a log group with a path that starts with /aws/vendedlogs. For more information, see Enabling logging from certain Amazon Web Services services.

log_delivery_configuration.log_configurations[].event_source

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 advanced security features user activity, set to userAuthEvents.

log_delivery_configuration.log_configurations[].firehose_configuration

The Amazon Data Firehose stream destination of user activity log export with advanced security features. To activate this setting, advanced security features must be active in your user pool.

Show child fields
log_delivery_configuration.log_configurations[].firehose_configuration.stream_arn

The ARN of an Amazon Data Firehose stream that's the destination for advanced security features log export.

log_delivery_configuration.log_configurations[].log_level

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 advanced security features, choose INFO with one of CloudWatchLogsConfiguration, FirehoseConfiguration, or S3Configuration.

log_delivery_configuration.log_configurations[].s3_configuration

The Amazon S3 bucket destination of user activity log export with advanced security features. To activate this setting, advanced security features must be active in your user pool.

Show child fields
log_delivery_configuration.log_configurations[].s3_configuration.bucket_arn

The ARN of an Amazon S3 bucket that's the destination for advanced security features log export.

log_delivery_configuration.user_pool_id

The ID of the user pool where you configured logging.