Class: AWSCDK::Cognito::CfnUserPoolUICustomizationAttachmentProps

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

Overview

Properties for defining a CfnUserPoolUICustomizationAttachment.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client_id:, user_pool_id:, css: nil) ⇒ CfnUserPoolUICustomizationAttachmentProps

Returns a new instance of CfnUserPoolUICustomizationAttachmentProps.

Parameters:

  • client_id (String) —

    The app client ID for your UI customization.

  • user_pool_id (String, AWSCDK::Interfaces::AWSCognito::IUserPoolRef) —

    The ID of the user pool where you want to apply branding to the classic hosted UI.

  • css (String, nil) (defaults to: nil) —

    A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client.



12
13
14
15
16
17
18
19
 
# File 'cognito/cfn_user_pool_ui_customization_attachment_props.rb', line 12

def initialize(client_id:, user_pool_id:, css: 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")
  @css = css
  Jsii::Type.check_type(@css, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "css") unless @css.nil?
end

Instance Attribute Details

#client_id ⇒ String (readonly)

The app client ID for your UI customization.

When this value isn't present, the customization applies to all user pool app clients that don't have client-level settings..

Returns:

  • (String)

See Also:



27
28
29
 
# File 'cognito/cfn_user_pool_ui_customization_attachment_props.rb', line 27

def client_id
  @client_id
end

#css ⇒ String? (readonly)

A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client.

To download a template, go to the Amazon Cognito console. Navigate to your user pool App clients tab, select Login pages , edit Hosted UI (classic) style , and select the link to CSS template.css .

Returns:

  • (String, nil)

See Also:



39
40
41
 
# File 'cognito/cfn_user_pool_ui_customization_attachment_props.rb', line 39

def css
  @css
end

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

The ID of the user pool where you want to apply branding to the classic hosted UI.

Returns:

See Also:



32
33
34
 
# File 'cognito/cfn_user_pool_ui_customization_attachment_props.rb', line 32

def user_pool_id
  @user_pool_id
end

Class Method Details

.jsii_properties ⇒ Object 



41
42
43
44
45
46
47
 
# File 'cognito/cfn_user_pool_ui_customization_attachment_props.rb', line 41

def self.jsii_properties
  {
    :client_id => "clientId",
    :user_pool_id => "userPoolId",
    :css => "css",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



49
50
51
52
53
54
55
56
57
 
# File 'cognito/cfn_user_pool_ui_customization_attachment_props.rb', line 49

def to_jsii
  result = {}
  result.merge!({
    "clientId" => @client_id,
    "userPoolId" => @user_pool_id,
    "css" => @css,
  })
  result.compact
end