Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. cognito
  5. RiskConfiguration
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.cognito.RiskConfiguration

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a Cognito Risk Configuration resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.cognito.RiskConfiguration("example", {
    userPoolId: exampleAwsCognitoUserPool.id,
    riskExceptionConfiguration: {
        blockedIpRangeLists: ["10.10.10.10/32"],
    },
});

    import pulumi
import pulumi_aws as aws

example = aws.cognito.RiskConfiguration("example",
    user_pool_id=example_aws_cognito_user_pool["id"],
    risk_exception_configuration={
        "blocked_ip_range_lists": ["10.10.10.10/32"],
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cognito"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cognito.NewRiskConfiguration(ctx, "example", &cognito.RiskConfigurationArgs{
			UserPoolId: pulumi.Any(exampleAwsCognitoUserPool.Id),
			RiskExceptionConfiguration: &cognito.RiskConfigurationRiskExceptionConfigurationArgs{
				BlockedIpRangeLists: pulumi.StringArray{
					pulumi.String("10.10.10.10/32"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Cognito.RiskConfiguration("example", new()
    {
        UserPoolId = exampleAwsCognitoUserPool.Id,
        RiskExceptionConfiguration = new Aws.Cognito.Inputs.RiskConfigurationRiskExceptionConfigurationArgs
        {
            BlockedIpRangeLists = new[]
            {
                "10.10.10.10/32",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cognito.RiskConfiguration;
import com.pulumi.aws.cognito.RiskConfigurationArgs;
import com.pulumi.aws.cognito.inputs.RiskConfigurationRiskExceptionConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new RiskConfiguration("example", RiskConfigurationArgs.builder()
            .userPoolId(exampleAwsCognitoUserPool.id())
            .riskExceptionConfiguration(RiskConfigurationRiskExceptionConfigurationArgs.builder()
                .blockedIpRangeLists("10.10.10.10/32")
                .build())
            .build());

    }
}

    resources:
  example:
    type: aws:cognito:RiskConfiguration
    properties:
      userPoolId: ${exampleAwsCognitoUserPool.id}
      riskExceptionConfiguration:
        blockedIpRangeLists:
          - 10.10.10.10/32

    Create RiskConfiguration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RiskConfiguration(name: string, args: RiskConfigurationArgs, opts?: CustomResourceOptions);
    @overload
def RiskConfiguration(resource_name: str,
                      args: RiskConfigurationArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def RiskConfiguration(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      user_pool_id: Optional[str] = None,
                      account_takeover_risk_configuration: Optional[RiskConfigurationAccountTakeoverRiskConfigurationArgs] = None,
                      client_id: Optional[str] = None,
                      compromised_credentials_risk_configuration: Optional[RiskConfigurationCompromisedCredentialsRiskConfigurationArgs] = None,
                      risk_exception_configuration: Optional[RiskConfigurationRiskExceptionConfigurationArgs] = None)
    func NewRiskConfiguration(ctx *Context, name string, args RiskConfigurationArgs, opts ...ResourceOption) (*RiskConfiguration, error)
    public RiskConfiguration(string name, RiskConfigurationArgs args, CustomResourceOptions? opts = null)
    public RiskConfiguration(String name, RiskConfigurationArgs args)
public RiskConfiguration(String name, RiskConfigurationArgs args, CustomResourceOptions options)

    type: aws:cognito:RiskConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args RiskConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RiskConfigurationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RiskConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RiskConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RiskConfigurationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var riskConfigurationResource = new Aws.Cognito.RiskConfiguration("riskConfigurationResource", new()
{
    UserPoolId = "string",
    AccountTakeoverRiskConfiguration = new Aws.Cognito.Inputs.RiskConfigurationAccountTakeoverRiskConfigurationArgs
    {
        Actions = new Aws.Cognito.Inputs.RiskConfigurationAccountTakeoverRiskConfigurationActionsArgs
        {
            HighAction = new Aws.Cognito.Inputs.RiskConfigurationAccountTakeoverRiskConfigurationActionsHighActionArgs
            {
                EventAction = "string",
                Notify = false,
            },
            LowAction = new Aws.Cognito.Inputs.RiskConfigurationAccountTakeoverRiskConfigurationActionsLowActionArgs
            {
                EventAction = "string",
                Notify = false,
            },
            MediumAction = new Aws.Cognito.Inputs.RiskConfigurationAccountTakeoverRiskConfigurationActionsMediumActionArgs
            {
                EventAction = "string",
                Notify = false,
            },
        },
        NotifyConfiguration = new Aws.Cognito.Inputs.RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationArgs
        {
            SourceArn = "string",
            BlockEmail = new Aws.Cognito.Inputs.RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationBlockEmailArgs
            {
                HtmlBody = "string",
                Subject = "string",
                TextBody = "string",
            },
            From = "string",
            MfaEmail = new Aws.Cognito.Inputs.RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationMfaEmailArgs
            {
                HtmlBody = "string",
                Subject = "string",
                TextBody = "string",
            },
            NoActionEmail = new Aws.Cognito.Inputs.RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationNoActionEmailArgs
            {
                HtmlBody = "string",
                Subject = "string",
                TextBody = "string",
            },
            ReplyTo = "string",
        },
    },
    ClientId = "string",
    CompromisedCredentialsRiskConfiguration = new Aws.Cognito.Inputs.RiskConfigurationCompromisedCredentialsRiskConfigurationArgs
    {
        Actions = new Aws.Cognito.Inputs.RiskConfigurationCompromisedCredentialsRiskConfigurationActionsArgs
        {
            EventAction = "string",
        },
        EventFilters = new[]
        {
            "string",
        },
    },
    RiskExceptionConfiguration = new Aws.Cognito.Inputs.RiskConfigurationRiskExceptionConfigurationArgs
    {
        BlockedIpRangeLists = new[]
        {
            "string",
        },
        SkippedIpRangeLists = new[]
        {
            "string",
        },
    },
});

    example, err := cognito.NewRiskConfiguration(ctx, "riskConfigurationResource", &cognito.RiskConfigurationArgs{
	UserPoolId: pulumi.String("string"),
	AccountTakeoverRiskConfiguration: &cognito.RiskConfigurationAccountTakeoverRiskConfigurationArgs{
		Actions: &cognito.RiskConfigurationAccountTakeoverRiskConfigurationActionsArgs{
			HighAction: &cognito.RiskConfigurationAccountTakeoverRiskConfigurationActionsHighActionArgs{
				EventAction: pulumi.String("string"),
				Notify:      pulumi.Bool(false),
			},
			LowAction: &cognito.RiskConfigurationAccountTakeoverRiskConfigurationActionsLowActionArgs{
				EventAction: pulumi.String("string"),
				Notify:      pulumi.Bool(false),
			},
			MediumAction: &cognito.RiskConfigurationAccountTakeoverRiskConfigurationActionsMediumActionArgs{
				EventAction: pulumi.String("string"),
				Notify:      pulumi.Bool(false),
			},
		},
		NotifyConfiguration: &cognito.RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationArgs{
			SourceArn: pulumi.String("string"),
			BlockEmail: &cognito.RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationBlockEmailArgs{
				HtmlBody: pulumi.String("string"),
				Subject:  pulumi.String("string"),
				TextBody: pulumi.String("string"),
			},
			From: pulumi.String("string"),
			MfaEmail: &cognito.RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationMfaEmailArgs{
				HtmlBody: pulumi.String("string"),
				Subject:  pulumi.String("string"),
				TextBody: pulumi.String("string"),
			},
			NoActionEmail: &cognito.RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationNoActionEmailArgs{
				HtmlBody: pulumi.String("string"),
				Subject:  pulumi.String("string"),
				TextBody: pulumi.String("string"),
			},
			ReplyTo: pulumi.String("string"),
		},
	},
	ClientId: pulumi.String("string"),
	CompromisedCredentialsRiskConfiguration: &cognito.RiskConfigurationCompromisedCredentialsRiskConfigurationArgs{
		Actions: &cognito.RiskConfigurationCompromisedCredentialsRiskConfigurationActionsArgs{
			EventAction: pulumi.String("string"),
		},
		EventFilters: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	RiskExceptionConfiguration: &cognito.RiskConfigurationRiskExceptionConfigurationArgs{
		BlockedIpRangeLists: pulumi.StringArray{
			pulumi.String("string"),
		},
		SkippedIpRangeLists: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
})

    var riskConfigurationResource = new RiskConfiguration("riskConfigurationResource", RiskConfigurationArgs.builder()
    .userPoolId("string")
    .accountTakeoverRiskConfiguration(RiskConfigurationAccountTakeoverRiskConfigurationArgs.builder()
        .actions(RiskConfigurationAccountTakeoverRiskConfigurationActionsArgs.builder()
            .highAction(RiskConfigurationAccountTakeoverRiskConfigurationActionsHighActionArgs.builder()
                .eventAction("string")
                .notify(false)
                .build())
            .lowAction(RiskConfigurationAccountTakeoverRiskConfigurationActionsLowActionArgs.builder()
                .eventAction("string")
                .notify(false)
                .build())
            .mediumAction(RiskConfigurationAccountTakeoverRiskConfigurationActionsMediumActionArgs.builder()
                .eventAction("string")
                .notify(false)
                .build())
            .build())
        .notifyConfiguration(RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationArgs.builder()
            .sourceArn("string")
            .blockEmail(RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationBlockEmailArgs.builder()
                .htmlBody("string")
                .subject("string")
                .textBody("string")
                .build())
            .from("string")
            .mfaEmail(RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationMfaEmailArgs.builder()
                .htmlBody("string")
                .subject("string")
                .textBody("string")
                .build())
            .noActionEmail(RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationNoActionEmailArgs.builder()
                .htmlBody("string")
                .subject("string")
                .textBody("string")
                .build())
            .replyTo("string")
            .build())
        .build())
    .clientId("string")
    .compromisedCredentialsRiskConfiguration(RiskConfigurationCompromisedCredentialsRiskConfigurationArgs.builder()
        .actions(RiskConfigurationCompromisedCredentialsRiskConfigurationActionsArgs.builder()
            .eventAction("string")
            .build())
        .eventFilters("string")
        .build())
    .riskExceptionConfiguration(RiskConfigurationRiskExceptionConfigurationArgs.builder()
        .blockedIpRangeLists("string")
        .skippedIpRangeLists("string")
        .build())
    .build());

    risk_configuration_resource = aws.cognito.RiskConfiguration("riskConfigurationResource",
    user_pool_id="string",
    account_takeover_risk_configuration={
        "actions": {
            "high_action": {
                "event_action": "string",
                "notify": False,
            },
            "low_action": {
                "event_action": "string",
                "notify": False,
            },
            "medium_action": {
                "event_action": "string",
                "notify": False,
            },
        },
        "notify_configuration": {
            "source_arn": "string",
            "block_email": {
                "html_body": "string",
                "subject": "string",
                "text_body": "string",
            },
            "from_": "string",
            "mfa_email": {
                "html_body": "string",
                "subject": "string",
                "text_body": "string",
            },
            "no_action_email": {
                "html_body": "string",
                "subject": "string",
                "text_body": "string",
            },
            "reply_to": "string",
        },
    },
    client_id="string",
    compromised_credentials_risk_configuration={
        "actions": {
            "event_action": "string",
        },
        "event_filters": ["string"],
    },
    risk_exception_configuration={
        "blocked_ip_range_lists": ["string"],
        "skipped_ip_range_lists": ["string"],
    })

    const riskConfigurationResource = new aws.cognito.RiskConfiguration("riskConfigurationResource", {
    userPoolId: "string",
    accountTakeoverRiskConfiguration: {
        actions: {
            highAction: {
                eventAction: "string",
                notify: false,
            },
            lowAction: {
                eventAction: "string",
                notify: false,
            },
            mediumAction: {
                eventAction: "string",
                notify: false,
            },
        },
        notifyConfiguration: {
            sourceArn: "string",
            blockEmail: {
                htmlBody: "string",
                subject: "string",
                textBody: "string",
            },
            from: "string",
            mfaEmail: {
                htmlBody: "string",
                subject: "string",
                textBody: "string",
            },
            noActionEmail: {
                htmlBody: "string",
                subject: "string",
                textBody: "string",
            },
            replyTo: "string",
        },
    },
    clientId: "string",
    compromisedCredentialsRiskConfiguration: {
        actions: {
            eventAction: "string",
        },
        eventFilters: ["string"],
    },
    riskExceptionConfiguration: {
        blockedIpRangeLists: ["string"],
        skippedIpRangeLists: ["string"],
    },
});

    type: aws:cognito:RiskConfiguration
properties:
    accountTakeoverRiskConfiguration:
        actions:
            highAction:
                eventAction: string
                notify: false
            lowAction:
                eventAction: string
                notify: false
            mediumAction:
                eventAction: string
                notify: false
        notifyConfiguration:
            blockEmail:
                htmlBody: string
                subject: string
                textBody: string
            from: string
            mfaEmail:
                htmlBody: string
                subject: string
                textBody: string
            noActionEmail:
                htmlBody: string
                subject: string
                textBody: string
            replyTo: string
            sourceArn: string
    clientId: string
    compromisedCredentialsRiskConfiguration:
        actions:
            eventAction: string
        eventFilters:
            - string
    riskExceptionConfiguration:
        blockedIpRangeLists:
            - string
        skippedIpRangeLists:
            - string
    userPoolId: string

    RiskConfiguration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RiskConfiguration resource accepts the following input properties:

    UserPoolId string
    The user pool ID.
    AccountTakeoverRiskConfiguration RiskConfigurationAccountTakeoverRiskConfiguration
    The account takeover risk configuration. See details below.
    ClientId string
    The app client ID. When the client ID is not provided, the same risk configuration is applied to all the clients in the User Pool.
    CompromisedCredentialsRiskConfiguration RiskConfigurationCompromisedCredentialsRiskConfiguration
    The compromised credentials risk configuration. See details below.
    RiskExceptionConfiguration RiskConfigurationRiskExceptionConfiguration
    The configuration to override the risk decision. See details below.
    UserPoolId string
    The user pool ID.
    AccountTakeoverRiskConfiguration RiskConfigurationAccountTakeoverRiskConfigurationArgs
    The account takeover risk configuration. See details below.
    ClientId string
    The app client ID. When the client ID is not provided, the same risk configuration is applied to all the clients in the User Pool.
    CompromisedCredentialsRiskConfiguration RiskConfigurationCompromisedCredentialsRiskConfigurationArgs
    The compromised credentials risk configuration. See details below.
    RiskExceptionConfiguration RiskConfigurationRiskExceptionConfigurationArgs
    The configuration to override the risk decision. See details below.
    userPoolId String
    The user pool ID.
    accountTakeoverRiskConfiguration RiskConfigurationAccountTakeoverRiskConfiguration
    The account takeover risk configuration. See details below.
    clientId String
    The app client ID. When the client ID is not provided, the same risk configuration is applied to all the clients in the User Pool.
    compromisedCredentialsRiskConfiguration RiskConfigurationCompromisedCredentialsRiskConfiguration
    The compromised credentials risk configuration. See details below.
    riskExceptionConfiguration RiskConfigurationRiskExceptionConfiguration
    The configuration to override the risk decision. See details below.
    userPoolId string
    The user pool ID.
    accountTakeoverRiskConfiguration RiskConfigurationAccountTakeoverRiskConfiguration
    The account takeover risk configuration. See details below.
    clientId string
    The app client ID. When the client ID is not provided, the same risk configuration is applied to all the clients in the User Pool.
    compromisedCredentialsRiskConfiguration RiskConfigurationCompromisedCredentialsRiskConfiguration
    The compromised credentials risk configuration. See details below.
    riskExceptionConfiguration RiskConfigurationRiskExceptionConfiguration
    The configuration to override the risk decision. See details below.
    user_pool_id str
    The user pool ID.
    account_takeover_risk_configuration RiskConfigurationAccountTakeoverRiskConfigurationArgs
    The account takeover risk configuration. See details below.
    client_id str
    The app client ID. When the client ID is not provided, the same risk configuration is applied to all the clients in the User Pool.
    compromised_credentials_risk_configuration RiskConfigurationCompromisedCredentialsRiskConfigurationArgs
    The compromised credentials risk configuration. See details below.
    risk_exception_configuration RiskConfigurationRiskExceptionConfigurationArgs
    The configuration to override the risk decision. See details below.
    userPoolId String
    The user pool ID.
    accountTakeoverRiskConfiguration Property Map
    The account takeover risk configuration. See details below.
    clientId String
    The app client ID. When the client ID is not provided, the same risk configuration is applied to all the clients in the User Pool.
    compromisedCredentialsRiskConfiguration Property Map
    The compromised credentials risk configuration. See details below.
    riskExceptionConfiguration Property Map
    The configuration to override the risk decision. See details below.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RiskConfiguration resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing RiskConfiguration Resource

    Get an existing RiskConfiguration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RiskConfigurationState, opts?: CustomResourceOptions): RiskConfiguration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_takeover_risk_configuration: Optional[RiskConfigurationAccountTakeoverRiskConfigurationArgs] = None,
        client_id: Optional[str] = None,
        compromised_credentials_risk_configuration: Optional[RiskConfigurationCompromisedCredentialsRiskConfigurationArgs] = None,
        risk_exception_configuration: Optional[RiskConfigurationRiskExceptionConfigurationArgs] = None,
        user_pool_id: Optional[str] = None) -> RiskConfiguration
    func GetRiskConfiguration(ctx *Context, name string, id IDInput, state *RiskConfigurationState, opts ...ResourceOption) (*RiskConfiguration, error)
    public static RiskConfiguration Get(string name, Input<string> id, RiskConfigurationState? state, CustomResourceOptions? opts = null)
    public static RiskConfiguration get(String name, Output<String> id, RiskConfigurationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountTakeoverRiskConfiguration RiskConfigurationAccountTakeoverRiskConfiguration
    The account takeover risk configuration. See details below.
    ClientId string
    The app client ID. When the client ID is not provided, the same risk configuration is applied to all the clients in the User Pool.
    CompromisedCredentialsRiskConfiguration RiskConfigurationCompromisedCredentialsRiskConfiguration
    The compromised credentials risk configuration. See details below.
    RiskExceptionConfiguration RiskConfigurationRiskExceptionConfiguration
    The configuration to override the risk decision. See details below.
    UserPoolId string
    The user pool ID.
    AccountTakeoverRiskConfiguration RiskConfigurationAccountTakeoverRiskConfigurationArgs
    The account takeover risk configuration. See details below.
    ClientId string
    The app client ID. When the client ID is not provided, the same risk configuration is applied to all the clients in the User Pool.
    CompromisedCredentialsRiskConfiguration RiskConfigurationCompromisedCredentialsRiskConfigurationArgs
    The compromised credentials risk configuration. See details below.
    RiskExceptionConfiguration RiskConfigurationRiskExceptionConfigurationArgs
    The configuration to override the risk decision. See details below.
    UserPoolId string
    The user pool ID.
    accountTakeoverRiskConfiguration RiskConfigurationAccountTakeoverRiskConfiguration
    The account takeover risk configuration. See details below.
    clientId String
    The app client ID. When the client ID is not provided, the same risk configuration is applied to all the clients in the User Pool.
    compromisedCredentialsRiskConfiguration RiskConfigurationCompromisedCredentialsRiskConfiguration
    The compromised credentials risk configuration. See details below.
    riskExceptionConfiguration RiskConfigurationRiskExceptionConfiguration
    The configuration to override the risk decision. See details below.
    userPoolId String
    The user pool ID.
    accountTakeoverRiskConfiguration RiskConfigurationAccountTakeoverRiskConfiguration
    The account takeover risk configuration. See details below.
    clientId string
    The app client ID. When the client ID is not provided, the same risk configuration is applied to all the clients in the User Pool.
    compromisedCredentialsRiskConfiguration RiskConfigurationCompromisedCredentialsRiskConfiguration
    The compromised credentials risk configuration. See details below.
    riskExceptionConfiguration RiskConfigurationRiskExceptionConfiguration
    The configuration to override the risk decision. See details below.
    userPoolId string
    The user pool ID.
    account_takeover_risk_configuration RiskConfigurationAccountTakeoverRiskConfigurationArgs
    The account takeover risk configuration. See details below.
    client_id str
    The app client ID. When the client ID is not provided, the same risk configuration is applied to all the clients in the User Pool.
    compromised_credentials_risk_configuration RiskConfigurationCompromisedCredentialsRiskConfigurationArgs
    The compromised credentials risk configuration. See details below.
    risk_exception_configuration RiskConfigurationRiskExceptionConfigurationArgs
    The configuration to override the risk decision. See details below.
    user_pool_id str
    The user pool ID.
    accountTakeoverRiskConfiguration Property Map
    The account takeover risk configuration. See details below.
    clientId String
    The app client ID. When the client ID is not provided, the same risk configuration is applied to all the clients in the User Pool.
    compromisedCredentialsRiskConfiguration Property Map
    The compromised credentials risk configuration. See details below.
    riskExceptionConfiguration Property Map
    The configuration to override the risk decision. See details below.
    userPoolId String
    The user pool ID.

    Supporting Types

    RiskConfigurationAccountTakeoverRiskConfiguration, RiskConfigurationAccountTakeoverRiskConfigurationArgs

    Actions RiskConfigurationAccountTakeoverRiskConfigurationActions
    Account takeover risk configuration actions. See details below.
    NotifyConfiguration RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfiguration
    The notify configuration used to construct email notifications. See details below.
    Actions RiskConfigurationAccountTakeoverRiskConfigurationActions
    Account takeover risk configuration actions. See details below.
    NotifyConfiguration RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfiguration
    The notify configuration used to construct email notifications. See details below.
    actions RiskConfigurationAccountTakeoverRiskConfigurationActions
    Account takeover risk configuration actions. See details below.
    notifyConfiguration RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfiguration
    The notify configuration used to construct email notifications. See details below.
    actions RiskConfigurationAccountTakeoverRiskConfigurationActions
    Account takeover risk configuration actions. See details below.
    notifyConfiguration RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfiguration
    The notify configuration used to construct email notifications. See details below.
    actions RiskConfigurationAccountTakeoverRiskConfigurationActions
    Account takeover risk configuration actions. See details below.
    notify_configuration RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfiguration
    The notify configuration used to construct email notifications. See details below.
    actions Property Map
    Account takeover risk configuration actions. See details below.
    notifyConfiguration Property Map
    The notify configuration used to construct email notifications. See details below.

    RiskConfigurationAccountTakeoverRiskConfigurationActions, RiskConfigurationAccountTakeoverRiskConfigurationActionsArgs

    HighAction RiskConfigurationAccountTakeoverRiskConfigurationActionsHighAction
    Action to take for a high risk. See action block below.
    LowAction RiskConfigurationAccountTakeoverRiskConfigurationActionsLowAction
    Action to take for a low risk. See action block below.
    MediumAction RiskConfigurationAccountTakeoverRiskConfigurationActionsMediumAction
    Action to take for a medium risk. See action block below.
    HighAction RiskConfigurationAccountTakeoverRiskConfigurationActionsHighAction
    Action to take for a high risk. See action block below.
    LowAction RiskConfigurationAccountTakeoverRiskConfigurationActionsLowAction
    Action to take for a low risk. See action block below.
    MediumAction RiskConfigurationAccountTakeoverRiskConfigurationActionsMediumAction
    Action to take for a medium risk. See action block below.
    highAction RiskConfigurationAccountTakeoverRiskConfigurationActionsHighAction
    Action to take for a high risk. See action block below.
    lowAction RiskConfigurationAccountTakeoverRiskConfigurationActionsLowAction
    Action to take for a low risk. See action block below.
    mediumAction RiskConfigurationAccountTakeoverRiskConfigurationActionsMediumAction
    Action to take for a medium risk. See action block below.
    highAction RiskConfigurationAccountTakeoverRiskConfigurationActionsHighAction
    Action to take for a high risk. See action block below.
    lowAction RiskConfigurationAccountTakeoverRiskConfigurationActionsLowAction
    Action to take for a low risk. See action block below.
    mediumAction RiskConfigurationAccountTakeoverRiskConfigurationActionsMediumAction
    Action to take for a medium risk. See action block below.
    high_action RiskConfigurationAccountTakeoverRiskConfigurationActionsHighAction
    Action to take for a high risk. See action block below.
    low_action RiskConfigurationAccountTakeoverRiskConfigurationActionsLowAction
    Action to take for a low risk. See action block below.
    medium_action RiskConfigurationAccountTakeoverRiskConfigurationActionsMediumAction
    Action to take for a medium risk. See action block below.
    highAction Property Map
    Action to take for a high risk. See action block below.
    lowAction Property Map
    Action to take for a low risk. See action block below.
    mediumAction Property Map
    Action to take for a medium risk. See action block below.

    RiskConfigurationAccountTakeoverRiskConfigurationActionsHighAction, RiskConfigurationAccountTakeoverRiskConfigurationActionsHighActionArgs

    EventAction string
    Notify bool
    Whether to send a notification.
    EventAction string
    Notify bool
    Whether to send a notification.
    eventAction String
    notify_ Boolean
    Whether to send a notification.
    eventAction string
    notify boolean
    Whether to send a notification.
    event_action str
    notify bool
    Whether to send a notification.
    eventAction String
    notify Boolean
    Whether to send a notification.

    RiskConfigurationAccountTakeoverRiskConfigurationActionsLowAction, RiskConfigurationAccountTakeoverRiskConfigurationActionsLowActionArgs

    EventAction string
    Notify bool
    Whether to send a notification.
    EventAction string
    Notify bool
    Whether to send a notification.
    eventAction String
    notify_ Boolean
    Whether to send a notification.
    eventAction string
    notify boolean
    Whether to send a notification.
    event_action str
    notify bool
    Whether to send a notification.
    eventAction String
    notify Boolean
    Whether to send a notification.

    RiskConfigurationAccountTakeoverRiskConfigurationActionsMediumAction, RiskConfigurationAccountTakeoverRiskConfigurationActionsMediumActionArgs

    EventAction string
    Notify bool
    Whether to send a notification.
    EventAction string
    Notify bool
    Whether to send a notification.
    eventAction String
    notify_ Boolean
    Whether to send a notification.
    eventAction string
    notify boolean
    Whether to send a notification.
    event_action str
    notify bool
    Whether to send a notification.
    eventAction String
    notify Boolean
    Whether to send a notification.

    RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfiguration, RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationArgs

    SourceArn string
    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.
    BlockEmail RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationBlockEmail
    Email template used when a detected risk event is blocked. See notify email type below.
    From string
    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.
    MfaEmail RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationMfaEmail
    The multi-factor authentication (MFA) email template used when MFA is challenged as part of a detected risk. See notify email type below.
    NoActionEmail RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationNoActionEmail
    The email template used when a detected risk event is allowed. See notify email type below.
    ReplyTo string
    The destination to which the receiver of an email should reply to.
    SourceArn string
    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.
    BlockEmail RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationBlockEmail
    Email template used when a detected risk event is blocked. See notify email type below.
    From string
    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.
    MfaEmail RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationMfaEmail
    The multi-factor authentication (MFA) email template used when MFA is challenged as part of a detected risk. See notify email type below.
    NoActionEmail RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationNoActionEmail
    The email template used when a detected risk event is allowed. See notify email type below.
    ReplyTo string
    The destination to which the receiver of an email should reply to.
    sourceArn String
    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.
    blockEmail RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationBlockEmail
    Email template used when a detected risk event is blocked. See notify email type below.
    from String
    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.
    mfaEmail RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationMfaEmail
    The multi-factor authentication (MFA) email template used when MFA is challenged as part of a detected risk. See notify email type below.
    noActionEmail RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationNoActionEmail
    The email template used when a detected risk event is allowed. See notify email type below.
    replyTo String
    The destination to which the receiver of an email should reply to.
    sourceArn string
    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.
    blockEmail RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationBlockEmail
    Email template used when a detected risk event is blocked. See notify email type below.
    from string
    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.
    mfaEmail RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationMfaEmail
    The multi-factor authentication (MFA) email template used when MFA is challenged as part of a detected risk. See notify email type below.
    noActionEmail RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationNoActionEmail
    The email template used when a detected risk event is allowed. See notify email type below.
    replyTo string
    The destination to which the receiver of an email should reply to.
    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 RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationBlockEmail
    Email template used when a detected risk event is blocked. See notify email type below.
    from_ str
    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 RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationMfaEmail
    The multi-factor authentication (MFA) email template used when MFA is challenged as part of a detected risk. See notify email type below.
    no_action_email RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationNoActionEmail
    The email template used when a detected risk event is allowed. See notify email type below.
    reply_to str
    The destination to which the receiver of an email should reply to.
    sourceArn String
    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.
    blockEmail Property Map
    Email template used when a detected risk event is blocked. See notify email type below.
    from String
    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.
    mfaEmail Property Map
    The multi-factor authentication (MFA) email template used when MFA is challenged as part of a detected risk. See notify email type below.
    noActionEmail Property Map
    The email template used when a detected risk event is allowed. See notify email type below.
    replyTo String
    The destination to which the receiver of an email should reply to.

    RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationBlockEmail, RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationBlockEmailArgs

    HtmlBody string
    The email HTML body.
    Subject string
    The email subject.
    TextBody string
    The email text body.
    HtmlBody string
    The email HTML body.
    Subject string
    The email subject.
    TextBody string
    The email text body.
    htmlBody String
    The email HTML body.
    subject String
    The email subject.
    textBody String
    The email text body.
    htmlBody string
    The email HTML body.
    subject string
    The email subject.
    textBody string
    The email text body.
    html_body str
    The email HTML body.
    subject str
    The email subject.
    text_body str
    The email text body.
    htmlBody String
    The email HTML body.
    subject String
    The email subject.
    textBody String
    The email text body.

    RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationMfaEmail, RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationMfaEmailArgs

    HtmlBody string
    The email HTML body.
    Subject string
    The email subject.
    TextBody string
    The email text body.
    HtmlBody string
    The email HTML body.
    Subject string
    The email subject.
    TextBody string
    The email text body.
    htmlBody String
    The email HTML body.
    subject String
    The email subject.
    textBody String
    The email text body.
    htmlBody string
    The email HTML body.
    subject string
    The email subject.
    textBody string
    The email text body.
    html_body str
    The email HTML body.
    subject str
    The email subject.
    text_body str
    The email text body.
    htmlBody String
    The email HTML body.
    subject String
    The email subject.
    textBody String
    The email text body.

    RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationNoActionEmail, RiskConfigurationAccountTakeoverRiskConfigurationNotifyConfigurationNoActionEmailArgs

    HtmlBody string
    The email HTML body.
    Subject string
    The email subject.
    TextBody string
    The email text body.
    HtmlBody string
    The email HTML body.
    Subject string
    The email subject.
    TextBody string
    The email text body.
    htmlBody String
    The email HTML body.
    subject String
    The email subject.
    textBody String
    The email text body.
    htmlBody string
    The email HTML body.
    subject string
    The email subject.
    textBody string
    The email text body.
    html_body str
    The email HTML body.
    subject str
    The email subject.
    text_body str
    The email text body.
    htmlBody String
    The email HTML body.
    subject String
    The email subject.
    textBody String
    The email text body.

    RiskConfigurationCompromisedCredentialsRiskConfiguration, RiskConfigurationCompromisedCredentialsRiskConfigurationArgs

    Actions RiskConfigurationCompromisedCredentialsRiskConfigurationActions
    The compromised credentials risk configuration actions. See details below.
    EventFilters List<string>
    Perform the action for these events. The default is to perform all events if no event filter is specified. Valid values are SIGN_IN, PASSWORD_CHANGE, and SIGN_UP.
    Actions RiskConfigurationCompromisedCredentialsRiskConfigurationActions
    The compromised credentials risk configuration actions. See details below.
    EventFilters []string
    Perform the action for these events. The default is to perform all events if no event filter is specified. Valid values are SIGN_IN, PASSWORD_CHANGE, and SIGN_UP.
    actions RiskConfigurationCompromisedCredentialsRiskConfigurationActions
    The compromised credentials risk configuration actions. See details below.
    eventFilters List<String>
    Perform the action for these events. The default is to perform all events if no event filter is specified. Valid values are SIGN_IN, PASSWORD_CHANGE, and SIGN_UP.
    actions RiskConfigurationCompromisedCredentialsRiskConfigurationActions
    The compromised credentials risk configuration actions. See details below.
    eventFilters string[]
    Perform the action for these events. The default is to perform all events if no event filter is specified. Valid values are SIGN_IN, PASSWORD_CHANGE, and SIGN_UP.
    actions RiskConfigurationCompromisedCredentialsRiskConfigurationActions
    The compromised credentials risk configuration actions. See details below.
    event_filters Sequence[str]
    Perform the action for these events. The default is to perform all events if no event filter is specified. Valid values are SIGN_IN, PASSWORD_CHANGE, and SIGN_UP.
    actions Property Map
    The compromised credentials risk configuration actions. See details below.
    eventFilters List<String>
    Perform the action for these events. The default is to perform all events if no event filter is specified. Valid values are SIGN_IN, PASSWORD_CHANGE, and SIGN_UP.

    RiskConfigurationCompromisedCredentialsRiskConfigurationActions, RiskConfigurationCompromisedCredentialsRiskConfigurationActionsArgs

    EventAction string
    The event action. Valid values are BLOCK or NO_ACTION.
    EventAction string
    The event action. Valid values are BLOCK or NO_ACTION.
    eventAction String
    The event action. Valid values are BLOCK or NO_ACTION.
    eventAction string
    The event action. Valid values are BLOCK or NO_ACTION.
    event_action str
    The event action. Valid values are BLOCK or NO_ACTION.
    eventAction String
    The event action. Valid values are BLOCK or NO_ACTION.

    RiskConfigurationRiskExceptionConfiguration, RiskConfigurationRiskExceptionConfigurationArgs

    BlockedIpRangeLists List<string>
    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. Can contain a maximum of 200 items.
    SkippedIpRangeLists List<string>
    Risk detection isn't performed on the IP addresses in this range list. The IP range is in CIDR notation. Can contain a maximum of 200 items.
    BlockedIpRangeLists []string
    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. Can contain a maximum of 200 items.
    SkippedIpRangeLists []string
    Risk detection isn't performed on the IP addresses in this range list. The IP range is in CIDR notation. Can contain a maximum of 200 items.
    blockedIpRangeLists List<String>
    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. Can contain a maximum of 200 items.
    skippedIpRangeLists List<String>
    Risk detection isn't performed on the IP addresses in this range list. The IP range is in CIDR notation. Can contain a maximum of 200 items.
    blockedIpRangeLists string[]
    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. Can contain a maximum of 200 items.
    skippedIpRangeLists string[]
    Risk detection isn't performed on the IP addresses in this range list. The IP range is in CIDR notation. Can contain a maximum of 200 items.
    blocked_ip_range_lists 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. Can contain a maximum of 200 items.
    skipped_ip_range_lists Sequence[str]
    Risk detection isn't performed on the IP addresses in this range list. The IP range is in CIDR notation. Can contain a maximum of 200 items.
    blockedIpRangeLists List<String>
    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. Can contain a maximum of 200 items.
    skippedIpRangeLists List<String>
    Risk detection isn't performed on the IP addresses in this range list. The IP range is in CIDR notation. Can contain a maximum of 200 items.

    Import

    Import using the user pool ID and Client ID separated by a ::

    Using pulumi import to import Cognito Risk Configurations using the user pool ID or the user pool ID and Client Id separated by a :. For example:

    Import using the user pool ID:

    $ pulumi import aws:cognito/riskConfiguration:RiskConfiguration main example

    Import using the user pool ID and Client ID separated by a ::

    $ pulumi import aws:cognito/riskConfiguration:RiskConfiguration main example:example

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws