Class: Aws::CognitoIdentityProvider::Types::UICustomizationType

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::UICustomizationType

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

A container for the UI customization information for the hosted UI in a user pool.

This data type is a response parameter of [GetUICustomization].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:client_id]

Instance Attribute Summary

• #client_id ⇒ String

  The app client ID for your UI customization.

• #creation_date ⇒ Time

  The date and time when the item was created.

• #css ⇒ String

  The CSS values in the UI customization.

• #css_version ⇒ String

  The CSS version number.

• #image_url ⇒ String

  A URL path to the hosted logo image of your UI customization.

• #last_modified_date ⇒ Time

  The date and time when the item was modified.

• #user_pool_id ⇒ String

  The ID of the user pool with hosted UI customizations.

Instance Attribute Details

#client_id ⇒ String

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)

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

class UICustomizationType < Struct.new(
  :user_pool_id,
  :client_id,
  :image_url,
  :css,
  :css_version,
  :last_modified_date,
  :creation_date)
  SENSITIVE = [:client_id]
  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 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10337

class UICustomizationType < Struct.new(
  :user_pool_id,
  :client_id,
  :image_url,
  :css,
  :css_version,
  :last_modified_date,
  :creation_date)
  SENSITIVE = [:client_id]
  include Aws::Structure
end

#css ⇒ String

The CSS values in the UI customization. To get a template with your UI customization options, make a [GetUiCustomization] request.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUiCustomization.html

Returns:

• (String)

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

class UICustomizationType < Struct.new(
  :user_pool_id,
  :client_id,
  :image_url,
  :css,
  :css_version,
  :last_modified_date,
  :creation_date)
  SENSITIVE = [:client_id]
  include Aws::Structure
end

#css_version ⇒ String

The CSS version number.

Returns:

• (String)

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

class UICustomizationType < Struct.new(
  :user_pool_id,
  :client_id,
  :image_url,
  :css,
  :css_version,
  :last_modified_date,
  :creation_date)
  SENSITIVE = [:client_id]
  include Aws::Structure
end

#image_url ⇒ String

A URL path to the hosted logo image of your UI customization.

Returns:

• (String)

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

class UICustomizationType < Struct.new(
  :user_pool_id,
  :client_id,
  :image_url,
  :css,
  :css_version,
  :last_modified_date,
  :creation_date)
  SENSITIVE = [:client_id]
  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 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10337

class UICustomizationType < Struct.new(
  :user_pool_id,
  :client_id,
  :image_url,
  :css,
  :css_version,
  :last_modified_date,
  :creation_date)
  SENSITIVE = [:client_id]
  include Aws::Structure
end

#user_pool_id ⇒ String

The ID of the user pool with hosted UI customizations.

Returns:

• (String)

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

class UICustomizationType < Struct.new(
  :user_pool_id,
  :client_id,
  :image_url,
  :css,
  :css_version,
  :last_modified_date,
  :creation_date)
  SENSITIVE = [:client_id]
  include Aws::Structure
end