Package software.amazon.awscdk.services.cognito

Interface CfnTermsProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTermsProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-08T14:57:02.408Z")
@Stability(Stable)
public interface CfnTermsProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnTerms.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 CfnTermsProps cfnTermsProps = CfnTermsProps.builder()
         .enforcement("enforcement")
         .links(Map.of(
                 "linksKey", "links"))
         .termsName("termsName")
         .termsSource("termsSource")
         .userPoolId("userPoolId")
         // the properties below are optional
         .clientId("clientId")
         .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	CfnTermsProps.Builder	A builder for CfnTermsProps
static final class	CfnTermsProps.Jsii$Proxy	An implementation for CfnTermsProps

Method Summary

Modifier and Type	Method	Description
static CfnTermsProps.Builder	builder()
default String	getClientId()	The ID of the app client that the terms documents are assigned to.
String	getEnforcement()	This parameter is reserved for future use and currently accepts one value.
Object	getLinks()	A map of URLs to languages.
String	getTermsName()	The type and friendly name of the terms documents.
String	getTermsSource()	This parameter is reserved for future use and currently accepts one value.
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

getEnforcement

@Stability(Stable)
@NotNull
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)
@NotNull
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)
@NotNull
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)
@NotNull
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)
@NotNull
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

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

builder

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

Returns:

a CfnTermsProps.Builder of CfnTermsProps