Skip to content

docs(sns): add IAM action details to grantPublish and grantSubscribe #37326

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

Closed
syukawa-gh wants to merge 1 commit into from
+16 −4
Closed

docs(sns): add IAM action details to grantPublish and grantSubscribe #37326

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
20 changes: 16 additions & 4 deletions packages/aws-cdk-lib/aws-sns/lib/topic-base.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,18 @@ export interface ITopic extends IResource, notifications.INotificationRuleTarget
addToResourcePolicy(statement: iam.PolicyStatement): iam.AddToResourcePolicyResult;

/**
* Grant topic publishing permissions to the given identity
* Grant topic publishing permissions to the given identity.
*
* This grants the `sns:Publish` action on this topic. If the topic is encrypted
* with a customer-managed KMS key, it also grants `kms:Decrypt` and
* `kms:GenerateDataKey*` on the key.
*/
grantPublish(identity: iam.IGrantable): iam.Grant;

/**
* Grant topic subscribing permissions to the given identity
* Grant topic subscribing permissions to the given identity.
*
* This grants the `sns:Subscribe` action on this topic.
*/
grantSubscribe(identity: iam.IGrantable): iam.Grant;
}
Expand Down Expand Up @@ -224,7 +230,11 @@ export abstract class TopicBase extends Resource implements ITopic, IEncryptedRe
}

/**
* Grant topic publishing permissions to the given identity
* Grant topic publishing permissions to the given identity.
*
* This grants the `sns:Publish` action on this topic. If the topic is encrypted
* with a customer-managed KMS key, it also grants `kms:Decrypt` and
* `kms:GenerateDataKey*` on the key.
*
* The use of this method is discouraged. Please use `grants.publish()` instead.
*
Expand All @@ -235,7 +245,9 @@ export abstract class TopicBase extends Resource implements ITopic, IEncryptedRe
}

/**
* Grant topic subscribing permissions to the given identity
* Grant topic subscribing permissions to the given identity.
*
* This grants the `sns:Subscribe` action on this topic.
*
* The use of this method is discouraged. Please use `grants.subscribe()` instead.
*
Expand Down
Loading