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

Inherits:
Struct
  • Object
show all
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.

This data type is a response parameter of CreateManagedLoginBranding, UpdateManagedLoginBranding, DescribeManagedLoginBranding, and DescribeManagedLoginBrandingByClient.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#assetsArray<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:



8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8394

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_dateTime

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)


8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8394

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_dateTime

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)


8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8394

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_idString

The ID of the managed login branding style.

Returns:

  • (String)


8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8394

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

#settingsHash, ...

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

Returns:

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


8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8394

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_valuesBoolean

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 designer.

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

Returns:

  • (Boolean)


8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8394

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_idString

The user pool where the branding style is assigned.

Returns:

  • (String)


8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8394

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