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.119.0 (build 1634eac)",
           date="2025-11-13T16:10:01.485Z")
@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()
String	getEnforcement()
Object	getLinks()	Returns union: either Mapinvalid input: '<'String, String> or IResolvable
String	getTermsName()
String	getTermsSource()
String	getUserPoolId()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnforcement

@Stability(Stable)
@NotNull
String getEnforcement()

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()

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()

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()

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()

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()

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