Class: Aws::CognitoIdentityProvider::Types::LogConfigurationType

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::LogConfigurationType

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

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

This data type is a request parameter of

SetLogDeliveryConfiguration][1

and a response parameter of

[GetLogDeliveryConfiguration].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetLogDeliveryConfiguration.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetLogDeliveryConfiguration.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cloud_watch_logs_configuration ⇒ Types::CloudWatchLogsConfigurationType

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

• #event_source ⇒ String

  The source of events that your user pool sends for logging.

• #firehose_configuration ⇒ Types::FirehoseConfigurationType

  The Amazon Data Firehose stream destination of user activity log export with advanced security features.

• #log_level ⇒ String

  The ‘errorlevel` selection of logs that a user pool sends for detailed activity logging.

• #s3_configuration ⇒ Types::S3ConfigurationType

  The Amazon S3 bucket destination of user activity log export with advanced security features.

Instance Attribute Details

#cloud_watch_logs_configuration ⇒ Types::CloudWatchLogsConfigurationType

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

Returns:

• (Types::CloudWatchLogsConfigurationType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8247

class LogConfigurationType < Struct.new(
  :log_level,
  :event_source,
  :cloud_watch_logs_configuration,
  :s3_configuration,
  :firehose_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#event_source ⇒ String

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`.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8247

class LogConfigurationType < Struct.new(
  :log_level,
  :event_source,
  :cloud_watch_logs_configuration,
  :s3_configuration,
  :firehose_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#firehose_configuration ⇒ Types::FirehoseConfigurationType

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.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html

Returns:

• (Types::FirehoseConfigurationType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8247

class LogConfigurationType < Struct.new(
  :log_level,
  :event_source,
  :cloud_watch_logs_configuration,
  :s3_configuration,
  :firehose_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#log_level ⇒ String

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`.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/tracking-quotas-and-usage-in-cloud-watch-logs.html

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8247

class LogConfigurationType < Struct.new(
  :log_level,
  :event_source,
  :cloud_watch_logs_configuration,
  :s3_configuration,
  :firehose_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#s3_configuration ⇒ Types::S3ConfigurationType

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.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html

Returns:

• (Types::S3ConfigurationType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8247

class LogConfigurationType < Struct.new(
  :log_level,
  :event_source,
  :cloud_watch_logs_configuration,
  :s3_configuration,
  :firehose_configuration)
  SENSITIVE = []
  include Aws::Structure
end