AWS Fundamentals Logo
AWS Fundamentals
AWS::Cognito::Terms

Cognito Terms

Resource Type definition for AWS::Cognito::Terms

Properties

6 configurable properties. 5 required. Click a row to see details.

Filter:
PropertyTypeFlags
Enforcement
string
Required
Links
LinksType
Required
TermsName
string
Required
TermsSource
string
Required
UserPoolId
string
RequiredCreate-only
ClientId
string
Create-onlyWrite-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
TermsIdstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Cognito::Terms

Resources:
  MyResource:
    Type: AWS::Cognito::Terms
    Properties:
      UserPoolId: "my-userpoolid"
      TermsName: "my-termsname"
      TermsSource: "value"
      Enforcement: "value"
      Links: "value"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

cognito-idp:CreateTerms

read

cognito-idp:DescribeTerms

update

cognito-idp:UpdateTerms

delete

cognito-idp:DeleteTerms

list

cognito-idp:ListTerms

Get the Cognito Cheat Sheet

Everything you need to know about Cognito on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceCognito
Properties7
Required5
TaggingNot supported
Primary IDUserPoolId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

UserPoolIdClientId

Related Resources

External Links