managed_login_brandings

Creates, updates, deletes, gets or lists a managed_login_brandings resource.

Overview

Name	`managed_login_brandings`
Type	Resource
Id	`aws.cognito_idp.managed_login_brandings`

Fields

The following fields are returned by SELECT queries:

describe_managed_login_branding

Name	Datatype	Description
`assets`	`array`	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.
`creation_date`	`string (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.
`last_modified_date`	`string (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.
`managed_login_branding_id`	`string`	The ID of the managed login branding style. (pattern: <code>^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$</code>)
`settings`	`object`	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: signUp instructions sessionTimerDisplay languageSelector (for localization, see Managed login localization)
`use_cognito_provided_values`	`boolean`	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.
`user_pool_id`	`string`	The user pool where the branding style is assigned. (pattern: <code>[\w-]+_[0-9a-zA-Z]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`describe_managed_login_branding`	`select`	`region`	Given the ID of a managed login branding style, returns detailed information about the style.
`create_managed_login_branding`	`insert`	`region`, `UserPoolId`, `ClientId`	Creates a new set of branding settings for a user pool style and associates it with an app client. This operation is the programmatic option for the creation of a new style in the branding editor. Provides values for UI customization in a Settings JSON object and image files in an Assets array. To send the JSON object Document type parameter in Settings, you might need to update to the most recent version of your Amazon Web Services SDK. To create a new style with default settings, set UseCognitoProvidedValues to true and don't provide values for any other options. This operation has a 2-megabyte request-size limit and include the CSS settings and image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito doesn't require that you pass all parameters in one request and preserves existing style settings that you don't specify. If your request is larger than 2MB, separate it into multiple requests, each with a size smaller than the limit. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints
`update_managed_login_branding`	`update`	`region`	Configures the branding settings for a user pool style. This operation is the programmatic option for the configuration of a style in the branding editor. Provides values for UI customization in a Settings JSON object and image files in an Assets array. This operation has a 2-megabyte request-size limit and include the CSS settings and image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito doesn't require that you pass all parameters in one request and preserves existing style settings that you don't specify. If your request is larger than 2MB, separate it into multiple requests, each with a size smaller than the limit. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints
`delete_managed_login_branding`	`delete`	`region`	Deletes a managed login branding style. When you delete a style, you delete the branding association for an app client. When an app client doesn't have a style assigned, your managed login pages for that app client are nonfunctional until you create a new style or switch the domain branding version. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`region`	`string`	AWS region (default: us-east-1)

`SELECT` examples

describe_managed_login_branding

Given the ID of a managed login branding style, returns detailed information about the style.

SELECT
assets,
creation_date,
last_modified_date,
managed_login_branding_id,
settings,
use_cognito_provided_values,
user_pool_id
FROM aws.cognito_idp.managed_login_brandings
WHERE region = '{{ region }}' -- required
;

`INSERT` examples

create_managed_login_branding
Manifest

Creates a new set of branding settings for a user pool style and associates it with an app client. This operation is the programmatic option for the creation of a new style in the branding editor. Provides values for UI customization in a Settings JSON object and image files in an Assets array. To send the JSON object Document type parameter in Settings, you might need to update to the most recent version of your Amazon Web Services SDK. To create a new style with default settings, set UseCognitoProvidedValues to true and don't provide values for any other options. This operation has a 2-megabyte request-size limit and include the CSS settings and image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito doesn't require that you pass all parameters in one request and preserves existing style settings that you don't specify. If your request is larger than 2MB, separate it into multiple requests, each with a size smaller than the limit. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints

INSERT INTO aws.cognito_idp.managed_login_brandings (
UserPoolId,
ClientId,
UseCognitoProvidedValues,
Settings,
Assets,
region
)
SELECT 
'{{ UserPoolId }}' /* required */,
'{{ ClientId }}' /* required */,
{{ UseCognitoProvidedValues }},
'{{ Settings }}',
'{{ Assets }}',
'{{ region }}'
RETURNING
managed_login_branding
;

# Description fields are for documentation purposes
- name: managed_login_brandings
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the managed_login_brandings resource.
  - name: UserPoolId
    value: "{{ UserPoolId }}"
    description: |
      The ID of the user pool where you want to create a new branding style.
  - name: ClientId
    value: "{{ ClientId }}"
    description: |
      The app client that you want to create the branding style for. Each style is linked to an app client until you delete it.
  - name: UseCognitoProvidedValues
    value: {{ UseCognitoProvidedValues }}
    description: |
      When true, applies the default branding style options. These default options 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.
  - name: Settings
    value: "{{ Settings }}"
    description: |
      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: signUp instructions sessionTimerDisplay languageSelector (for localization, see Managed login localization)
  - name: Assets
    description: |
      An array of image files that you want to apply to functions like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.
    value:
      - Category: "{{ Category }}"
        ColorMode: "{{ ColorMode }}"
        Extension: "{{ Extension }}"
        Bytes: "{{ Bytes }}"
        ResourceId: "{{ ResourceId }}"

`UPDATE` examples

update_managed_login_branding

Configures the branding settings for a user pool style. This operation is the programmatic option for the configuration of a style in the branding editor. Provides values for UI customization in a Settings JSON object and image files in an Assets array. This operation has a 2-megabyte request-size limit and include the CSS settings and image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito doesn't require that you pass all parameters in one request and preserves existing style settings that you don't specify. If your request is larger than 2MB, separate it into multiple requests, each with a size smaller than the limit. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints

UPDATE aws.cognito_idp.managed_login_brandings
SET 
UserPoolId = '{{ UserPoolId }}',
ManagedLoginBrandingId = '{{ ManagedLoginBrandingId }}',
UseCognitoProvidedValues = {{ UseCognitoProvidedValues }},
Settings = '{{ Settings }}',
Assets = '{{ Assets }}'
WHERE 
region = '{{ region }}' --required
RETURNING
managed_login_branding;

`DELETE` examples

delete_managed_login_branding

Deletes a managed login branding style. When you delete a style, you delete the branding association for an app client. When an app client doesn't have a style assigned, your managed login pages for that app client are nonfunctional until you create a new style or switch the domain branding version. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints

DELETE FROM aws.cognito_idp.managed_login_brandings
WHERE region = '{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​