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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/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 and UpdateManagedLoginBranding, and a response parameter of DescribeManagedLoginBranding.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bytesString

The image file, in Base64-encoded binary.

Returns:

  • (String)


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

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

#categoryString

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 'gems/aws-sdk-cognitoidentityprovider/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_modeString

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 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2520

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

#extensionString

The file type of the image file.

Returns:

  • (String)


2520
2521
2522
2523
2524
2525
2526
2527
2528
# File 'gems/aws-sdk-cognitoidentityprovider/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_idString

The ID of the asset.

Returns:

  • (String)


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

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