Class: Aws::CognitoIdentityProvider::Types::CreateManagedLoginBrandingRequest

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::CreateManagedLoginBrandingRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:client_id]

Instance Attribute Summary

• #assets ⇒ Array<Types::AssetType>

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

• #client_id ⇒ String

  The app client that you want to create the branding style for.

• #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 ID of the user pool where you want to create a new branding style.

Instance Attribute Details

#assets ⇒ Array<Types::AssetType>

An array of image files that you want to apply to functions 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 3891

class CreateManagedLoginBrandingRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :use_cognito_provided_values,
  :settings,
  :assets)
  SENSITIVE = [:client_id]
  include Aws::Structure
end

#client_id ⇒ String

The app client that you want to create the branding style for. Each style is linked to an app client until you delete it.

Returns:

• (String)

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

class CreateManagedLoginBrandingRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :use_cognito_provided_values,
  :settings,
  :assets)
  SENSITIVE = [:client_id]
  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 3891

class CreateManagedLoginBrandingRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :use_cognito_provided_values,
  :settings,
  :assets)
  SENSITIVE = [:client_id]
  include Aws::Structure
end

#use_cognito_provided_values ⇒ Boolean

When true, applies the default branding style options. These default options 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 3891

class CreateManagedLoginBrandingRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :use_cognito_provided_values,
  :settings,
  :assets)
  SENSITIVE = [:client_id]
  include Aws::Structure
end

#user_pool_id ⇒ String

The ID of the user pool where you want to create a new branding style.

Returns:

• (String)

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

class CreateManagedLoginBrandingRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :use_cognito_provided_values,
  :settings,
  :assets)
  SENSITIVE = [:client_id]
  include Aws::Structure
end