CfnLogDeliveryConfigurationPropsMixin

class aws_cdk.mixins_preview.aws_cognito.mixins.CfnLogDeliveryConfigurationPropsMixin(props, *, strategy=None)

Bases: Mixin

Sets up or modifies the logging configuration of a user pool.

User pools can export user notification logs and, when threat protection is active, user-activity logs. For more information, see Exporting user pool logs .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-logdeliveryconfiguration.html
CloudformationResource:: AWS::Cognito::LogDeliveryConfiguration
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_cognito import mixins as cognito_mixins

cfn_log_delivery_configuration_props_mixin = cognito_mixins.CfnLogDeliveryConfigurationPropsMixin(cognito_mixins.CfnLogDeliveryConfigurationMixinProps(
    log_configurations=[cognito_mixins.CfnLogDeliveryConfigurationPropsMixin.LogConfigurationProperty(
        cloud_watch_logs_configuration=cognito_mixins.CfnLogDeliveryConfigurationPropsMixin.CloudWatchLogsConfigurationProperty(
            log_group_arn="logGroupArn"
        ),
        event_source="eventSource",
        firehose_configuration=cognito_mixins.CfnLogDeliveryConfigurationPropsMixin.FirehoseConfigurationProperty(
            stream_arn="streamArn"
        ),
        log_level="logLevel",
        s3_configuration=cognito_mixins.CfnLogDeliveryConfigurationPropsMixin.S3ConfigurationProperty(
            bucket_arn="bucketArn"
        )
    )],
    user_pool_id="userPoolId"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Cognito::LogDeliveryConfiguration.

Parameters:

props (Union[CfnLogDeliveryConfigurationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['logConfigurations', 'userPoolId']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

CloudWatchLogsConfigurationProperty

class CfnLogDeliveryConfigurationPropsMixin.CloudWatchLogsConfigurationProperty(*, log_group_arn=None)

Bases: object

Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features.

Parameters:: log_group_arn (Optional[str]) – 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 AWS Key Management Service and must be in the same AWS 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 AWS services .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-cloudwatchlogsconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cognito import mixins as cognito_mixins

cloud_watch_logs_configuration_property = cognito_mixins.CfnLogDeliveryConfigurationPropsMixin.CloudWatchLogsConfigurationProperty(
    log_group_arn="logGroupArn"
)

Attributes

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 AWS Key Management Service and must be in the same AWS 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 AWS services .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-cloudwatchlogsconfiguration.html#cfn-cognito-logdeliveryconfiguration-cloudwatchlogsconfiguration-loggrouparn

FirehoseConfigurationProperty

class CfnLogDeliveryConfigurationPropsMixin.FirehoseConfigurationProperty(*, stream_arn=None)

Bases: object

Configuration for the Amazon Data Firehose stream destination of user activity log export with threat protection.

Parameters:: stream_arn (Optional[str]) – The ARN of an Amazon Data Firehose stream that’s the destination for threat protection log export.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-firehoseconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cognito import mixins as cognito_mixins

firehose_configuration_property = cognito_mixins.CfnLogDeliveryConfigurationPropsMixin.FirehoseConfigurationProperty(
    stream_arn="streamArn"
)

Attributes

stream_arn

The ARN of an Amazon Data Firehose stream that’s the destination for threat protection log export.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-firehoseconfiguration.html#cfn-cognito-logdeliveryconfiguration-firehoseconfiguration-streamarn

LogConfigurationProperty

class CfnLogDeliveryConfigurationPropsMixin.LogConfigurationProperty(*, cloud_watch_logs_configuration=None, event_source=None, firehose_configuration=None, log_level=None, s3_configuration=None)

Bases: object

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

Parameters:

cloud_watch_logs_configuration (Union[IResolvable, CloudWatchLogsConfigurationProperty, Dict[str, Any], None]) – Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features.
event_source (Optional[str]) – 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 (Union[IResolvable, FirehoseConfigurationProperty, Dict[str, Any], None]) – Configuration for the Amazon Data Firehose stream destination of user activity log export with threat protection.
log_level (Optional[str]) – 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 (Union[IResolvable, S3ConfigurationProperty, Dict[str, Any], None]) – Configuration for the Amazon S3 bucket destination of user activity log export with threat protection.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cognito import mixins as cognito_mixins

log_configuration_property = cognito_mixins.CfnLogDeliveryConfigurationPropsMixin.LogConfigurationProperty(
    cloud_watch_logs_configuration=cognito_mixins.CfnLogDeliveryConfigurationPropsMixin.CloudWatchLogsConfigurationProperty(
        log_group_arn="logGroupArn"
    ),
    event_source="eventSource",
    firehose_configuration=cognito_mixins.CfnLogDeliveryConfigurationPropsMixin.FirehoseConfigurationProperty(
        stream_arn="streamArn"
    ),
    log_level="logLevel",
    s3_configuration=cognito_mixins.CfnLogDeliveryConfigurationPropsMixin.S3ConfigurationProperty(
        bucket_arn="bucketArn"
    )
)

Attributes

cloud_watch_logs_configuration

Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-cloudwatchlogsconfiguration

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 threat-protection user activity in user pools with the Plus feature plan, set to userAuthEvents .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-eventsource

firehose_configuration

Configuration for the Amazon Data Firehose stream destination of user activity log export with threat protection.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-firehoseconfiguration

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 threat protection with the Plus feature plan, choose INFO with one of CloudWatchLogsConfiguration , FirehoseConfiguration , or S3Configuration .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-loglevel

s3_configuration

Configuration for the Amazon S3 bucket destination of user activity log export with threat protection.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-s3configuration

S3ConfigurationProperty

class CfnLogDeliveryConfigurationPropsMixin.S3ConfigurationProperty(*, bucket_arn=None)

Bases: object

Configuration for the Amazon S3 bucket destination of user activity log export with threat protection.

Parameters:: bucket_arn (Optional[str]) – The ARN of an Amazon S3 bucket that’s the destination for threat protection log export.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-s3configuration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cognito import mixins as cognito_mixins

s3_configuration_property = cognito_mixins.CfnLogDeliveryConfigurationPropsMixin.S3ConfigurationProperty(
    bucket_arn="bucketArn"
)

Attributes

bucket_arn

The ARN of an Amazon S3 bucket that’s the destination for threat protection log export.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-s3configuration.html#cfn-cognito-logdeliveryconfiguration-s3configuration-bucketarn