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: CfnResource

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.

See:

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

CloudformationResource:

AWS::Cognito::UserPoolRiskConfigurationAttachment

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 import 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"]
    )
)
Parameters:
  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

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

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

  • account_takeover_risk_configuration (Union[IResolvable, AccountTakeoverRiskConfigurationTypeProperty, Dict[str, Any], None]) – The settings for automated responses and notification templates for adaptive authentication with advanced security features.

  • compromised_credentials_risk_configuration (Union[IResolvable, CompromisedCredentialsRiskConfigurationTypeProperty, Dict[str, Any], None]) – Settings for compromised-credentials actions and authentication types with advanced security features 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.

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_dependency(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_depends_on(target)

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

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:
  • key (str) –

  • value (Any) –

See:

Return type:

None

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.

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 intermediate 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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

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 resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

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.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

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.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

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

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
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 settings for automated responses and notification templates for adaptive authentication with advanced security features.

cfn_options

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

cfn_resource_type

AWS resource type.

client_id

The app client where this configuration is applied.

compromised_credentials_risk_configuration

Settings for compromised-credentials actions and authentication types with advanced security features in full-function ENFORCED mode.

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.

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

Returns:

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

node

The tree node.

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 }).

risk_exception_configuration

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

stack

The stack in which this element is defined.

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

user_pool_id

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

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(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

AccountTakeoverActionTypeProperty

class CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty(*, event_action, notify)

Bases: object

The automated response to a risk level for adaptive authentication in full-function, or ENFORCED , mode.

You can assign an action to each risk level that advanced security features evaluates.

This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration .

Parameters:
  • event_action (str) – The action to take for the attempted account takeover action for the associated risk level. Valid values are as follows: - BLOCK : Block the request. - MFA_IF_CONFIGURED : Present an MFA challenge if possible. MFA is possible if the user pool has active MFA methods that the user can set up. For example, if the user pool only supports SMS message MFA but the user doesn’t have a phone number attribute, MFA setup isn’t possible. If MFA setup isn’t possible, allow the request. - MFA_REQUIRED : Present an MFA challenge if possible. Block the request if a user hasn’t set up MFA. To sign in with required MFA, users must have an email address or phone number attribute, or a registered TOTP factor. - NO_ACTION : Take no action. Permit sign-in.

  • notify (Union[bool, IResolvable]) – Determines whether Amazon Cognito sends a user a notification message when your user pools assesses a user’s session at the associated risk level.

See:

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

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

Attributes

event_action

The action to take for the attempted account takeover action for the associated risk level.

Valid values are as follows:

  • BLOCK : Block the request.

  • MFA_IF_CONFIGURED : Present an MFA challenge if possible. MFA is possible if the user pool has active MFA methods that the user can set up. For example, if the user pool only supports SMS message MFA but the user doesn’t have a phone number attribute, MFA setup isn’t possible. If MFA setup isn’t possible, allow the request.

  • MFA_REQUIRED : Present an MFA challenge if possible. Block the request if a user hasn’t set up MFA. To sign in with required MFA, users must have an email address or phone number attribute, or a registered TOTP factor.

  • NO_ACTION : Take no action. Permit sign-in.

See:

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

notify

Determines whether Amazon Cognito sends a user a notification message when your user pools assesses a user’s session at the associated risk level.

See:

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

AccountTakeoverActionsTypeProperty

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

Bases: object

A list of account-takeover actions for each level of risk that Amazon Cognito might assess with advanced security features.

This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration .

Parameters:
See:

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.
from aws_cdk import 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

The action that you assign to a high-risk assessment by advanced security features.

See:

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

low_action

The action that you assign to a low-risk assessment by advanced security features.

See:

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

medium_action

The action that you assign to a medium-risk assessment by advanced security features.

See:

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

AccountTakeoverRiskConfigurationTypeProperty

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

Bases: object

The settings for automated responses and notification templates for adaptive authentication with advanced security features.

This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration .

Parameters:
  • actions (Union[IResolvable, AccountTakeoverActionsTypeProperty, Dict[str, Any]]) – A list of account-takeover actions for each level of risk that Amazon Cognito might assess with advanced security features.

  • notify_configuration (Union[IResolvable, NotifyConfigurationTypeProperty, Dict[str, Any], None]) – The settings for composing and sending an email message when advanced security features assesses a risk level with adaptive authentication. When you choose to notify users in AccountTakeoverRiskConfiguration , Amazon Cognito sends an email message using the method and template that you set with this data type.

See:

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.
from aws_cdk import 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

A list of account-takeover actions for each level of risk that Amazon Cognito might assess with advanced security features.

See:

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

notify_configuration

The settings for composing and sending an email message when advanced security features assesses a risk level with adaptive authentication.

When you choose to notify users in AccountTakeoverRiskConfiguration , Amazon Cognito sends an email message using the method and template that you set with this data type.

See:

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

CompromisedCredentialsActionsTypeProperty

class CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsActionsTypeProperty(*, event_action)

Bases: object

Settings for user pool actions when Amazon Cognito detects compromised credentials with advanced security features in full-function ENFORCED mode.

This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration .

Parameters:

event_action (str) – The action that Amazon Cognito takes when it detects compromised credentials.

See:

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

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

Attributes

event_action

The action that Amazon Cognito takes when it detects compromised credentials.

See:

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

CompromisedCredentialsRiskConfigurationTypeProperty

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

Bases: object

Settings for compromised-credentials actions and authentication-event sources with advanced security features in full-function ENFORCED mode.

This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration .

Parameters:
  • actions (Union[IResolvable, CompromisedCredentialsActionsTypeProperty, Dict[str, Any]]) – Settings for the actions that you want your user pool to take when Amazon Cognito detects compromised credentials.

  • event_filter (Optional[Sequence[str]]) – Settings for the sign-in activity where you want to configure compromised-credentials actions. Defaults to all events.

See:

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.
from aws_cdk import 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

Settings for the actions that you want your user pool to take when Amazon Cognito detects compromised credentials.

See:

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

event_filter

Settings for the sign-in activity where you want to configure compromised-credentials actions.

Defaults to all events.

See:

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

NotifyConfigurationTypeProperty

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

Bases: object

The configuration for Amazon SES email messages that advanced security features sends to a user when your adaptive authentication automated response has a Notify action.

This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration .

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, Dict[str, Any], None]) – The template for the email message that your user pool sends when a detected risk event is blocked.

  • from – The email address that sends the email message. 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, Dict[str, Any], None]) – The template for the email message that your user pool sends when MFA is challenged in response to a detected risk.

  • no_action_email (Union[IResolvable, NotifyEmailTypeProperty, Dict[str, Any], None]) – The template for the email message that your user pool sends when no action is taken in response to a detected risk.

  • reply_to (Optional[str]) – The reply-to email address of an email template.

