CfnUserPoolRiskConfigurationAttachment

class aws_cdk.aws_cognito.CfnUserPoolRiskConfigurationAttachment(scope, id, *, client_id, user_pool_id, account_takeover_risk_configuration=None, compromised_credentials_risk_configuration=None, risk_exception_configuration=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::Cognito::UserPoolRiskConfigurationAttachment.

The AWS::Cognito::UserPoolRiskConfigurationAttachment resource sets the risk configuration that is used for Amazon Cognito advanced security features.

You can specify risk configuration for a single client (with a specific clientId ) or for all clients (by setting the clientId to ALL ). If you specify ALL , the default configuration is used for every client that has had no risk configuration set previously. If you specify risk configuration for a particular client, it no longer falls back to the ALL configuration.

CloudformationResource

AWS::Cognito::UserPoolRiskConfigurationAttachment

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 = cognito.CfnUserPoolRiskConfigurationAttachment(self, "MyCfnUserPoolRiskConfigurationAttachment",
    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"]
    )
)

Create a new AWS::Cognito::UserPoolRiskConfigurationAttachment.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

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

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Cognito::UserPoolRiskConfigurationAttachment'
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]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

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]

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

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]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

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

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

AccountTakeoverActionTypeProperty

class CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty(*, event_action, notify)

Bases: object

Account takeover action type.

Parameters
  • event_action (str) – The action to take in response to the account takeover action. Valid values are as follows:. - BLOCK Choosing this action will block the request. - MFA_IF_CONFIGURED Present an MFA challenge if user has configured it, else allow the request. - MFA_REQUIRED Present an MFA challenge if user has configured it, else block the request. - NO_ACTION Allow the user to sign in.

  • notify (Union[bool, IResolvable]) – Flag specifying whether to send a notification.

Link

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

account_takeover_action_type_property = cognito.CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty(
    event_action="eventAction",
    notify=False
)

Attributes

event_action

.

  • BLOCK Choosing this action will block the request.

  • MFA_IF_CONFIGURED Present an MFA challenge if user has configured it, else allow the request.

  • MFA_REQUIRED Present an MFA challenge if user has configured it, else block the request.

  • NO_ACTION Allow the user to sign in.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype-eventaction

Type

The action to take in response to the account takeover action. Valid values are as follows

Return type

str

notify

Flag specifying whether to send a notification.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype-notify

Return type

Union[bool, IResolvable]

AccountTakeoverActionsTypeProperty

class CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionsTypeProperty(*, high_action=None, low_action=None, medium_action=None)

Bases: object

Account takeover actions type.

Parameters
Link

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

account_takeover_actions_type_property = 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
    )
)

Attributes

high_action

Action to take for a high risk.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype-highaction

Return type

Union[IResolvable, AccountTakeoverActionTypeProperty, None]

low_action

Action to take for a low risk.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype-lowaction

Return type

Union[IResolvable, AccountTakeoverActionTypeProperty, None]

medium_action

Action to take for a medium risk.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype-mediumaction

Return type

Union[IResolvable, AccountTakeoverActionTypeProperty, None]

AccountTakeoverRiskConfigurationTypeProperty

class CfnUserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationTypeProperty(*, actions, notify_configuration=None)

Bases: object

Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.

Parameters
Link

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

account_takeover_risk_configuration_type_property = 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"
    )
)

Attributes

actions

Account takeover risk configuration actions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype-actions

Return type

Union[IResolvable, AccountTakeoverActionsTypeProperty]

notify_configuration

The notify configuration used to construct email notifications.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype-notifyconfiguration

Return type

Union[IResolvable, NotifyConfigurationTypeProperty, None]

CompromisedCredentialsActionsTypeProperty

class CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsActionsTypeProperty(*, event_action)

Bases: object

The compromised credentials actions type.

Parameters

event_action (str) – The event action.

Link

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

compromised_credentials_actions_type_property = cognito.CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsActionsTypeProperty(
    event_action="eventAction"
)

Attributes

event_action

The event action.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsactionstype.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsactionstype-eventaction

Return type

str

CompromisedCredentialsRiskConfigurationTypeProperty

class CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypeProperty(*, actions, event_filter=None)

Bases: object

The compromised credentials risk configuration type.

Parameters
  • actions (Union[IResolvable, CompromisedCredentialsActionsTypeProperty]) – The compromised credentials risk configuration actions.

  • event_filter (Optional[Sequence[str]]) – Perform the action for these events. The default is to perform all events if no event filter is specified.

