Class: Aws::CognitoIdentityProvider::Types::ManagedLoginBrandingType

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

A managed login branding style that’s assigned to a user pool app client.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#assets ⇒ Array<Types::AssetType>

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:



8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8640

class ManagedLoginBrandingType < Struct.new(
  :managed_login_branding_id,
  :user_pool_id,
  :use_cognito_provided_values,
  :settings,
  :assets,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ Time

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java ‘Date` object.

Returns:

  • (Time) 


8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8640

class ManagedLoginBrandingType < Struct.new(
  :managed_login_branding_id,
  :user_pool_id,
  :use_cognito_provided_values,
  :settings,
  :assets,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_date ⇒ Time

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java ‘Date` object.

Returns:

  • (Time) 


8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8640

class ManagedLoginBrandingType < Struct.new(
  :managed_login_branding_id,
  :user_pool_id,
  :use_cognito_provided_values,
  :settings,
  :assets,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#managed_login_branding_id ⇒ String

The ID of the managed login branding style.

Returns:

  • (String) 


8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8640

class ManagedLoginBrandingType < Struct.new(
  :managed_login_branding_id,
  :user_pool_id,
  :use_cognito_provided_values,
  :settings,
  :assets,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#settings ⇒ Hash, ...

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:

  • ‘signUp`

  • ‘instructions`

  • ‘sessionTimerDisplay`

  • ‘languageSelector` (for localization, see [Managed login localization)]

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-localization

Returns:

  • (Hash, Array, String, Numeric, Boolean) 


8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8640

class ManagedLoginBrandingType < Struct.new(
  :managed_login_branding_id,
  :user_pool_id,
  :use_cognito_provided_values,
  :settings,
  :assets,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#use_cognito_provided_values ⇒ Boolean

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:

  • (Boolean) 


8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8640

class ManagedLoginBrandingType < Struct.new(
  :managed_login_branding_id,
  :user_pool_id,
  :use_cognito_provided_values,
  :settings,
  :assets,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_id ⇒ String

The user pool where the branding style is assigned.

Returns:

  • (String) 


8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8640

class ManagedLoginBrandingType < Struct.new(
  :managed_login_branding_id,
  :user_pool_id,
  :use_cognito_provided_values,
  :settings,
  :assets,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end