Package software.amazon.awscdk.services.cognito

Class CfnUserPoolRiskConfigurationAttachment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.cognito.CfnUserPoolRiskConfigurationAttachment
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.966Z") @Stability(Stable) public class CfnUserPoolRiskConfigurationAttachment extends CfnResource implements IInspectable
A CloudFormation AWS::Cognito::UserPoolRiskConfigurationAttachment.

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

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

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 CfnUserPoolRiskConfigurationAttachment cfnUserPoolRiskConfigurationAttachment = CfnUserPoolRiskConfigurationAttachment.Builder.create(this, "MyCfnUserPoolRiskConfigurationAttachment")
         .clientId("clientId")
         .userPoolId("userPoolId")
         // the properties below are optional
         .accountTakeoverRiskConfiguration(AccountTakeoverRiskConfigurationTypeProperty.builder()
                 .actions(AccountTakeoverActionsTypeProperty.builder()
                         .highAction(AccountTakeoverActionTypeProperty.builder()
                                 .eventAction("eventAction")
                                 .notify(false)
                                 .build())
                         .lowAction(AccountTakeoverActionTypeProperty.builder()
                                 .eventAction("eventAction")
                                 .notify(false)
                                 .build())
                         .mediumAction(AccountTakeoverActionTypeProperty.builder()
                                 .eventAction("eventAction")
                                 .notify(false)
                                 .build())
                         .build())
                 // the properties below are optional
                 .notifyConfiguration(NotifyConfigurationTypeProperty.builder()
                         .sourceArn("sourceArn")
                         // the properties below are optional
                         .blockEmail(NotifyEmailTypeProperty.builder()
                                 .subject("subject")
                                 // the properties below are optional
                                 .htmlBody("htmlBody")
                                 .textBody("textBody")
                                 .build())
                         .from("from")
                         .mfaEmail(NotifyEmailTypeProperty.builder()
                                 .subject("subject")
                                 // the properties below are optional
                                 .htmlBody("htmlBody")
                                 .textBody("textBody")
                                 .build())
                         .noActionEmail(NotifyEmailTypeProperty.builder()
                                 .subject("subject")
                                 // the properties below are optional
                                 .htmlBody("htmlBody")
                                 .textBody("textBody")
                                 .build())
                         .replyTo("replyTo")
                         .build())
                 .build())
         .compromisedCredentialsRiskConfiguration(CompromisedCredentialsRiskConfigurationTypeProperty.builder()
                 .actions(CompromisedCredentialsActionsTypeProperty.builder()
                         .eventAction("eventAction")
                         .build())
                 // the properties below are optional
                 .eventFilter(List.of("eventFilter"))
                 .build())
         .riskExceptionConfiguration(RiskExceptionConfigurationTypeProperty.builder()
                 .blockedIpRangeList(List.of("blockedIpRangeList"))
                 .skippedIpRangeList(List.of("skippedIpRangeList"))
                 .build())
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnUserPoolRiskConfigurationAttachment

      protected CfnUserPoolRiskConfigurationAttachment(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnUserPoolRiskConfigurationAttachment

      protected CfnUserPoolRiskConfigurationAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnUserPoolRiskConfigurationAttachment

      @Stability(Stable) public CfnUserPoolRiskConfigurationAttachment(@NotNull Construct scope, @NotNull String id, @NotNull CfnUserPoolRiskConfigurationAttachmentProps props)
      Create a new AWS::Cognito::UserPoolRiskConfigurationAttachment.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getClientId

      @Stability(Stable) @NotNull public String getClientId()
      The app client ID.

      You can specify the risk configuration for a single client (with a specific ClientId) or for all clients (by setting the ClientId to ALL ).

    • setClientId

      @Stability(Stable) public void setClientId(@NotNull String value)
      The app client ID.

      You can specify the risk configuration for a single client (with a specific ClientId) or for all clients (by setting the ClientId to ALL ).

    • getUserPoolId

      @Stability(Stable) @NotNull public String getUserPoolId()
      The user pool ID.

    • setUserPoolId

      @Stability(Stable) public void setUserPoolId(@NotNull String value)
      The user pool ID.

    • getAccountTakeoverRiskConfiguration

      @Stability(Stable) @Nullable public Object getAccountTakeoverRiskConfiguration()
      The account takeover risk configuration object, including the NotifyConfiguration object and Actions to take if there is an account takeover.

    • setAccountTakeoverRiskConfiguration

      @Stability(Stable) public void setAccountTakeoverRiskConfiguration(@Nullable IResolvable value)
      The account takeover risk configuration object, including the NotifyConfiguration object and Actions to take if there is an account takeover.

    • setAccountTakeoverRiskConfiguration

      @Stability(Stable) public void setAccountTakeoverRiskConfiguration(@Nullable CfnUserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationTypeProperty value)
      The account takeover risk configuration object, including the NotifyConfiguration object and Actions to take if there is an account takeover.

    • getCompromisedCredentialsRiskConfiguration

      @Stability(Stable) @Nullable public Object getCompromisedCredentialsRiskConfiguration()
      The compromised credentials risk configuration object, including the EventFilter and the EventAction .

    • setCompromisedCredentialsRiskConfiguration

      @Stability(Stable) public void setCompromisedCredentialsRiskConfiguration(@Nullable IResolvable value)
      The compromised credentials risk configuration object, including the EventFilter and the EventAction .

    • setCompromisedCredentialsRiskConfiguration

      @Stability(Stable) public void setCompromisedCredentialsRiskConfiguration(@Nullable CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypeProperty value)
      The compromised credentials risk configuration object, including the EventFilter and the EventAction .

    • getRiskExceptionConfiguration

      @Stability(Stable) @Nullable public Object getRiskExceptionConfiguration()
      The configuration to override the risk decision.

    • setRiskExceptionConfiguration

      @Stability(Stable) public void setRiskExceptionConfiguration(@Nullable IResolvable value)
      The configuration to override the risk decision.

    • setRiskExceptionConfiguration

      @Stability(Stable) public void setRiskExceptionConfiguration(@Nullable CfnUserPoolRiskConfigurationAttachment.RiskExceptionConfigurationTypeProperty value)
      The configuration to override the risk decision.