Package software.amazon.awscdk.services.cognito

Class CfnTerms

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cognito.CfnTerms
All Implemented Interfaces:
IInspectable, ITermsRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:07.401Z") @Stability(Stable) public class CfnTerms extends CfnResource implements IInspectable, ITermsRef
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

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.*;
 CfnTerms cfnTerms = CfnTerms.Builder.create(this, "MyCfnTerms")
         .enforcement("enforcement")
         .links(Map.of(
                 "linksKey", "links"))
         .termsName("termsName")
         .termsSource("termsSource")
         .userPoolId("userPoolId")
         // the properties below are optional
         .clientId("clientId")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnTerms

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

    • CfnTerms

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

    • CfnTerms

      @Stability(Stable) public CfnTerms(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnTermsProps props)
      Create a new AWS::Cognito::Terms.

      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.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnTerms

      @Stability(Stable) @NotNull public static Boolean isCfnTerms(@NotNull Object x)
      Checks whether the given object is a CfnTerms.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrTermsId

      @Stability(Stable) @NotNull public String getAttrTermsId()
      The ID of the terms documents.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTermsRef

      @Stability(Stable) @NotNull public TermsReference getTermsRef()
      A reference to a Terms resource.
      Specified by:
      getTermsRef in interface ITermsRef

    • getEnforcement

      @Stability(Stable) @NotNull public String getEnforcement()
      This parameter is reserved for future use and currently accepts one value.

    • setEnforcement

      @Stability(Stable) public void setEnforcement(@NotNull String value)
      This parameter is reserved for future use and currently accepts one value.

    • getLinks

      @Stability(Stable) @NotNull public Object getLinks()
      A map of URLs to languages.

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

    • setLinks

      @Stability(Stable) public void setLinks(@NotNull Map<String,String> value)
      A map of URLs to languages.

    • setLinks

      @Stability(Stable) public void setLinks(@NotNull IResolvable value)
      A map of URLs to languages.

    • getTermsName

      @Stability(Stable) @NotNull public String getTermsName()
      The type and friendly name of the terms documents.

    • setTermsName

      @Stability(Stable) public void setTermsName(@NotNull String value)
      The type and friendly name of the terms documents.

    • getTermsSource

      @Stability(Stable) @NotNull public String getTermsSource()
      This parameter is reserved for future use and currently accepts one value.

    • setTermsSource

      @Stability(Stable) public void setTermsSource(@NotNull String value)
      This parameter is reserved for future use and currently accepts one value.

    • getUserPoolId

      @Stability(Stable) @NotNull public String getUserPoolId()
      The ID of the user pool that contains the terms documents.

    • setUserPoolId

      @Stability(Stable) public void setUserPoolId(@NotNull String value)
      The ID of the user pool that contains the terms documents.

    • getClientId

      @Stability(Stable) @Nullable public String getClientId()
      The ID of the app client that the terms documents are assigned to.

    • setClientId

      @Stability(Stable) public void setClientId(@Nullable String value)
      The ID of the app client that the terms documents are assigned to.