interface CfnTermsProps

Language	Type name
.NET	Amazon.CDK.AWS.Cognito.CfnTermsProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnTermsProps
Java	software.amazon.awscdk.services.cognito.CfnTermsProps
Python	aws_cdk.aws_cognito.CfnTermsProps
TypeScript	aws-cdk-lib » aws_cognito » CfnTermsProps

Properties for defining a CfnTerms.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const cfnTermsProps: cognito.CfnTermsProps = {
  enforcement: 'enforcement',
  links: {
    linksKey: 'links',
  },
  termsName: 'termsName',
  termsSource: 'termsSource',
  userPoolId: 'userPoolId',

  // the properties below are optional
  clientId: 'clientId',
};

Properties

Name	Type	Description
enforcement	string	This parameter is reserved for future use and currently accepts one value.
links	{ [string]: string } | IResolvable	A map of URLs to languages.
termsName	string	The type and friendly name of the terms documents.
termsSource	string	This parameter is reserved for future use and currently accepts one value.
userPoolId	string	The ID of the user pool that contains the terms documents.
clientId?	string	The ID of the app client that the terms documents are assigned to.

---

enforcement

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-terms.html#cfn-cognito-terms-enforcement

---

links

Type: { [string]: string } | IResolvable

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-terms.html#cfn-cognito-terms-links

---

termsName

Type: string

The type and friendly name of the terms documents.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-terms.html#cfn-cognito-terms-termsname

---

termsSource

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-terms.html#cfn-cognito-terms-termssource

---

userPoolId

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-terms.html#cfn-cognito-terms-userpoolid

---

clientId?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-terms.html#cfn-cognito-terms-clientid