Package software.amazon.awscdk.cfnpropertymixins.services.cognito

Class CfnManagedLoginBrandingMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.cognito.CfnManagedLoginBrandingMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnManagedLoginBrandingMixinProps>

Enclosing interface:

CfnManagedLoginBrandingMixinProps

@Stability(Stable)
public static final class CfnManagedLoginBrandingMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnManagedLoginBrandingMixinProps>

A builder for CfnManagedLoginBrandingMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnManagedLoginBrandingMixinProps.Builder	assets(List<? extends Object> assets)	Sets the value of CfnManagedLoginBrandingMixinProps.getAssets()
CfnManagedLoginBrandingMixinProps.Builder	assets(IResolvable assets)	Sets the value of CfnManagedLoginBrandingMixinProps.getAssets()
CfnManagedLoginBrandingMixinProps	build()	Builds the configured instance.
CfnManagedLoginBrandingMixinProps.Builder	clientId(String clientId)	Sets the value of CfnManagedLoginBrandingMixinProps.getClientId()
CfnManagedLoginBrandingMixinProps.Builder	returnMergedResources(Boolean returnMergedResources)	Sets the value of CfnManagedLoginBrandingMixinProps.getReturnMergedResources()
CfnManagedLoginBrandingMixinProps.Builder	returnMergedResources(IResolvable returnMergedResources)	Sets the value of CfnManagedLoginBrandingMixinProps.getReturnMergedResources()
CfnManagedLoginBrandingMixinProps.Builder	settings(Object settings)	Sets the value of CfnManagedLoginBrandingMixinProps.getSettings()
CfnManagedLoginBrandingMixinProps.Builder	useCognitoProvidedValues(Boolean useCognitoProvidedValues)	Sets the value of CfnManagedLoginBrandingMixinProps.getUseCognitoProvidedValues()
CfnManagedLoginBrandingMixinProps.Builder	useCognitoProvidedValues(IResolvable useCognitoProvidedValues)	Sets the value of CfnManagedLoginBrandingMixinProps.getUseCognitoProvidedValues()
CfnManagedLoginBrandingMixinProps.Builder	userPoolId(String userPoolId)	Sets the value of CfnManagedLoginBrandingMixinProps.getUserPoolId()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

assets

@Stability(Stable)
public CfnManagedLoginBrandingMixinProps.Builder assets(IResolvable assets)

Sets the value of CfnManagedLoginBrandingMixinProps.getAssets()

Parameters:

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.

Returns:

this

assets

@Stability(Stable)
public CfnManagedLoginBrandingMixinProps.Builder assets(List<? extends Object> assets)

Sets the value of CfnManagedLoginBrandingMixinProps.getAssets()

Parameters:

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.

Returns:

this

clientId

@Stability(Stable)
public CfnManagedLoginBrandingMixinProps.Builder clientId(String clientId)

Sets the value of CfnManagedLoginBrandingMixinProps.getClientId()

Parameters:

clientId - The app client that you want to assign the branding style to. Each style is linked to an app client until you delete it.

Returns:

this

returnMergedResources

@Stability(Stable)
public CfnManagedLoginBrandingMixinProps.Builder returnMergedResources(Boolean returnMergedResources)

Sets the value of CfnManagedLoginBrandingMixinProps.getReturnMergedResources()

Parameters:

returnMergedResources - When true , returns values for branding options that are unchanged from Amazon Cognito defaults. When false or when you omit this parameter, returns only values that you customized in your branding style.

Returns:

this

returnMergedResources

@Stability(Stable)
public CfnManagedLoginBrandingMixinProps.Builder returnMergedResources(IResolvable returnMergedResources)

Sets the value of CfnManagedLoginBrandingMixinProps.getReturnMergedResources()

Parameters:

returnMergedResources - When true , returns values for branding options that are unchanged from Amazon Cognito defaults. When false or when you omit this parameter, returns only values that you customized in your branding style.

Returns:

this

settings

@Stability(Stable)
public CfnManagedLoginBrandingMixinProps.Builder settings(Object settings)

Sets the value of CfnManagedLoginBrandingMixinProps.getSettings()

Parameters:

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:

• signUp
• instructions
• sessionTimerDisplay
• languageSelector (for localization, see Managed login localization)

Returns:

this

useCognitoProvidedValues

@Stability(Stable)
public CfnManagedLoginBrandingMixinProps.Builder useCognitoProvidedValues(Boolean useCognitoProvidedValues)

Sets the value of CfnManagedLoginBrandingMixinProps.getUseCognitoProvidedValues()

Parameters:

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.

Returns:

this

useCognitoProvidedValues

@Stability(Stable)
public CfnManagedLoginBrandingMixinProps.Builder useCognitoProvidedValues(IResolvable useCognitoProvidedValues)

Sets the value of CfnManagedLoginBrandingMixinProps.getUseCognitoProvidedValues()

Parameters:

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.

Returns:

this

userPoolId

@Stability(Stable)
public CfnManagedLoginBrandingMixinProps.Builder userPoolId(String userPoolId)

Sets the value of CfnManagedLoginBrandingMixinProps.getUserPoolId()

Parameters:

userPoolId - The user pool where the branding style is assigned.

Returns:

this

build

@Stability(Stable)
public CfnManagedLoginBrandingMixinProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnManagedLoginBrandingMixinProps>

Returns:

a new instance of CfnManagedLoginBrandingMixinProps

Throws:

NullPointerException - if any required attribute was not provided