CfnTermsProps

class aws_cdk.aws_cognito.CfnTermsProps(*, enforcement, links, terms_name, terms_source, user_pool_id, client_id=None)

Bases: object

Properties for defining a CfnTerms.

Parameters:

  • enforcement (str) – This parameter is reserved for future use and currently accepts one value.

  • links (Union[Mapping[str, str], 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" .

  • terms_name (str) – The type and friendly name of the terms documents.

  • terms_source (str) – This parameter is reserved for future use and currently accepts one value.

  • user_pool_id (str) – The ID of the user pool that contains the terms documents.

  • client_id (Optional[str]) – The ID of the app client that the terms documents are assigned to.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cognito as cognito

cfn_terms_props = cognito.CfnTermsProps(
    enforcement="enforcement",
    links={
        "links_key": "links"
    },
    terms_name="termsName",
    terms_source="termsSource",
    user_pool_id="userPoolId",

    # the properties below are optional
    client_id="clientId"
)

Attributes

client_id

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

See:

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

enforcement

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

See:

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

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:

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

terms_name

The type and friendly name of the terms documents.

See:

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

terms_source

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

See:

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

user_pool_id

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

See:

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