RiskConfiguration class

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", {
    riskExceptionConfiguration: {
        blockedIpRangeLists: ["10.10.10.10/32"],
    },
    userPoolId: exampleAwsCognitoUserPool.id,
});
import pulumi
import pulumi_aws as aws

example = aws.cognito.RiskConfiguration("example",
    risk_exception_configuration={
        "blocked_ip_range_lists": ["10.10.10.10/32"],
    },
    user_pool_id=example_aws_cognito_user_pool["id"])
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()
    {
        RiskExceptionConfiguration = new Aws.Cognito.Inputs.RiskConfigurationRiskExceptionConfigurationArgs
        {
            BlockedIpRangeLists = new[]
            {
                "10.10.10.10/32",
            },
        },
        UserPoolId = exampleAwsCognitoUserPool.Id,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			RiskExceptionConfiguration: &cognito.RiskConfigurationRiskExceptionConfigurationArgs{
				BlockedIpRangeLists: pulumi.StringArray{
					pulumi.String("10.10.10.10/32"),
				},
			},
			UserPoolId: pulumi.Any(exampleAwsCognitoUserPool.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_cognito_riskconfiguration" "example" {
  risk_exception_configuration = {
    blocked_ip_range_lists = ["10.10.10.10/32"]
  }
  user_pool_id = exampleAwsCognitoUserPool.id
}
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.ArrayList;
import java.util.Arrays;
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()
            .riskExceptionConfiguration(RiskConfigurationRiskExceptionConfigurationArgs.builder()
                .blockedIpRangeLists("10.10.10.10/32")
                .build())
            .userPoolId(exampleAwsCognitoUserPool.id())
            .build());

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

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

Constructors

RiskConfiguration(String name, {RiskConfigurationArgs? args, CustomResourceOptions? options})
Creates a new RiskConfiguration. name The Pulumi resource name. args Arguments used to configure this RiskConfiguration. The set of arguments for RiskConfiguration. options Resource options controlling this resource's behavior.
RiskConfiguration.reference(String urn)
Creates a typed reference to an existing RiskConfiguration resource.

Properties

accountTakeoverRiskConfiguration ↔ Output<RiskConfigurationAccountTakeoverRiskConfiguration?>
The account takeover risk configuration. See details below.
latefinal
childResources → Set<Resource>
finalinherited
clientId ↔ Output<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.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
compromisedCredentialsRiskConfiguration ↔ Output<RiskConfigurationCompromisedCredentialsRiskConfiguration?>
The compromised credentials risk configuration. See details below.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
riskExceptionConfiguration ↔ Output<RiskConfigurationRiskExceptionConfiguration?>
The configuration to override the risk decision. See details below.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
userPoolId ↔ Output<String>
The user pool ID.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {RiskConfigurationState? state, CustomResourceOptions? options}) → RiskConfiguration
Gets an existing RiskConfiguration resource's state with the given name and id.