Class: AWSCDK::Cognito::CfnManagedLoginBrandingProps

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

Overview

Properties for defining a CfnManagedLoginBranding.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_pool_id:, assets: nil, client_id: nil, return_merged_resources: nil, settings: nil, use_cognito_provided_values: nil) ⇒ CfnManagedLoginBrandingProps

Returns a new instance of CfnManagedLoginBrandingProps.

Parameters:

  • user_pool_id (String) —

    The user pool where the branding style is assigned.

  • assets (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Cognito::CfnManagedLoginBranding::AssetTypeProperty>, nil) (defaults to: nil) —

    An array of image files that you want to apply to roles like backgrounds, logos, and icons.

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

    The app client that you want to assign the branding style to.

  • return_merged_resources (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    When true , returns values for branding options that are unchanged from Amazon Cognito defaults.

  • settings (Object, nil) (defaults to: nil) —

    A JSON file, encoded as a Document type, with the the settings that you want to apply to your style.

  • use_cognito_provided_values (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    When true, applies the default branding style options.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'cognito/cfn_managed_login_branding_props.rb', line 15

def initialize(user_pool_id:, assets: nil, client_id: nil, return_merged_resources: nil, settings: nil, use_cognito_provided_values: nil)
  @user_pool_id = user_pool_id
  Jsii::Type.check_type(@user_pool_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userPoolId")
  @assets = assets
  Jsii::Type.check_type(@assets, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5DZm5NYW5hZ2VkTG9naW5CcmFuZGluZy5Bc3NldFR5cGVQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "assets") unless @assets.nil?
  @client_id = client_id
  Jsii::Type.check_type(@client_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientId") unless @client_id.nil?
  @return_merged_resources = return_merged_resources
  Jsii::Type.check_type(@return_merged_resources, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "returnMergedResources") unless @return_merged_resources.nil?
  @settings = settings
  Jsii::Type.check_type(@settings, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "settings") unless @settings.nil?
  @use_cognito_provided_values = use_cognito_provided_values
  Jsii::Type.check_type(@use_cognito_provided_values, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "useCognitoProvidedValues") unless @use_cognito_provided_values.nil?
end

Instance Attribute Details

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

An array of image files that you want to apply to roles like backgrounds, logos, and icons.

Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.

Returns:

See Also:



41
42
43
 
# File 'cognito/cfn_managed_login_branding_props.rb', line 41

def assets
  @assets
end

#client_id ⇒ String? (readonly)

The app client that you want to assign the branding style to.

Each style is linked to an app client until you delete it.

Returns:

  • (String, nil)

See Also:



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

def client_id
  @client_id
end

#return_merged_resources ⇒ Boolean, ... (readonly)

When true , returns values for branding options that are unchanged from Amazon Cognito defaults.

When false or when you omit this parameter, returns only values that you customized in your branding style.

Returns:

See Also:



55
56
57
 
# File 'cognito/cfn_managed_login_branding_props.rb', line 55

def return_merged_resources
  @return_merged_resources
end

#settings ⇒ Object? (readonly)

A JSON file, encoded as a Document type, with the the settings that you want to apply to your style.

The following components are not currently implemented and reserved for future use:

Returns:

  • (Object, nil)

See Also:



67
68
69
 
# File 'cognito/cfn_managed_login_branding_props.rb', line 67

def settings
  @settings
end

#use_cognito_provided_values ⇒ Boolean, ... (readonly)

When true, applies the default branding style options.

This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding editor.

When you specify true for this option, you must also omit values for Settings and Assets in the request.

Returns:

See Also:



76
77
78
 
# File 'cognito/cfn_managed_login_branding_props.rb', line 76

def use_cognito_provided_values
  @use_cognito_provided_values
end

#user_pool_id ⇒ String (readonly)

The user pool where the branding style is assigned.

Returns:

  • (String)

See Also:



34
35
36
 
# File 'cognito/cfn_managed_login_branding_props.rb', line 34

def user_pool_id
  @user_pool_id
end

Class Method Details

.jsii_properties ⇒ Object 



78
79
80
81
82
83
84
85
86
87
 
# File 'cognito/cfn_managed_login_branding_props.rb', line 78

def self.jsii_properties
  {
    :user_pool_id => "userPoolId",
    :assets => "assets",
    :client_id => "clientId",
    :return_merged_resources => "returnMergedResources",
    :settings => "settings",
    :use_cognito_provided_values => "useCognitoProvidedValues",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'cognito/cfn_managed_login_branding_props.rb', line 89

def to_jsii
  result = {}
  result.merge!({
    "userPoolId" => @user_pool_id,
    "assets" => @assets,
    "clientId" => @client_id,
    "returnMergedResources" => @return_merged_resources,
    "settings" => @settings,
    "useCognitoProvidedValues" => @use_cognito_provided_values,
  })
  result.compact
end