ui_customizations
Creates, updates, deletes, gets or lists a ui_customizations resource.
Overview
| Name | ui_customizations |
| Type | Resource |
| Id | aws.cognito_idp.ui_customizations |
Fields
The following fields are returned by SELECT queries:
- get_ui_customization
| Name | Datatype | Description |
|---|---|---|
css | string | The CSS values in the UI customization. |
css_version | string | The CSS version number. |
client_id | string | The app client ID for your UI customization. When this value isn't present, the customization applies to all user pool app clients that don't have client-level settings.. (pattern: <code>[\w+]+</code>) |
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. |
image_url | string | A URL path to the hosted logo image of your UI customization. |
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. |
user_pool_id | string | The ID of the user pool with hosted UI customizations. (pattern: <code>[\w-]+_[0-9a-zA-Z]+</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_ui_customization | select | region | Given a user pool ID or app client, returns information about classic hosted UI branding that you applied, if any. Returns user-pool level branding information if no app client branding is applied, or if you don't specify an app client ID. Returns an empty object if you haven't applied hosted UI branding to either the client or the user pool. For more information, see Hosted UI (classic) branding. | |
set_ui_customization | update | region, UserPoolId | Configures UI branding settings for domains with the hosted UI (classic) branding version. Your user pool must have a domain. Configure a domain with . Set the default configuration for all clients with a ClientId of ALL. When the ClientId value is an app client ID, the settings you pass in this request apply to that app client and override the default ALL configuration. 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
- get_ui_customization
Given a user pool ID or app client, returns information about classic hosted UI branding that you applied, if any. Returns user-pool level branding information if no app client branding is applied, or if you don't specify an app client ID. Returns an empty object if you haven't applied hosted UI branding to either the client or the user pool. For more information, see Hosted UI (classic) branding.
SELECT
css,
css_version,
client_id,
creation_date,
image_url,
last_modified_date,
user_pool_id
FROM aws.cognito_idp.ui_customizations
WHERE region = '{{ region }}' -- required
;
UPDATE examples
- set_ui_customization
Configures UI branding settings for domains with the hosted UI (classic) branding version. Your user pool must have a domain. Configure a domain with . Set the default configuration for all clients with a ClientId of ALL. When the ClientId value is an app client ID, the settings you pass in this request apply to that app client and override the default ALL configuration. 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.ui_customizations
SET
UserPoolId = '{{ UserPoolId }}',
ClientId = '{{ ClientId }}',
CSS = '{{ CSS }}',
ImageFile = '{{ ImageFile }}'
WHERE
region = '{{ region }}' --required
AND UserPoolId = '{{ UserPoolId }}' --required
RETURNING
ui_customization;