CfnUserPoolRiskConfigurationAttachmentMixinProps

class aws_cdk.mixins_preview.aws_cognito.mixins.CfnUserPoolRiskConfigurationAttachmentMixinProps(*, account_takeover_risk_configuration=None, client_id=None, compromised_credentials_risk_configuration=None, risk_exception_configuration=None, user_pool_id=None)

Bases: object

Properties for CfnUserPoolRiskConfigurationAttachmentPropsMixin.

Parameters:
  • account_takeover_risk_configuration (Union[IResolvable, AccountTakeoverRiskConfigurationTypeProperty, Dict[str, Any], None]) – The settings for automated responses and notification templates for adaptive authentication with threat protection.

  • client_id (Optional[str]) – The app client where this configuration is applied. When this parameter isn’t present, the risk configuration applies to all user pool app clients that don’t have client-level settings.

  • compromised_credentials_risk_configuration (Union[IResolvable, CompromisedCredentialsRiskConfigurationTypeProperty, Dict[str, Any], None]) – Settings for compromised-credentials actions and authentication types with threat protection in full-function ENFORCED mode.

  • risk_exception_configuration (Union[IResolvable, RiskExceptionConfigurationTypeProperty, Dict[str, Any], None]) – Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.

  • user_pool_id (Optional[str]) – The ID of the user pool that has the risk configuration applied.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.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

cfn_user_pool_risk_configuration_attachment_mixin_props = cognito_mixins.CfnUserPoolRiskConfigurationAttachmentMixinProps(
    account_takeover_risk_configuration=cognito_mixins.CfnUserPoolRiskConfigurationAttachmentPropsMixin.AccountTakeoverRiskConfigurationTypeProperty(
        actions=cognito_mixins.CfnUserPoolRiskConfigurationAttachmentPropsMixin.AccountTakeoverActionsTypeProperty(
            high_action=cognito_mixins.CfnUserPoolRiskConfigurationAttachmentPropsMixin.AccountTakeoverActionTypeProperty(
                event_action="eventAction",
                notify=False
            ),
            low_action=cognito_mixins.CfnUserPoolRiskConfigurationAttachmentPropsMixin.AccountTakeoverActionTypeProperty(
                event_action="eventAction",
                notify=False
            ),
            medium_action=cognito_mixins.CfnUserPoolRiskConfigurationAttachmentPropsMixin.AccountTakeoverActionTypeProperty(
                event_action="eventAction",
                notify=False
            )
        ),
        notify_configuration=cognito_mixins.CfnUserPoolRiskConfigurationAttachmentPropsMixin.NotifyConfigurationTypeProperty(
            block_email=cognito_mixins.CfnUserPoolRiskConfigurationAttachmentPropsMixin.NotifyEmailTypeProperty(
                html_body="htmlBody",
                subject="subject",
                text_body="textBody"
            ),
            from="from",
            mfa_email=cognito_mixins.CfnUserPoolRiskConfigurationAttachmentPropsMixin.NotifyEmailTypeProperty(
                html_body="htmlBody",
                subject="subject",
                text_body="textBody"
            ),
            no_action_email=cognito_mixins.CfnUserPoolRiskConfigurationAttachmentPropsMixin.NotifyEmailTypeProperty(
                html_body="htmlBody",
                subject="subject",
                text_body="textBody"
            ),
            reply_to="replyTo",
            source_arn="sourceArn"
        )
    ),
    client_id="clientId",
    compromised_credentials_risk_configuration=cognito_mixins.CfnUserPoolRiskConfigurationAttachmentPropsMixin.CompromisedCredentialsRiskConfigurationTypeProperty(
        actions=cognito_mixins.CfnUserPoolRiskConfigurationAttachmentPropsMixin.CompromisedCredentialsActionsTypeProperty(
            event_action="eventAction"
        ),
        event_filter=["eventFilter"]
    ),
    risk_exception_configuration=cognito_mixins.CfnUserPoolRiskConfigurationAttachmentPropsMixin.RiskExceptionConfigurationTypeProperty(
        blocked_ip_range_list=["blockedIpRangeList"],
        skipped_ip_range_list=["skippedIpRangeList"]
    ),
    user_pool_id="userPoolId"
)

Attributes

account_takeover_risk_configuration

The settings for automated responses and notification templates for adaptive authentication with threat protection.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfiguration

client_id

The app client where this configuration is applied.

When this parameter isn’t present, the risk configuration applies to all user pool app clients that don’t have client-level settings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-clientid

compromised_credentials_risk_configuration

Settings for compromised-credentials actions and authentication types with threat protection in full-function ENFORCED mode.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfiguration

risk_exception_configuration

Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-riskexceptionconfiguration

user_pool_id

The ID of the user pool that has the risk configuration applied.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-userpoolid