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)

  • links (Union[Mapping[str, str], IResolvable])

  • terms_name (str)

  • terms_source (str)

  • user_pool_id (str)

  • client_id (Optional[str])

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

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

Type:

see

enforcement

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

Type:

see

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

Type:

see

terms_name

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

Type:

see

terms_source

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

Type:

see

user_pool_id

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

Type:

see