AWS::Cognito::Terms - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Cognito::Terms

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.

Note

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

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Cognito::Terms",
  "Properties" : {
      "ClientId" : String,
      "Enforcement" : String,
      "Links" : {Key: Value, ...},
      "TermsName" : String,
      "TermsSource" : String,
      "UserPoolId" : String
    }
}

YAML

Type: AWS::Cognito::Terms
Properties:
  ClientId: String
  Enforcement: String
  Links: 
    Key: Value
  TermsName: String
  TermsSource: String
  UserPoolId: String

Properties

ClientId

The ID of the app client that the terms documents are assigned to.

Required: No

Type: String

Pattern: [\w+]+

Minimum: 1

Maximum: 128

Update requires: Replacement

Enforcement

This parameter is reserved for future use and currently accepts one value.

Required: Yes

Type: String

Allowed values: NONE

Update requires: No interruption

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".

Required: Yes

Type: Object of String

Pattern: ^cognito:(default|english|french|spanish|german|bahasa-indonesia|italian|japanese|korean|portuguese-brazil|chinese-(simplified|traditional))$

Minimum: 1

Maximum: 1024

Update requires: No interruption

TermsName

The type and friendly name of the terms documents.

Required: Yes

Type: String

Pattern: ^(terms-of-use|privacy-policy)$

Update requires: No interruption

TermsSource

This parameter is reserved for future use and currently accepts one value.

Required: Yes

Type: String

Allowed values: LINK

Update requires: No interruption

UserPoolId

The ID of the user pool that contains the terms documents.

Required: Yes

Type: String

Pattern: [\w-]+_[0-9a-zA-Z]+

Minimum: 1

Maximum: 55

Update requires: Replacement

Return values

Ref

Fn::GetAtt

TermsId

The ID of the terms documents.