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

Class CfnTermsPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.cognito.CfnTermsPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-02T09:31:53.957Z")
@Stability(Stable)
public class CfnTermsPropsMixin
extends Mixin
implements software.constructs.IMixin

Creates terms documents for the requested app client.

When Terms and conditions and Privacy policy documents are configured, the app client displays links to them in the sign-up page of managed login for the app client.

You can provide URLs for terms documents in the languages that are supported by managed login localization . Amazon Cognito directs users to the terms documents for their current language, with fallback to default if no document exists for the language.

Each request accepts one type of terms document and a map of language-to-link for that document type. You must provide both types of terms documents in at least one language before Amazon Cognito displays your terms documents. Supply each type in separate requests.

For more information, see Terms documents .

Amazon Cognito evaluates AWS Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more - Signing AWS API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

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.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnTermsPropsMixin cfnTermsPropsMixin = CfnTermsPropsMixin.Builder.create(CfnTermsMixinProps.builder()
         .clientId("clientId")
         .enforcement("enforcement")
         .links(Map.of(
                 "linksKey", "links"))
         .termsName("termsName")
         .termsSource("termsSource")
         .userPoolId("userPoolId")
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnTermsPropsMixin.Builder	A fluent builder for CfnTermsPropsMixin.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnTermsPropsMixin(CfnTermsMixinProps props)	Create a mixin to apply properties to AWS::Cognito::Terms.
	CfnTermsPropsMixin(CfnTermsMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Cognito::Terms.
protected	CfnTermsPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTermsPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnTermsMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnTermsPropsMixin

protected CfnTermsPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnTermsPropsMixin

protected CfnTermsPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnTermsPropsMixin

@Stability(Stable)
public CfnTermsPropsMixin(@NotNull
 CfnTermsMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Cognito::Terms.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnTermsPropsMixin

@Stability(Stable)
public CfnTermsPropsMixin(@NotNull
 CfnTermsMixinProps props)

Create a mixin to apply properties to AWS::Cognito::Terms.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnTermsMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()