AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the SetUICustomization operation. 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
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public class SetUICustomizationRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The SetUICustomizationRequest type exposes the following members
Name | Description | |
---|---|---|
![]() |
SetUICustomizationRequest() |
Name | Type | Description | |
---|---|---|---|
![]() |
ClientId | System.String |
Gets and sets the property ClientId.
The ID of the app client that you want to customize. To apply a default style to all
app clients not configured with client-level branding, set this parameter value to
|
![]() |
CSS | System.String |
Gets and sets the property CSS.
A plaintext CSS file that contains the custom fields that you want to apply to your
user pool or app client. To download a template, go to the Amazon Cognito console.
Navigate to your user pool App clients tab, select Login pages, edit
Hosted UI (classic) style, and select the link to |
![]() |
ImageFile | System.IO.MemoryStream |
Gets and sets the property ImageFile. The image that you want to set as your login in the classic hosted UI, as a Base64-formatted binary object. |
![]() |
UserPoolId | System.String |
Gets and sets the property UserPoolId. The ID of the user pool where you want to apply branding to the classic hosted UI. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5