Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions packages/@aws-cdk/aws-sns-subscriptions/lib/email.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ export class EmailSubscription implements sns.ITopicSubscription {
constructor(private readonly emailAddress: string, private readonly props: EmailSubscriptionProps = {}) {
}

/**
* Returns a configuration for an email address to subscribe to an SNS topic
*/
public bind(_topic: sns.ITopic): sns.TopicSubscriptionConfig {
return {
subscriberId: this.emailAddress,
Expand Down
3 changes: 3 additions & 0 deletions packages/@aws-cdk/aws-sns-subscriptions/lib/lambda.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ export class LambdaSubscription implements sns.ITopicSubscription {
constructor(private readonly fn: lambda.IFunction, private readonly props: LambdaSubscriptionProps = {}) {
}

/**
* Returns a configuration for a Lambda function to subscribe to an SNS topic
*/
public bind(topic: sns.ITopic): sns.TopicSubscriptionConfig {
// Create subscription under *consuming* construct to make sure it ends up
// in the correct stack in cases of cross-stack subscriptions.
Expand Down
3 changes: 3 additions & 0 deletions packages/@aws-cdk/aws-sns-subscriptions/lib/sqs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ export class SqsSubscription implements sns.ITopicSubscription {
constructor(private readonly queue: sqs.IQueue, private readonly props: SqsSubscriptionProps = {}) {
}

/**
* Returns a configuration for an SQS queue to subscribe to an SNS topic
*/
public bind(topic: sns.ITopic): sns.TopicSubscriptionConfig {
// Create subscription under *consuming* construct to make sure it ends up
// in the correct stack in cases of cross-stack subscriptions.
Expand Down
3 changes: 3 additions & 0 deletions packages/@aws-cdk/aws-sns-subscriptions/lib/subscription.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
import * as sns from '@aws-cdk/aws-sns';

/**
* Options to subscribing to an SNS topic
*/
export interface SubscriptionProps {
/**
* The filter policy.
Expand Down
3 changes: 3 additions & 0 deletions packages/@aws-cdk/aws-sns-subscriptions/lib/url.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ export class UrlSubscription implements sns.ITopicSubscription {
}
}

/**
* Returns a configuration for a URL to subscribe to an SNS topic
*/
public bind(_topic: sns.ITopic): sns.TopicSubscriptionConfig {
return {
subscriberId: this.url,
Expand Down
9 changes: 0 additions & 9 deletions packages/@aws-cdk/aws-sns-subscriptions/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -104,15 +104,6 @@
"node": ">= 10.13.0"
},
"stability": "stable",
"awslint": {
"exclude": [
"docs-public-apis:@aws-cdk/aws-sns-subscriptions.EmailSubscription.bind",
"docs-public-apis:@aws-cdk/aws-sns-subscriptions.LambdaSubscription.bind",
"docs-public-apis:@aws-cdk/aws-sns-subscriptions.SqsSubscription.bind",
"docs-public-apis:@aws-cdk/aws-sns-subscriptions.UrlSubscription.bind",
"docs-public-apis:@aws-cdk/aws-sns-subscriptions.SubscriptionProps"
]
},
"awscdkio": {
"announce": false
},
Expand Down