Class CfnTermsMixinProps.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.cognito.CfnTermsMixinProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnTermsMixinProps>
- Enclosing interface:
CfnTermsMixinProps
@Stability(Stable)
public static final class CfnTermsMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnTermsMixinProps>
A builder for
CfnTermsMixinProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.Sets the value ofCfnTermsMixinProps.getClientId()enforcement(String enforcement) Sets the value ofCfnTermsMixinProps.getEnforcement()Sets the value ofCfnTermsMixinProps.getLinks()links(IResolvable links) Sets the value ofCfnTermsMixinProps.getLinks()Sets the value ofCfnTermsMixinProps.getTermsName()termsSource(String termsSource) Sets the value ofCfnTermsMixinProps.getTermsSource()userPoolId(String userPoolId) Sets the value ofCfnTermsMixinProps.getUserPoolId()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
clientId
Sets the value ofCfnTermsMixinProps.getClientId()- Parameters:
clientId- The ID of the app client that the terms documents are assigned to.- Returns:
this
-
enforcement
Sets the value ofCfnTermsMixinProps.getEnforcement()- Parameters:
enforcement- This parameter is reserved for future use and currently accepts one value.- Returns:
this
-
links
Sets the value ofCfnTermsMixinProps.getLinks()- Parameters:
links- A map of URLs to languages. For each localized language that will view the requestedTermsName, assign a URL. A selection ofcognito:defaultdisplays for all languages that don't have a language-specific URL.For example,
"cognito:default": "https://terms.example.com", "cognito:spanish": "https://terms.example.com/es".- Returns:
this
-
links
Sets the value ofCfnTermsMixinProps.getLinks()- Parameters:
links- A map of URLs to languages. For each localized language that will view the requestedTermsName, assign a URL. A selection ofcognito:defaultdisplays for all languages that don't have a language-specific URL.For example,
"cognito:default": "https://terms.example.com", "cognito:spanish": "https://terms.example.com/es".- Returns:
this
-
termsName
Sets the value ofCfnTermsMixinProps.getTermsName()- Parameters:
termsName- The type and friendly name of the terms documents.- Returns:
this
-
termsSource
Sets the value ofCfnTermsMixinProps.getTermsSource()- Parameters:
termsSource- This parameter is reserved for future use and currently accepts one value.- Returns:
this
-
userPoolId
Sets the value ofCfnTermsMixinProps.getUserPoolId()- Parameters:
userPoolId- The ID of the user pool that contains the terms documents.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnTermsMixinProps>- Returns:
- a new instance of
CfnTermsMixinProps - Throws:
NullPointerException- if any required attribute was not provided
-