Class: AWSCDK::Cognito::CfnUserPoolRiskConfigurationAttachmentProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cognito/cfn_user_pool_risk_configuration_attachment_props.rb

Overview

Properties for defining a CfnUserPoolRiskConfigurationAttachment.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client_id:, user_pool_id:, account_takeover_risk_configuration: nil, compromised_credentials_risk_configuration: nil, risk_exception_configuration: nil) ⇒ CfnUserPoolRiskConfigurationAttachmentProps

Returns a new instance of CfnUserPoolRiskConfigurationAttachmentProps.

Parameters:



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'cognito/cfn_user_pool_risk_configuration_attachment_props.rb', line 14

def initialize(client_id:, user_pool_id:, account_takeover_risk_configuration: nil, compromised_credentials_risk_configuration: nil, risk_exception_configuration: nil)
  @client_id = client_id
  Jsii::Type.check_type(@client_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientId")
  @user_pool_id = user_pool_id
  Jsii::Type.check_type(@user_pool_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jb2duaXRvLklVc2VyUG9vbFJlZiJ9XX19")), "userPoolId")
  @account_takeover_risk_configuration = .is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPoolRiskConfigurationAttachment::AccountTakeoverRiskConfigurationTypeProperty.new(**.transform_keys(&:to_sym)) : 
  Jsii::Type.check_type(@account_takeover_risk_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sUmlza0NvbmZpZ3VyYXRpb25BdHRhY2htZW50LkFjY291bnRUYWtlb3ZlclJpc2tDb25maWd1cmF0aW9uVHlwZVByb3BlcnR5In1dfX0=")), "accountTakeoverRiskConfiguration") unless @account_takeover_risk_configuration.nil?
  @compromised_credentials_risk_configuration = compromised_credentials_risk_configuration.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPoolRiskConfigurationAttachment::CompromisedCredentialsRiskConfigurationTypeProperty.new(**compromised_credentials_risk_configuration.transform_keys(&:to_sym)) : compromised_credentials_risk_configuration
  Jsii::Type.check_type(@compromised_credentials_risk_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sUmlza0NvbmZpZ3VyYXRpb25BdHRhY2htZW50LkNvbXByb21pc2VkQ3JlZGVudGlhbHNSaXNrQ29uZmlndXJhdGlvblR5cGVQcm9wZXJ0eSJ9XX19")), "compromisedCredentialsRiskConfiguration") unless @compromised_credentials_risk_configuration.nil?
  @risk_exception_configuration = risk_exception_configuration.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPoolRiskConfigurationAttachment::RiskExceptionConfigurationTypeProperty.new(**risk_exception_configuration.transform_keys(&:to_sym)) : risk_exception_configuration
  Jsii::Type.check_type(@risk_exception_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sUmlza0NvbmZpZ3VyYXRpb25BdHRhY2htZW50LlJpc2tFeGNlcHRpb25Db25maWd1cmF0aW9uVHlwZVByb3BlcnR5In1dfX0=")), "riskExceptionConfiguration") unless @risk_exception_configuration.nil?
end

Instance Attribute Details

#account_takeover_risk_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The settings for automated responses and notification templates for adaptive authentication with threat protection.

Returns:

See Also:



43
44
45
 
# File 'cognito/cfn_user_pool_risk_configuration_attachment_props.rb', line 43

def 
  @account_takeover_risk_configuration
end

#client_id ⇒ String (readonly)

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.

Returns:

  • (String)

See Also:



33
34
35
 
# File 'cognito/cfn_user_pool_risk_configuration_attachment_props.rb', line 33

def client_id
  @client_id
end

#compromised_credentials_risk_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Settings for compromised-credentials actions and authentication types with threat protection in full-function ENFORCED mode.

Returns:

See Also:



48
49
50
 
# File 'cognito/cfn_user_pool_risk_configuration_attachment_props.rb', line 48

def compromised_credentials_risk_configuration
  @compromised_credentials_risk_configuration
end

#risk_exception_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



53
54
55
 
# File 'cognito/cfn_user_pool_risk_configuration_attachment_props.rb', line 53

def risk_exception_configuration
  @risk_exception_configuration
end

#user_pool_id ⇒ String, AWSCDK::Interfaces::AWSCognito::IUserPoolRef (readonly)

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

Returns:

See Also:



38
39
40
 
# File 'cognito/cfn_user_pool_risk_configuration_attachment_props.rb', line 38

def user_pool_id
  @user_pool_id
end

Class Method Details

.jsii_properties ⇒ Object 



55
56
57
58
59
60
61
62
63
 
# File 'cognito/cfn_user_pool_risk_configuration_attachment_props.rb', line 55

def self.jsii_properties
  {
    :client_id => "clientId",
    :user_pool_id => "userPoolId",
    :account_takeover_risk_configuration => "accountTakeoverRiskConfiguration",
    :compromised_credentials_risk_configuration => "compromisedCredentialsRiskConfiguration",
    :risk_exception_configuration => "riskExceptionConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
 
# File 'cognito/cfn_user_pool_risk_configuration_attachment_props.rb', line 65

def to_jsii
  result = {}
  result.merge!({
    "clientId" => @client_id,
    "userPoolId" => @user_pool_id,
    "accountTakeoverRiskConfiguration" => @account_takeover_risk_configuration,
    "compromisedCredentialsRiskConfiguration" => @compromised_credentials_risk_configuration,
    "riskExceptionConfiguration" => @risk_exception_configuration,
  })
  result.compact
end