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

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::ManagedLoginBrandingType

Defined in:

gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #assets ⇒ Array<Types::AssetType>

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

• #creation_date ⇒ Time

  The date and time when the item was created.

• #last_modified_date ⇒ Time

  The date and time when the item was modified.

• #managed_login_branding_id ⇒ String

  The ID of the managed login branding style.

• #settings ⇒ Hash, ...

  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

  When true, applies the default branding style options.

• #user_pool_id ⇒ String

  The user pool where the branding style is assigned.

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:

• (Array<Types::AssetType>)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9718

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)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9718

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)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9718

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)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9718

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)

Returns:

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

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9718

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)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9718

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)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9718

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