Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add comments to examples in README.md #2

Merged
merged 1 commit into from
Feb 5, 2019
Merged

Add comments to examples in README.md #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ plugins:

custom:
CognitoAddCustomAttributes:
CognitoUserPoolIdOutputKey: "CognitoUserPoolApplicationUserPoolId"
CognitoUserPoolClientIdOutputKey: "CognitoUserPoolApplicationUserPoolClientId"
CognitoUserPoolIdOutputKey: "CognitoUserPoolApplicationUserPoolId" # The key of the outputted UserPool Ref
CognitoUserPoolClientIdOutputKey: "CognitoUserPoolApplicationUserPoolClientId" # The key of the outputted UserPoolClient Ref
CustomAttributes:
-
AttributeDataType: String
Expand All @@ -30,6 +30,7 @@ custom:
Name: "another" # this will end up being custom:another
Required: False

# Only add this if not already outputting the Cognito User Pool and Client IDs, otherwise, refer to the existing outputs in the custom:CognitoAddCustomAttributes section
resources:
Outputs:
CognitoUserPoolApplicationUserPoolId:
Expand Down Expand Up @@ -60,4 +61,4 @@ resources:
The names of your attributes supplied here will appear as `custom:{name}` when deployed.

For more information on the schema of attributes see:
https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SchemaAttributeType.html
https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SchemaAttributeType.html