class TopicGrants

Language	Type name
.NET	Amazon.CDK.AWS.SNS.TopicGrants
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssns#TopicGrants
Java	software.amazon.awscdk.services.sns.TopicGrants
Python	aws_cdk.aws_sns.TopicGrants
TypeScript	aws-cdk-lib » aws_sns » TopicGrants

Collection of grant methods for a ITopicRef.

Example

const topic = new sns.Topic(this, 'Topic');

// This would work the same way if topic was a CfnTopic (L1)
sns.TopicGrants.fromTopic(topic).subscribe(new iam.AnyPrincipal());

Properties

Name	Type	Description
resource	ITopicRef
encryptedResource?	IEncryptedResource
policyResource?	IResourceWithPolicyV2

---

resource

Type: ITopicRef

---

encryptedResource?

Type: IEncryptedResource (optional)

---

policyResource?

Type: IResourceWithPolicyV2 (optional)

Methods

Name	Description
actions(grantee, actions, options?)	Grant the given identity custom permissions.
publish(grantee)	Grant topic publishing permissions to the given identity.
subscribe(grantee)	Grant topic subscribing permissions to the given identity.
static fromTopic(resource)	Creates grants for TopicGrants.

---

actions(grantee, actions, options?)

public actions(grantee: IGrantable, actions: string[], options?: EncryptedPermissionsOptions): Grant

Parameters

• grantee IGrantable
• actions string[]
• options EncryptedPermissionsOptions

Returns

• Grant

Grant the given identity custom permissions.

---

publish(grantee)

public publish(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

Grant topic publishing permissions to the given identity.

---

subscribe(grantee)

public subscribe(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

Grant topic subscribing permissions to the given identity.

---

static fromTopic(resource)

public static fromTopic(resource: ITopicRef): TopicGrants

Parameters

• resource ITopicRef

Returns

• TopicGrants

Creates grants for TopicGrants.