aws-cdk-lib.aws_events_targets.SnsTopic

class SnsTopic

LanguageType name
.NETAmazon.CDK.AWS.Events.Targets.SnsTopic
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awseventstargets#SnsTopic
Javasoftware.amazon.awscdk.services.events.targets.SnsTopic
Pythonaws_cdk.aws_events_targets.SnsTopic
TypeScript (source)aws-cdk-lib » aws_events_targets » SnsTopic

Implements IRuleTarget

Use an SNS topic as a target for Amazon EventBridge rules.

Example

  /// fixture=withRepoAndTopic
  // publish to an SNS topic every time code is committed
  // to a CodeCommit repository
  repository.onCommit('onCommit', { target: new targets.SnsTopic(topic) });

Initializer

new SnsTopic(topic: ITopic, props?: SnsTopicProps)

Parameters

  • topic ITopic
  • props SnsTopicProps

Properties

NameTypeDescription
topicITopic

topic

Type: ITopic

Methods

NameDescription
bind(_rule, _id?)Returns a RuleTarget that can be used to trigger this SNS topic as a result from an EventBridge event.

bind(_rule, _id?)

public bind(_rule: IRule, _id?: string): RuleTargetConfig

Parameters

  • _rule IRule
  • _id string

Returns

  • RuleTargetConfig

Returns a RuleTarget that can be used to trigger this SNS topic as a result from an EventBridge event.

See also: https://docs.aws.amazon.com/eventbridge/latest/userguide/resource-based-policies-eventbridge.html#sns-permissions