From ff4ce3f2dcabb791b0f25436a035c455e293930b Mon Sep 17 00:00:00 2001 From: Adam Gloyne <44494964+Gadam8@users.noreply.github.com> Date: Fri, 16 Aug 2024 09:30:41 +0100 Subject: [PATCH] docs: update aws policy statement (#256) Co-authored-by: adam.gloyne --- sns/README.md | 6 ++++-- sqs/README.md | 8 +++++--- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/sns/README.md b/sns/README.md index 4ef43ec5..d4bde58a 100644 --- a/sns/README.md +++ b/sns/README.md @@ -6,7 +6,7 @@ This document defines how to describe SNS-specific information on AsyncAPI. ## Version -Current version is `0.1.0`. +Current version is `0.2.0`. @@ -52,8 +52,10 @@ SNS supports many optional properties. To mark a channel as SNS, but use default |Field Name | Type | Description| |---|:---:|---| | `effect` | string |**Required.** Either "Allow" or "Deny"| -| `principal` | string or array of string |**Required.** The AWS account or resource ARN that this statement applies to| +| `principal` | string or AWS principal property containing a string or string array |**Required.** The AWS account(s) or resource ARN(s) that the statement applies to| | `action` | string or array of string |**Required.** The SNS permission being allowed or denied e.g. sns:Publish| +| `resource` | string or array of string |**Optional.** The resource(s) that this policy applies to| +| `condition` | object or list of objects |**Optional.** Specific circumstances under which the policy grants permission| ##### Examples diff --git a/sqs/README.md b/sqs/README.md index 5f8281ed..b95d81f0 100644 --- a/sqs/README.md +++ b/sqs/README.md @@ -12,7 +12,7 @@ For publish-subscribe scenarios, use as a **publish** Operation Binding Object, ## Version -Current version is `0.2.0`. +Current version is `0.3.0`. @@ -79,8 +79,10 @@ An SQS queue can set up a Dead Letter Queue as part of a Redelivery Policy. To s |Field Name | Type | Description| |---|:---:|---| | `effect` | string |**Required.** Either "Allow" or "Deny"| -| `principal` | string or array of string |**Required.** The AWS account or resource ARN that this statement applies to| -| `action` | string or array of string |**Required.** The SQS permission being allowed or denied e.g. sqs:ReceiveMessage | +| `principal` | string or AWS principal property containing a string or string array |**Required.** The AWS account(s) or resource ARN(s) that the statement applies to| +| `action` | string or array of string |**Required.** The SNS permission being allowed or denied e.g. sns:Publish| +| `resource` | string or array of string |**Optional.** The resource(s) that this policy applies to| +| `condition` | object or list of objects |**Optional.** Specific circumstances under which the policy grants permission|