AWS::Cognito::LogDeliveryConfiguration - AWS CloudFormation

AWS::Cognito::LogDeliveryConfiguration

Sets up or modifies the logging configuration of a user pool. User pools can export user notification logs and advanced security features user activity logs.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::Cognito::LogDeliveryConfiguration", "Properties" : { "LogConfigurations" : [ LogConfiguration, ... ], "UserPoolId" : String } }

YAML

Type: AWS::Cognito::LogDeliveryConfiguration Properties: LogConfigurations: - LogConfiguration UserPoolId: String

Properties

LogConfigurations

A logging destination of a user pool. User pools can have multiple logging destinations for message-delivery and user-activity logs.

Required: No

Type: Array of LogConfiguration

Minimum: 0

Maximum: 2

Update requires: No interruption

UserPoolId

The ID of the user pool where you configured logging.

Required: Yes

Type: String

Pattern: [\w-]+_[0-9a-zA-Z]+

Minimum: 1

Maximum: 55

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns a resource identifier. A log delivery configuration attached to a user pool returns a user pool ID like us-east-1_EXAMPLE.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Id

A user pool ID, for example us-east-1_EXAMPLE.