Class CfnTermsPropsMixin.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.cognito.CfnTermsPropsMixin.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnTermsPropsMixin>
- Enclosing class:
CfnTermsPropsMixin
@Stability(Stable)
public static final class CfnTermsPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnTermsPropsMixin>
A fluent builder for
CfnTermsPropsMixin.-
Method Summary
Modifier and TypeMethodDescriptionbuild()The ID of the app client that the terms documents are assigned to.static CfnTermsPropsMixin.Buildercreate()static CfnTermsPropsMixin.Buildercreate(CfnPropertyMixinOptions options) enforcement(String enforcement) This parameter is reserved for future use and currently accepts one value.A map of URLs to languages.links(IResolvable links) A map of URLs to languages.The type and friendly name of the terms documents.termsSource(String termsSource) This parameter is reserved for future use and currently accepts one value.userPoolId(String userPoolId) The ID of the user pool that contains the terms documents.
-
Method Details
-
create
- Parameters:
options- Mixin options.- Returns:
- a new instance of
CfnTermsPropsMixin.Builder.
-
create
- Returns:
- a new instance of
CfnTermsPropsMixin.Builder.
-
clientId
The ID of the app client that the terms documents are assigned to.- Parameters:
clientId- The ID of the app client that the terms documents are assigned to. This parameter is required.- Returns:
this- See Also:
-
enforcement
This parameter is reserved for future use and currently accepts one value.- Parameters:
enforcement- This parameter is reserved for future use and currently accepts one value. This parameter is required.- Returns:
this- See Also:
-
links
A map of URLs to languages.For each localized language that will view the requested
TermsName, 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".- Parameters:
links- A map of URLs to languages. This parameter is required.- Returns:
this- See Also:
-
links
A map of URLs to languages.For each localized language that will view the requested
TermsName, 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".- Parameters:
links- A map of URLs to languages. This parameter is required.- Returns:
this- See Also:
-
termsName
The type and friendly name of the terms documents.- Parameters:
termsName- The type and friendly name of the terms documents. This parameter is required.- Returns:
this- See Also:
-
termsSource
This parameter is reserved for future use and currently accepts one value.- Parameters:
termsSource- This parameter is reserved for future use and currently accepts one value. This parameter is required.- Returns:
this- See Also:
-
userPoolId
The ID of the user pool that contains the terms documents.- Parameters:
userPoolId- The ID of the user pool that contains the terms documents. This parameter is required.- Returns:
this- See Also:
-
build
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnTermsPropsMixin>- Returns:
- a newly built instance of
CfnTermsPropsMixin.
-