From 455b08168f2b6f035a1ca9d08411b370a83fe5a5 Mon Sep 17 00:00:00 2001 From: esbenvb Date: Mon, 24 Sep 2018 16:05:22 +0200 Subject: [PATCH] Add comments to examples in README.md --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 298d99d..8f94ae4 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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: @@ -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 \ No newline at end of file +https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SchemaAttributeType.html