Class: Aws::CognitoIdentityProvider::Types::AssetType

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

Overview

An image file from a managed login branding style in a user pool.

This data type is a request parameter of

CreateManagedLoginBranding][1

and [UpdateManagedLoginBranding],

and a response parameter of [DescribeManagedLoginBranding].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateManagedLoginBranding.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateManagedLoginBranding.html [3]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeManagedLoginBranding.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bytes ⇒ String

The image file, in Base64-encoded binary.

Returns:

  • (String) 


2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2520

class AssetType < Struct.new(
  :category,
  :color_mode,
  :extension,
  :bytes,
  :resource_id)
  SENSITIVE = []
  include Aws::Structure
end

#category ⇒ String

The category that the image corresponds to in your managed login configuration. Managed login has asset categories for different types of logos, backgrounds, and icons.

Returns:

  • (String) 


2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2520

class AssetType < Struct.new(
  :category,
  :color_mode,
  :extension,
  :bytes,
  :resource_id)
  SENSITIVE = []
  include Aws::Structure
end

#color_mode ⇒ String

The display-mode target of the asset: light, dark, or browser-adaptive. For example, Amazon Cognito displays a dark-mode image only when the browser or application is in dark mode, but displays a browser-adaptive file in all contexts.

Returns:

  • (String) 


2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2520

class AssetType < Struct.new(
  :category,
  :color_mode,
  :extension,
  :bytes,
  :resource_id)
  SENSITIVE = []
  include Aws::Structure
end

#extension ⇒ String

The file type of the image file.

Returns:

  • (String) 


2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2520

class AssetType < Struct.new(
  :category,
  :color_mode,
  :extension,
  :bytes,
  :resource_id)
  SENSITIVE = []
  include Aws::Structure
end

#resource_id ⇒ String

The ID of the asset.

Returns:

  • (String) 


2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2520

class AssetType < Struct.new(
  :category,
  :color_mode,
  :extension,
  :bytes,
  :resource_id)
  SENSITIVE = []
  include Aws::Structure
end