interface CfnTermsMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Cognito.Mixins.CfnTermsMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscognito/mixins#CfnTermsMixinProps
Java	software.amazon.awscdk.mixins.preview.services.cognito.mixins.CfnTermsMixinProps
Python	aws_cdk.mixins_preview.aws_cognito.mixins.CfnTermsMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_cognito » mixins » CfnTermsMixinProps

Properties for CfnTermsPropsMixin.

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 { mixins as cognito_mixins } from '@aws-cdk/mixins-preview/aws-cognito';
const cfnTermsMixinProps: cognito_mixins.CfnTermsMixinProps = {
  clientId: 'clientId',
  enforcement: 'enforcement',
  links: {
    linksKey: 'links',
  },
  termsName: 'termsName',
  termsSource: 'termsSource',
  userPoolId: 'userPoolId',
};

Properties

Name	Type	Description
clientId?	string	The ID of the app client that the terms documents are assigned to.
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?

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

---

enforcement?

Type: string (optional)

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

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

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

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

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