Link

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

compromised_credentials_risk_configuration_type_property = cognito.CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypeProperty(
    actions=cognito.CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsActionsTypeProperty(
        event_action="eventAction"
    ),

    # the properties below are optional
    event_filter=["eventFilter"]
)

Attributes

actions

The compromised credentials risk configuration actions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype-actions

Return type

Union[IResolvable, CompromisedCredentialsActionsTypeProperty]

event_filter

Perform the action for these events.

The default is to perform all events if no event filter is specified.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype-eventfilter

Return type

Optional[List[str]]

NotifyConfigurationTypeProperty

class CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty(*, source_arn, block_email=None, from_=None, mfa_email=None, no_action_email=None, reply_to=None)

Bases: object

The notify configuration type.

Parameters
  • source_arn (str) – The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. This identity permits Amazon Cognito to send for the email address specified in the From parameter.

  • block_email (Union[IResolvable, NotifyEmailTypeProperty, None]) – Email template used when a detected risk event is blocked.

  • from – The email address that is sending the email. The address must be either individually verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.

  • mfa_email (Union[IResolvable, NotifyEmailTypeProperty, None]) – The multi-factor authentication (MFA) email template used when MFA is challenged as part of a detected risk.

  • no_action_email (Union[IResolvable, NotifyEmailTypeProperty, None]) – The email template used when a detected risk event is allowed.

  • reply_to (Optional[str]) – The destination to which the receiver of an email should reply to.

Link

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

notify_configuration_type_property = 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"
)

Attributes

block_email

Email template used when a detected risk event is blocked.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-blockemail

Return type

Union[IResolvable, NotifyEmailTypeProperty, None]

from_

The email address that is sending the email.

The address must be either individually verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-from

Return type

Optional[str]

mfa_email

The multi-factor authentication (MFA) email template used when MFA is challenged as part of a detected risk.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-mfaemail

Return type

Union[IResolvable, NotifyEmailTypeProperty, None]

no_action_email

The email template used when a detected risk event is allowed.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-noactionemail

Return type

Union[IResolvable, NotifyEmailTypeProperty, None]

reply_to

The destination to which the receiver of an email should reply to.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-replyto

Return type

Optional[str]

source_arn

The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy.

This identity permits Amazon Cognito to send for the email address specified in the From parameter.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-sourcearn

Return type

str

NotifyEmailTypeProperty

class CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypeProperty(*, subject, html_body=None, text_body=None)

Bases: object

The notify email type.

Parameters
  • subject (str) – The email subject.

  • html_body (Optional[str]) – The email HTML body.

  • text_body (Optional[str]) – The email text body.

Link

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

notify_email_type_property = cognito.CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypeProperty(
    subject="subject",

    # the properties below are optional
    html_body="htmlBody",
    text_body="textBody"
)

Attributes

html_body

The email HTML body.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyemailtype-htmlbody

Return type

Optional[str]

subject

The email subject.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyemailtype-subject

Return type

str

text_body

The email text body.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyemailtype-textbody

Return type

Optional[str]

RiskExceptionConfigurationTypeProperty

class CfnUserPoolRiskConfigurationAttachment.RiskExceptionConfigurationTypeProperty(*, blocked_ip_range_list=None, skipped_ip_range_list=None)

Bases: object

The type of the configuration to override the risk decision.

Parameters
  • blocked_ip_range_list (Optional[Sequence[str]]) – Overrides the risk decision to always block the pre-authentication requests. The IP range is in CIDR notation, a compact representation of an IP address and its routing prefix.

  • skipped_ip_range_list (Optional[Sequence[str]]) – Risk detection isn’t performed on the IP addresses in this range list. The IP range is in CIDR notation.

Link

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

risk_exception_configuration_type_property = cognito.CfnUserPoolRiskConfigurationAttachment.RiskExceptionConfigurationTypeProperty(
    blocked_ip_range_list=["blockedIpRangeList"],
    skipped_ip_range_list=["skippedIpRangeList"]
)

Attributes

blocked_ip_range_list

Overrides the risk decision to always block the pre-authentication requests.

The IP range is in CIDR notation, a compact representation of an IP address and its routing prefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype-blockediprangelist

Return type

Optional[List[str]]

skipped_ip_range_list

Risk detection isn’t performed on the IP addresses in this range list.

The IP range is in CIDR notation.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype-skippediprangelist

Return type

Optional[List[str]]