Interface SetUiCustomizationRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CognitoIdentityProviderRequest.Builder
,CopyableBuilder<SetUiCustomizationRequest.Builder,
,SetUiCustomizationRequest> SdkBuilder<SetUiCustomizationRequest.Builder,
,SetUiCustomizationRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
SetUiCustomizationRequest
@Mutable
@NotThreadSafe
public static interface SetUiCustomizationRequest.Builder
extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<SetUiCustomizationRequest.Builder,SetUiCustomizationRequest>
-
Method Summary
Modifier and TypeMethodDescriptionThe ID of the app client that you want to customize.A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client.The image that you want to set as your login in the classic hosted UI, as a Base64-formatted binary object.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.userPoolId
(String userPoolId) The ID of the user pool where you want to apply branding to the classic hosted UI.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
userPoolId
The ID of the user pool where you want to apply branding to the classic hosted UI.
- Parameters:
userPoolId
- The ID of the user pool where you want to apply branding to the classic hosted UI.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
ALL
.- Parameters:
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 toALL
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
CSS template.css
.- Parameters:
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 toCSS template.css
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
imageFile
The image that you want to set as your login in the classic hosted UI, as a Base64-formatted binary object.
- Parameters:
imageFile
- The image that you want to set as your login in the classic hosted UI, as a Base64-formatted binary object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
SetUiCustomizationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
SetUiCustomizationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-