Class: AWSCDK::Cognito::CfnUserPoolDomainProps

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

Overview

Properties for defining a CfnUserPoolDomain.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(domain:, user_pool_id:, custom_domain_config: nil, managed_login_version: nil, routing: nil) ⇒ CfnUserPoolDomainProps

Returns a new instance of CfnUserPoolDomainProps.

Parameters:



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

def initialize(domain:, user_pool_id:, custom_domain_config: nil, managed_login_version: nil, routing: nil)
  @domain = domain
  Jsii::Type.check_type(@domain, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domain")
  @user_pool_id = user_pool_id
  Jsii::Type.check_type(@user_pool_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userPoolId")
  @custom_domain_config = custom_domain_config.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPoolDomain::CustomDomainConfigTypeProperty.new(**custom_domain_config.transform_keys(&:to_sym)) : custom_domain_config
  Jsii::Type.check_type(@custom_domain_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sRG9tYWluLkN1c3RvbURvbWFpbkNvbmZpZ1R5cGVQcm9wZXJ0eSJ9XX19")), "customDomainConfig") unless @custom_domain_config.nil?
  @managed_login_version = 
  Jsii::Type.check_type(@managed_login_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "managedLoginVersion") unless @managed_login_version.nil?
  @routing = routing.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPoolDomain::RoutingTypeProperty.new(**routing.transform_keys(&:to_sym)) : routing
  Jsii::Type.check_type(@routing, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sRG9tYWluLlJvdXRpbmdUeXBlUHJvcGVydHkifV19fQ==")), "routing") unless @routing.nil?
end

Instance Attribute Details

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

The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.

Use this object to specify an SSL certificate that is managed by ACM.

When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.

Returns:

See Also:



47
48
49
 
# File 'cognito/cfn_user_pool_domain_props.rb', line 47

def custom_domain_config
  @custom_domain_config
end

#domain ⇒ String (readonly)

The name of the domain that you want to update.

For custom domains, this is the fully-qualified domain name, for example auth.example.com . For prefix domains, this is the prefix alone, such as myprefix .

Returns:

  • (String)

See Also:



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

def domain
  @domain
end

#managed_login_version ⇒ Numeric? (readonly)

A version number that indicates the state of managed login for your domain.

Version 1 is hosted UI (classic). Version 2 is the newer managed login with the branding editor. For more information, see Managed login .

Returns:

  • (Numeric, nil)

See Also:



54
55
56
 
# File 'cognito/cfn_user_pool_domain_props.rb', line 54

def 
  @managed_login_version
end

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

Returns:

See Also:



57
58
59
 
# File 'cognito/cfn_user_pool_domain_props.rb', line 57

def routing
  @routing
end

#user_pool_id ⇒ String (readonly)

The ID of the user pool that is associated with the domain you're updating.

Returns:

  • (String)

See Also:



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

def user_pool_id
  @user_pool_id
end

Class Method Details

.jsii_properties ⇒ Object 



59
60
61
62
63
64
65
66
67
 
# File 'cognito/cfn_user_pool_domain_props.rb', line 59

def self.jsii_properties
  {
    :domain => "domain",
    :user_pool_id => "userPoolId",
    :custom_domain_config => "customDomainConfig",
    :managed_login_version => "managedLoginVersion",
    :routing => "routing",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
 
# File 'cognito/cfn_user_pool_domain_props.rb', line 69

def to_jsii
  result = {}
  result.merge!({
    "domain" => @domain,
    "userPoolId" => @user_pool_id,
    "customDomainConfig" => @custom_domain_config,
    "managedLoginVersion" => @managed_login_version,
    "routing" => @routing,
  })
  result.compact
end