Skip to content

/AWS1/CL_CGPMANAGEDLOGINBRAN00

A managed login branding style that's assigned to a user pool app client.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_managedloginbrandingid TYPE /AWS1/CGPMANAGEDLOGINBRANDIN00 /AWS1/CGPMANAGEDLOGINBRANDIN00

The ID of the managed login branding style.

iv_userpoolid TYPE /AWS1/CGPUSERPOOLIDTYPE /AWS1/CGPUSERPOOLIDTYPE

The user pool where the branding style is assigned.

iv_usecognitoprovidedvalues TYPE /AWS1/CGPBOOLEANTYPE /AWS1/CGPBOOLEANTYPE

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

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

io_settings TYPE REF TO /AWS1/CL_RT_DOCUMENT /AWS1/CL_RT_DOCUMENT

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:

it_assets TYPE /AWS1/CL_CGPASSETTYPE=>TT_ASSETLISTTYPE TT_ASSETLISTTYPE

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.

iv_creationdate TYPE /AWS1/CGPDATETYPE /AWS1/CGPDATETYPE

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.

iv_lastmodifieddate TYPE /AWS1/CGPDATETYPE /AWS1/CGPDATETYPE

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.

Queryable Attributes

ManagedLoginBrandingId

The ID of the managed login branding style.

Accessible with the following methods

Method Description
GET_MANAGEDLOGINBRANDINGID() Getter for MANAGEDLOGINBRANDINGID, with configurable default
ASK_MANAGEDLOGINBRANDINGID() Getter for MANAGEDLOGINBRANDINGID w/ exceptions if field has
HAS_MANAGEDLOGINBRANDINGID() Determine if MANAGEDLOGINBRANDINGID has a value

UserPoolId

The user pool where the branding style is assigned.

Accessible with the following methods

Method Description
GET_USERPOOLID() Getter for USERPOOLID, with configurable default
ASK_USERPOOLID() Getter for USERPOOLID w/ exceptions if field has no value
HAS_USERPOOLID() Determine if USERPOOLID has a value

UseCognitoProvidedValues

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

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

Accessible with the following methods

Method Description
GET_USECOGNITOPROVIDEDVALUES() Getter for USECOGNITOPROVIDEDVALUES

Settings

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:

Accessible with the following methods

Method Description
GET_SETTINGS() Getter for SETTINGS, with configurable default
ASK_SETTINGS() Getter for SETTINGS w/ exceptions if field has no value
HAS_SETTINGS() Determine if SETTINGS has a value

Assets

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.

Accessible with the following methods

Method Description
GET_ASSETS() Getter for ASSETS, with configurable default
ASK_ASSETS() Getter for ASSETS w/ exceptions if field has no value
HAS_ASSETS() Determine if ASSETS has a value

CreationDate

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.

Accessible with the following methods

Method Description
GET_CREATIONDATE() Getter for CREATIONDATE, with configurable default
ASK_CREATIONDATE() Getter for CREATIONDATE w/ exceptions if field has no value
HAS_CREATIONDATE() Determine if CREATIONDATE has a value

LastModifiedDate

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.

Accessible with the following methods

Method Description
GET_LASTMODIFIEDDATE() Getter for LASTMODIFIEDDATE, with configurable default
ASK_LASTMODIFIEDDATE() Getter for LASTMODIFIEDDATE w/ exceptions if field has no va
HAS_LASTMODIFIEDDATE() Determine if LASTMODIFIEDDATE has a value