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

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 Type	Method	Description
CfnTermsPropsMixin	build()
CfnTermsPropsMixin.Builder	clientId(String clientId)	The ID of the app client that the terms documents are assigned to.
static CfnTermsPropsMixin.Builder	create()
static CfnTermsPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnTermsPropsMixin.Builder	enforcement(String enforcement)	This parameter is reserved for future use and currently accepts one value.
CfnTermsPropsMixin.Builder	links(Map<String,String> links)	A map of URLs to languages.
CfnTermsPropsMixin.Builder	links(IResolvable links)	A map of URLs to languages.
CfnTermsPropsMixin.Builder	termsName(String termsName)	The type and friendly name of the terms documents.
CfnTermsPropsMixin.Builder	termsSource(String termsSource)	This parameter is reserved for future use and currently accepts one value.
CfnTermsPropsMixin.Builder	userPoolId(String userPoolId)	The ID of the user pool that contains the terms documents.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnTermsPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnTermsPropsMixin.Builder.

create

@Stability(Stable)
public static CfnTermsPropsMixin.Builder create()

Returns:

a new instance of CfnTermsPropsMixin.Builder.

clientId

@Stability(Stable)
public CfnTermsPropsMixin.Builder clientId(String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-terms.html#cfn-cognito-terms-clientid

enforcement

@Stability(Stable)
public CfnTermsPropsMixin.Builder enforcement(String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-terms.html#cfn-cognito-terms-enforcement

links

@Stability(Stable)
public CfnTermsPropsMixin.Builder links(Map<String,String> links)

A map of URLs to languages.

For each localized language that will view the requested TermsName , assign a URL. A selection of cognito:default displays 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-terms.html#cfn-cognito-terms-links

links

@Stability(Stable)
public CfnTermsPropsMixin.Builder links(IResolvable links)

A map of URLs to languages.

For each localized language that will view the requested TermsName , assign a URL. A selection of cognito:default displays 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-terms.html#cfn-cognito-terms-links

termsName

@Stability(Stable)
public CfnTermsPropsMixin.Builder termsName(String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-terms.html#cfn-cognito-terms-termsname

termsSource

@Stability(Stable)
public CfnTermsPropsMixin.Builder termsSource(String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-terms.html#cfn-cognito-terms-termssource

userPoolId

@Stability(Stable)
public CfnTermsPropsMixin.Builder userPoolId(String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-terms.html#cfn-cognito-terms-userpoolid

build

@Stability(Stable)
public CfnTermsPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnTermsPropsMixin.