class CfnTermsPropsMixin

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

Implements IMixin

Extends Mixin

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

• Using the Amazon Cognito user pools API and user pool endpoints

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 } from '@aws-cdk/mixins-preview';
import { mixins as cognito_mixins } from '@aws-cdk/mixins-preview/aws-cognito';
const cfnTermsPropsMixin = new cognito_mixins.CfnTermsPropsMixin({
  clientId: 'clientId',
  enforcement: 'enforcement',
  links: {
    linksKey: 'links',
  },
  termsName: 'termsName',
  termsSource: 'termsSource',
  userPoolId: 'userPoolId',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnTermsPropsMixin(props: CfnTermsMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnTermsMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Cognito::Terms.

Properties

Name	Type	Description
props	CfnTermsMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnTermsMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.