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

Interface CfnTermsMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTermsMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-02T21:55:25.259Z")
@Stability(Stable)
public interface CfnTermsMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnTermsPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.cognito.*;
 CfnTermsMixinProps cfnTermsMixinProps = CfnTermsMixinProps.builder()
         .clientId("clientId")
         .enforcement("enforcement")
         .links(Map.of(
                 "linksKey", "links"))
         .termsName("termsName")
         .termsSource("termsSource")
         .userPoolId("userPoolId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTermsMixinProps.Builder	A builder for CfnTermsMixinProps
static final class	CfnTermsMixinProps.Jsii$Proxy	An implementation for CfnTermsMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnTermsMixinProps.Builder	builder()
default String	getClientId()	The ID of the app client that the terms documents are assigned to.
default String	getEnforcement()	This parameter is reserved for future use and currently accepts one value.
default Object	getLinks()	A map of URLs to languages.
default String	getTermsName()	The type and friendly name of the terms documents.
default String	getTermsSource()	This parameter is reserved for future use and currently accepts one value.
default String	getUserPoolId()	The ID of the user pool that contains the terms documents.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClientId

@Stability(Stable)
@Nullable
default String getClientId()

The ID of the app client that the terms documents are assigned to.

See Also:

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

getEnforcement

@Stability(Stable)
@Nullable
default String getEnforcement()

This parameter is reserved for future use and currently accepts one value.

See Also:

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

getLinks

@Stability(Stable)
@Nullable
default Object getLinks()

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" .

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

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

getTermsName

@Stability(Stable)
@Nullable
default String getTermsName()

The type and friendly name of the terms documents.

See Also:

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

getTermsSource

@Stability(Stable)
@Nullable
default String getTermsSource()

This parameter is reserved for future use and currently accepts one value.

See Also:

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

getUserPoolId

@Stability(Stable)
@Nullable
default String getUserPoolId()

The ID of the user pool that contains the terms documents.

See Also:

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

builder

@Stability(Stable)
static CfnTermsMixinProps.Builder builder()

Returns:

a CfnTermsMixinProps.Builder of CfnTermsMixinProps