aws-native.cognito.UserPoolRiskConfigurationAttachment

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

Create UserPoolRiskConfigurationAttachment Resource

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

Constructor syntax

new UserPoolRiskConfigurationAttachment(name: string, args: UserPoolRiskConfigurationAttachmentArgs, opts?: CustomResourceOptions);

@overload
def UserPoolRiskConfigurationAttachment(resource_name: str,
                                        args: UserPoolRiskConfigurationAttachmentArgs,
                                        opts: Optional[ResourceOptions] = None)

@overload
def UserPoolRiskConfigurationAttachment(resource_name: str,
                                        opts: Optional[ResourceOptions] = None,
                                        client_id: Optional[str] = None,
                                        user_pool_id: Optional[str] = None,
                                        account_takeover_risk_configuration: Optional[UserPoolRiskConfigurationAttachmentAccountTakeoverRiskConfigurationTypeArgs] = None,
                                        compromised_credentials_risk_configuration: Optional[UserPoolRiskConfigurationAttachmentCompromisedCredentialsRiskConfigurationTypeArgs] = None,
                                        risk_exception_configuration: Optional[UserPoolRiskConfigurationAttachmentRiskExceptionConfigurationTypeArgs] = None)

func NewUserPoolRiskConfigurationAttachment(ctx *Context, name string, args UserPoolRiskConfigurationAttachmentArgs, opts ...ResourceOption) (*UserPoolRiskConfigurationAttachment, error)

public UserPoolRiskConfigurationAttachment(string name, UserPoolRiskConfigurationAttachmentArgs args, CustomResourceOptions? opts = null)

public UserPoolRiskConfigurationAttachment(String name, UserPoolRiskConfigurationAttachmentArgs args)
public UserPoolRiskConfigurationAttachment(String name, UserPoolRiskConfigurationAttachmentArgs args, CustomResourceOptions options)

type: aws-native:cognito:UserPoolRiskConfigurationAttachment
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 UserPoolRiskConfigurationAttachmentArgs: 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 UserPoolRiskConfigurationAttachmentArgs: 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 UserPoolRiskConfigurationAttachmentArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args UserPoolRiskConfigurationAttachmentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args UserPoolRiskConfigurationAttachmentArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

UserPoolRiskConfigurationAttachment 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 UserPoolRiskConfigurationAttachment resource accepts the following input properties:

ClientId string: 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.
UserPoolId string: The ID of the user pool that has the risk configuration applied.
AccountTakeoverRiskConfiguration Pulumi.AwsNative.Cognito.Inputs.UserPoolRiskConfigurationAttachmentAccountTakeoverRiskConfigurationType: The settings for automated responses and notification templates for adaptive authentication with advanced security features.
CompromisedCredentialsRiskConfiguration Pulumi.AwsNative.Cognito.Inputs.UserPoolRiskConfigurationAttachmentCompromisedCredentialsRiskConfigurationType: Settings for compromised-credentials actions and authentication types with advanced security features in full-function ENFORCED mode.
RiskExceptionConfiguration Pulumi.AwsNative.Cognito.Inputs.UserPoolRiskConfigurationAttachmentRiskExceptionConfigurationType: Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.

ClientId string: 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.
UserPoolId string: The ID of the user pool that has the risk configuration applied.
AccountTakeoverRiskConfiguration UserPoolRiskConfigurationAttachmentAccountTakeoverRiskConfigurationTypeArgs: The settings for automated responses and notification templates for adaptive authentication with advanced security features.
CompromisedCredentialsRiskConfiguration UserPoolRiskConfigurationAttachmentCompromisedCredentialsRiskConfigurationTypeArgs: Settings for compromised-credentials actions and authentication types with advanced security features in full-function ENFORCED mode.
RiskExceptionConfiguration UserPoolRiskConfigurationAttachmentRiskExceptionConfigurationTypeArgs: Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.

clientId String: 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.
userPoolId String: The ID of the user pool that has the risk configuration applied.
accountTakeoverRiskConfiguration UserPoolRiskConfigurationAttachmentAccountTakeoverRiskConfigurationType: The settings for automated responses and notification templates for adaptive authentication with advanced security features.
compromisedCredentialsRiskConfiguration UserPoolRiskConfigurationAttachmentCompromisedCredentialsRiskConfigurationType: Settings for compromised-credentials actions and authentication types with advanced security features in full-function ENFORCED mode.
riskExceptionConfiguration UserPoolRiskConfigurationAttachmentRiskExceptionConfigurationType: Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.

clientId string: 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.
userPoolId string: The ID of the user pool that has the risk configuration applied.
accountTakeoverRiskConfiguration UserPoolRiskConfigurationAttachmentAccountTakeoverRiskConfigurationType: The settings for automated responses and notification templates for adaptive authentication with advanced security features.
compromisedCredentialsRiskConfiguration UserPoolRiskConfigurationAttachmentCompromisedCredentialsRiskConfigurationType: Settings for compromised-credentials actions and authentication types with advanced security features in full-function ENFORCED mode.
riskExceptionConfiguration UserPoolRiskConfigurationAttachmentRiskExceptionConfigurationType: Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.

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 UserPoolRiskConfigurationAttachmentAccountTakeoverRiskConfigurationTypeArgs: The settings for automated responses and notification templates for adaptive authentication with advanced security features.
compromised_credentials_risk_configuration UserPoolRiskConfigurationAttachmentCompromisedCredentialsRiskConfigurationTypeArgs: Settings for compromised-credentials actions and authentication types with advanced security features in full-function ENFORCED mode.
risk_exception_configuration UserPoolRiskConfigurationAttachmentRiskExceptionConfigurationTypeArgs: Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.

clientId String: 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.
userPoolId String: The ID of the user pool that has the risk configuration applied.
accountTakeoverRiskConfiguration Property Map: The settings for automated responses and notification templates for adaptive authentication with advanced security features.
compromisedCredentialsRiskConfiguration Property Map: Settings for compromised-credentials actions and authentication types with advanced security features in full-function ENFORCED mode.
riskExceptionConfiguration Property Map: Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.

Outputs

All input properties are implicitly available as output properties. Additionally, the UserPoolRiskConfigurationAttachment 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.

Supporting Types

UserPoolRiskConfigurationAttachmentAccountTakeoverActionType, UserPoolRiskConfigurationAttachmentAccountTakeoverActionTypeArgs

EventAction string

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 bool