AWS::Cognito::TermsCfnTerms
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](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#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](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-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](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) > - [Using the Amazon Cognito user pools API and user pool endpoints](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)
Import
import { CfnTerms } from 'aws-cdk-lib/aws-cognito';Or use the module namespace:
import * as cognito from 'aws-cdk-lib/aws-cognito';
// cognito.CfnTermsProperties
Configuration passed to the constructor as CfnTermsProps.
enforcementRequiredstringThis parameter is reserved for future use and currently accepts one value.
linksRequired{ [key: string]: string } | IResolvableA 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"` .
termsNameRequiredstringThe type and friendly name of the terms documents.
termsSourceRequiredstringThis parameter is reserved for future use and currently accepts one value.
userPoolIdRequiredstringThe ID of the user pool that contains the terms documents.
clientIdOptionalstringThe ID of the app client that the terms documents are assigned to.
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Get the Amazon Cognito Cheat Sheet
Everything you need to know about Amazon Cognito on one page. HD quality, print-friendly.
Download Free InfographicQuick Facts
aws-cognitoAWS::Cognito::Terms