See:

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.
from aws_cdk import 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

The template for the email message that your user pool sends when a detected risk event is blocked.

See:

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

from_

The email address that sends the email message.

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

See:

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

mfa_email

The template for the email message that your user pool sends when MFA is challenged in response to a detected risk.

See:

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

no_action_email

The template for the email message that your user pool sends when no action is taken in response to a detected risk.

See:

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

reply_to

The reply-to email address of an email template.

See:

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

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.

See:

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

NotifyEmailTypeProperty

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

Bases: object

The template for email messages that advanced security features sends to a user when your threat protection automated response has a Notify action.

This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration .

Parameters:
  • subject (str) – The subject of the threat protection email notification.

  • html_body (Optional[str]) – The body of an email notification formatted in HTML. Choose an HtmlBody or a TextBody to send an HTML-formatted or plaintext message, respectively.

  • text_body (Optional[str]) – The body of an email notification formatted in plaintext. Choose an HtmlBody or a TextBody to send an HTML-formatted or plaintext message, respectively.

See:

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.
from aws_cdk import 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 body of an email notification formatted in HTML.

Choose an HtmlBody or a TextBody to send an HTML-formatted or plaintext message, respectively.

See:

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

subject

The subject of the threat protection email notification.

See:

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

text_body

The body of an email notification formatted in plaintext.

Choose an HtmlBody or a TextBody to send an HTML-formatted or plaintext message, respectively.

See:

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

RiskExceptionConfigurationTypeProperty

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

Bases: object

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

This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration .

Parameters:
  • blocked_ip_range_list (Optional[Sequence[str]]) – An always-block IP address list. Overrides the risk decision and always blocks authentication requests. This parameter is displayed and set in CIDR notation.

  • skipped_ip_range_list (Optional[Sequence[str]]) – An always-allow IP address list. Risk detection isn’t performed on the IP addresses in this range list. This parameter is displayed and set in CIDR notation.

See:

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.
from aws_cdk import 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

An always-block IP address list.

Overrides the risk decision and always blocks authentication requests. This parameter is displayed and set in CIDR notation.

See:

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

skipped_ip_range_list

An always-allow IP address list.

Risk detection isn’t performed on the IP addresses in this range list. This parameter is displayed and set in CIDR notation.

See:

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