CfnUserPoolRiskConfigurationAttachmentProps

class aws_cdk.aws_cognito.CfnUserPoolRiskConfigurationAttachmentProps(*, client_id, user_pool_id, account_takeover_risk_configuration=None, compromised_credentials_risk_configuration=None, risk_exception_configuration=None)

Bases: object

Properties for defining a CfnUserPoolRiskConfigurationAttachment.

Parameters
  • client_id (str) – The app client ID. You can specify the risk configuration for a single client (with a specific ClientId) or for all clients (by setting the ClientId to ALL ).

  • user_pool_id (str) – The user pool ID.

  • account_takeover_risk_configuration (Union[IResolvable, AccountTakeoverRiskConfigurationTypeProperty, None]) – The account takeover risk configuration object, including the NotifyConfiguration object and Actions to take if there is an account takeover.

  • compromised_credentials_risk_configuration (Union[IResolvable, CompromisedCredentialsRiskConfigurationTypeProperty, None]) – The compromised credentials risk configuration object, including the EventFilter and the EventAction .

  • risk_exception_configuration (Union[IResolvable, RiskExceptionConfigurationTypeProperty, None]) – The configuration to override the risk decision.

Link

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.
import aws_cdk.aws_cognito as cognito

cfn_user_pool_risk_configuration_attachment_props = cognito.CfnUserPoolRiskConfigurationAttachmentProps(
    client_id="clientId",
    user_pool_id="userPoolId",

    # the properties below are optional
    account_takeover_risk_configuration=cognito.CfnUserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationTypeProperty(
        actions=cognito.CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionsTypeProperty(
            high_action=cognito.CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty(
                event_action="eventAction",
                notify=False
            ),
            low_action=cognito.CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty(
                event_action="eventAction",
                notify=False
            ),
            medium_action=cognito.CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty(
                event_action="eventAction",
                notify=False
            )
        ),

        # the properties below are optional
        notify_configuration=cognito.CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty(
            source_arn="sourceArn",

            # the properties below are optional
            block_email=cognito.CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypeProperty(
                subject="subject",

                # the properties below are optional
                html_body="htmlBody",
                text_body="textBody"
            ),
            from="from",
            mfa_email=cognito.CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypeProperty(
                subject="subject",

                # the properties below are optional
                html_body="htmlBody",
                text_body="textBody"
            ),
            no_action_email=cognito.CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypeProperty(
                subject="subject",

                # the properties below are optional
                html_body="htmlBody",
                text_body="textBody"
            ),
            reply_to="replyTo"
        )
    ),
    compromised_credentials_risk_configuration=cognito.CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypeProperty(
        actions=cognito.CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsActionsTypeProperty(
            event_action="eventAction"
        ),

        # the properties below are optional
        event_filter=["eventFilter"]
    ),
    risk_exception_configuration=cognito.CfnUserPoolRiskConfigurationAttachment.RiskExceptionConfigurationTypeProperty(
        blocked_ip_range_list=["blockedIpRangeList"],
        skipped_ip_range_list=["skippedIpRangeList"]
    )
)

Attributes

account_takeover_risk_configuration

The account takeover risk configuration object, including the NotifyConfiguration object and Actions to take if there is an account takeover.

Link

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

Return type

Union[IResolvable, AccountTakeoverRiskConfigurationTypeProperty, None]

client_id

The app client ID.

You can specify the risk configuration for a single client (with a specific ClientId) or for all clients (by setting the ClientId to ALL ).

Link

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

Return type

str

compromised_credentials_risk_configuration

The compromised credentials risk configuration object, including the EventFilter and the EventAction .

Link

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

Return type

Union[IResolvable, CompromisedCredentialsRiskConfigurationTypeProperty, None]

risk_exception_configuration

The configuration to override the risk decision.

Link

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

Return type

Union[IResolvable, RiskExceptionConfigurationTypeProperty, None]

user_pool_id

The user pool ID.

Link

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

Return type

str