Package software.amazon.awscdk.services.cognito

Class CfnTerms.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.CfnTerms.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTerms>

Enclosing class:

CfnTerms

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

A fluent builder for CfnTerms.

Method Summary

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

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnTerms.Builder.

enforcement

@Stability(Stable)
public CfnTerms.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 CfnTerms.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 CfnTerms.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 CfnTerms.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 CfnTerms.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 CfnTerms.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

clientId

@Stability(Stable)
public CfnTerms.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

build

@Stability(Stable)
public CfnTerms build()

Specified by:

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

Returns:

a newly built instance of CfnTerms.