UNPKG

31.1 kBTypeScriptView Raw
1import * as cdk from '@aws-cdk/core';
2import * as cfn_parse from '@aws-cdk/core/lib/helpers-internal';
3/**
4 * Properties for defining a `CfnSubscription`
5 *
6 * @struct
7 * @stability external
8 *
9 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html
10 */
11export interface CfnSubscriptionProps {
12 /**
13 * The subscription's protocol. For more information, see the `Protocol` parameter of the `[Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)` action in the *Amazon SNS API Reference* .
14 *
15 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-protocol
16 */
17 readonly protocol: string;
18 /**
19 * The ARN of the topic to subscribe to.
20 *
21 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#topicarn
22 */
23 readonly topicArn: string;
24 /**
25 * The delivery policy JSON assigned to the subscription. Enables the subscriber to define the message delivery retry strategy in the case of an HTTP/S endpoint subscribed to the topic. For more information, see `[GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)` in the *Amazon SNS API Reference* and [Message delivery retries](https://docs.aws.amazon.com/sns/latest/dg/sns-message-delivery-retries.html) in the *Amazon SNS Developer Guide* .
26 *
27 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-deliverypolicy
28 */
29 readonly deliveryPolicy?: any | cdk.IResolvable;
30 /**
31 * The subscription's endpoint. The endpoint value depends on the protocol that you specify. For more information, see the `Endpoint` parameter of the `[Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)` action in the *Amazon SNS API Reference* .
32 *
33 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-endpoint
34 */
35 readonly endpoint?: string;
36 /**
37 * The filter policy JSON assigned to the subscription. Enables the subscriber to filter out unwanted messages. For more information, see `[GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)` in the *Amazon SNS API Reference* and [Message filtering](https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html) in the *Amazon SNS Developer Guide* .
38 *
39 * - `FilterPolicyScope` - This attribute lets you choose the filtering scope by using one of the following string value types:
40 *
41 * - `MessageAttributes` (default) - The filter is applied on the message attributes.
42 * - `MessageBody` - The filter is applied on the message body.
43 *
44 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy
45 */
46 readonly filterPolicy?: any | cdk.IResolvable;
47 /**
48 * `AWS::SNS::Subscription.FilterPolicyScope`
49 *
50 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicyscope
51 */
52 readonly filterPolicyScope?: string;
53 /**
54 * When set to `true` , enables raw message delivery. Raw messages don't contain any JSON formatting and can be sent to Amazon SQS and HTTP/S endpoints. For more information, see `[GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)` in the *Amazon SNS API Reference* .
55 *
56 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-rawmessagedelivery
57 */
58 readonly rawMessageDelivery?: boolean | cdk.IResolvable;
59 /**
60 * When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
61 *
62 * For more information about the redrive policy and dead-letter queues, see [Amazon SQS dead-letter queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) in the *Amazon SQS Developer Guide* .
63 *
64 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-redrivepolicy
65 */
66 readonly redrivePolicy?: any | cdk.IResolvable;
67 /**
68 * For cross-region subscriptions, the region in which the topic resides.
69 *
70 * If no region is specified, AWS CloudFormation uses the region of the caller as the default.
71 *
72 * If you perform an update operation that only updates the `Region` property of a `AWS::SNS::Subscription` resource, that operation will fail unless you are either:
73 *
74 * - Updating the `Region` from `NULL` to the caller region.
75 * - Updating the `Region` from the caller region to `NULL` .
76 *
77 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-region
78 */
79 readonly region?: string;
80 /**
81 * This property applies only to Amazon Kinesis Data Firehose delivery stream subscriptions. Specify the ARN of the IAM role that has the following:
82 *
83 * - Permission to write to the Amazon Kinesis Data Firehose delivery stream
84 * - Amazon SNS listed as a trusted entity
85 *
86 * Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see [Fanout to Amazon Kinesis Data Firehose delivery streams](https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) in the *Amazon SNS Developer Guide.*
87 *
88 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-subscriptionrolearn
89 */
90 readonly subscriptionRoleArn?: string;
91}
92/**
93 * A CloudFormation `AWS::SNS::Subscription`
94 *
95 * The `AWS::SNS::Subscription` resource subscribes an endpoint to an Amazon SNS topic. For a subscription to be created, the owner of the endpoint must confirm the subscription.
96 *
97 * @cloudformationResource AWS::SNS::Subscription
98 * @stability external
99 *
100 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html
101 */
102export declare class CfnSubscription extends cdk.CfnResource implements cdk.IInspectable {
103 /**
104 * The CloudFormation resource type name for this resource class.
105 */
106 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::SNS::Subscription";
107 /**
108 * A factory method that creates a new instance of this class from an object
109 * containing the CloudFormation properties of this resource.
110 * Used in the @aws-cdk/cloudformation-include module.
111 *
112 * @internal
113 */
114 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnSubscription;
115 /**
116 * The subscription's protocol. For more information, see the `Protocol` parameter of the `[Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)` action in the *Amazon SNS API Reference* .
117 *
118 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-protocol
119 */
120 protocol: string;
121 /**
122 * The ARN of the topic to subscribe to.
123 *
124 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#topicarn
125 */
126 topicArn: string;
127 /**
128 * The delivery policy JSON assigned to the subscription. Enables the subscriber to define the message delivery retry strategy in the case of an HTTP/S endpoint subscribed to the topic. For more information, see `[GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)` in the *Amazon SNS API Reference* and [Message delivery retries](https://docs.aws.amazon.com/sns/latest/dg/sns-message-delivery-retries.html) in the *Amazon SNS Developer Guide* .
129 *
130 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-deliverypolicy
131 */
132 deliveryPolicy: any | cdk.IResolvable | undefined;
133 /**
134 * The subscription's endpoint. The endpoint value depends on the protocol that you specify. For more information, see the `Endpoint` parameter of the `[Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)` action in the *Amazon SNS API Reference* .
135 *
136 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-endpoint
137 */
138 endpoint: string | undefined;
139 /**
140 * The filter policy JSON assigned to the subscription. Enables the subscriber to filter out unwanted messages. For more information, see `[GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)` in the *Amazon SNS API Reference* and [Message filtering](https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html) in the *Amazon SNS Developer Guide* .
141 *
142 * - `FilterPolicyScope` - This attribute lets you choose the filtering scope by using one of the following string value types:
143 *
144 * - `MessageAttributes` (default) - The filter is applied on the message attributes.
145 * - `MessageBody` - The filter is applied on the message body.
146 *
147 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy
148 */
149 filterPolicy: any | cdk.IResolvable | undefined;
150 /**
151 * `AWS::SNS::Subscription.FilterPolicyScope`
152 *
153 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicyscope
154 */
155 filterPolicyScope: string | undefined;
156 /**
157 * When set to `true` , enables raw message delivery. Raw messages don't contain any JSON formatting and can be sent to Amazon SQS and HTTP/S endpoints. For more information, see `[GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)` in the *Amazon SNS API Reference* .
158 *
159 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-rawmessagedelivery
160 */
161 rawMessageDelivery: boolean | cdk.IResolvable | undefined;
162 /**
163 * When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
164 *
165 * For more information about the redrive policy and dead-letter queues, see [Amazon SQS dead-letter queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) in the *Amazon SQS Developer Guide* .
166 *
167 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-redrivepolicy
168 */
169 redrivePolicy: any | cdk.IResolvable | undefined;
170 /**
171 * For cross-region subscriptions, the region in which the topic resides.
172 *
173 * If no region is specified, AWS CloudFormation uses the region of the caller as the default.
174 *
175 * If you perform an update operation that only updates the `Region` property of a `AWS::SNS::Subscription` resource, that operation will fail unless you are either:
176 *
177 * - Updating the `Region` from `NULL` to the caller region.
178 * - Updating the `Region` from the caller region to `NULL` .
179 *
180 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-region
181 */
182 region: string | undefined;
183 /**
184 * This property applies only to Amazon Kinesis Data Firehose delivery stream subscriptions. Specify the ARN of the IAM role that has the following:
185 *
186 * - Permission to write to the Amazon Kinesis Data Firehose delivery stream
187 * - Amazon SNS listed as a trusted entity
188 *
189 * Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see [Fanout to Amazon Kinesis Data Firehose delivery streams](https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) in the *Amazon SNS Developer Guide.*
190 *
191 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-subscriptionrolearn
192 */
193 subscriptionRoleArn: string | undefined;
194 /**
195 * Create a new `AWS::SNS::Subscription`.
196 *
197 * @param scope - scope in which this resource is defined
198 * @param id - scoped id of the resource
199 * @param props - resource properties
200 */
201 constructor(scope: cdk.Construct, id: string, props: CfnSubscriptionProps);
202 /**
203 * Examines the CloudFormation resource and discloses attributes.
204 *
205 * @param inspector - tree inspector to collect and process attributes
206 *
207 */
208 inspect(inspector: cdk.TreeInspector): void;
209 protected get cfnProperties(): {
210 [key: string]: any;
211 };
212 protected renderProperties(props: {
213 [key: string]: any;
214 }): {
215 [key: string]: any;
216 };
217}
218/**
219 * Properties for defining a `CfnTopic`
220 *
221 * @struct
222 * @stability external
223 *
224 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html
225 */
226export interface CfnTopicProps {
227 /**
228 * Enables content-based deduplication for FIFO topics.
229 *
230 * - By default, `ContentBasedDeduplication` is set to `false` . If you create a FIFO topic and this attribute is `false` , you must specify a value for the `MessageDeduplicationId` parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action.
231 * - When you set `ContentBasedDeduplication` to `true` , Amazon SNS uses a SHA-256 hash to generate the `MessageDeduplicationId` using the body of the message (but not the attributes of the message).
232 *
233 * (Optional) To override the generated value, you can specify a value for the the `MessageDeduplicationId` parameter for the `Publish` action.
234 *
235 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-contentbaseddeduplication
236 */
237 readonly contentBasedDeduplication?: boolean | cdk.IResolvable;
238 /**
239 * The body of the policy document you want to use for this topic.
240 *
241 * You can only add one policy per topic.
242 *
243 * The policy must be in JSON string format.
244 *
245 * Length Constraints: Maximum length of 30,720.
246 *
247 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-dataprotectionpolicy
248 */
249 readonly dataProtectionPolicy?: any | cdk.IResolvable;
250 /**
251 * The display name to use for an Amazon SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.
252 *
253 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-displayname
254 */
255 readonly displayName?: string;
256 /**
257 * Set to true to create a FIFO topic.
258 *
259 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-fifotopic
260 */
261 readonly fifoTopic?: boolean | cdk.IResolvable;
262 /**
263 * The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms) . For more examples, see `[KeyId](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters)` in the *AWS Key Management Service API Reference* .
264 *
265 * This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html) .
266 *
267 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-kmsmasterkeyid
268 */
269 readonly kmsMasterKeyId?: string;
270 /**
271 * `AWS::SNS::Topic.SignatureVersion`
272 *
273 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-signatureversion
274 */
275 readonly signatureVersion?: string;
276 /**
277 * The Amazon SNS subscriptions (endpoints) for this topic.
278 *
279 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-subscription
280 */
281 readonly subscription?: Array<CfnTopic.SubscriptionProperty | cdk.IResolvable> | cdk.IResolvable;
282 /**
283 * The list of tags to add to a new topic.
284 *
285 * > To be able to tag a topic on creation, you must have the `sns:CreateTopic` and `sns:TagResource` permissions.
286 *
287 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-tags
288 */
289 readonly tags?: cdk.CfnTag[];
290 /**
291 * The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with `.fifo` .
292 *
293 * If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .
294 *
295 * > If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
296 *
297 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-topicname
298 */
299 readonly topicName?: string;
300}
301/**
302 * A CloudFormation `AWS::SNS::Topic`
303 *
304 * The `AWS::SNS::Topic` resource creates a topic to which notifications can be published.
305 *
306 * > One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [Amazon SNS endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *AWS General Reference* .
307 *
308 * @cloudformationResource AWS::SNS::Topic
309 * @stability external
310 *
311 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html
312 */
313export declare class CfnTopic extends cdk.CfnResource implements cdk.IInspectable {
314 /**
315 * The CloudFormation resource type name for this resource class.
316 */
317 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::SNS::Topic";
318 /**
319 * A factory method that creates a new instance of this class from an object
320 * containing the CloudFormation properties of this resource.
321 * Used in the @aws-cdk/cloudformation-include module.
322 *
323 * @internal
324 */
325 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnTopic;
326 /**
327 * Returns the ARN of an Amazon SNS topic.
328 * @cloudformationAttribute TopicArn
329 */
330 readonly attrTopicArn: string;
331 /**
332 * Returns the name of an Amazon SNS topic.
333 * @cloudformationAttribute TopicName
334 */
335 readonly attrTopicName: string;
336 /**
337 * Enables content-based deduplication for FIFO topics.
338 *
339 * - By default, `ContentBasedDeduplication` is set to `false` . If you create a FIFO topic and this attribute is `false` , you must specify a value for the `MessageDeduplicationId` parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action.
340 * - When you set `ContentBasedDeduplication` to `true` , Amazon SNS uses a SHA-256 hash to generate the `MessageDeduplicationId` using the body of the message (but not the attributes of the message).
341 *
342 * (Optional) To override the generated value, you can specify a value for the the `MessageDeduplicationId` parameter for the `Publish` action.
343 *
344 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-contentbaseddeduplication
345 */
346 contentBasedDeduplication: boolean | cdk.IResolvable | undefined;
347 /**
348 * The body of the policy document you want to use for this topic.
349 *
350 * You can only add one policy per topic.
351 *
352 * The policy must be in JSON string format.
353 *
354 * Length Constraints: Maximum length of 30,720.
355 *
356 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-dataprotectionpolicy
357 */
358 dataProtectionPolicy: any | cdk.IResolvable | undefined;
359 /**
360 * The display name to use for an Amazon SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.
361 *
362 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-displayname
363 */
364 displayName: string | undefined;
365 /**
366 * Set to true to create a FIFO topic.
367 *
368 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-fifotopic
369 */
370 fifoTopic: boolean | cdk.IResolvable | undefined;
371 /**
372 * The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms) . For more examples, see `[KeyId](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters)` in the *AWS Key Management Service API Reference* .
373 *
374 * This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html) .
375 *
376 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-kmsmasterkeyid
377 */
378 kmsMasterKeyId: string | undefined;
379 /**
380 * `AWS::SNS::Topic.SignatureVersion`
381 *
382 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-signatureversion
383 */
384 signatureVersion: string | undefined;
385 /**
386 * The Amazon SNS subscriptions (endpoints) for this topic.
387 *
388 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-subscription
389 */
390 subscription: Array<CfnTopic.SubscriptionProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
391 /**
392 * The list of tags to add to a new topic.
393 *
394 * > To be able to tag a topic on creation, you must have the `sns:CreateTopic` and `sns:TagResource` permissions.
395 *
396 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-tags
397 */
398 readonly tags: cdk.TagManager;
399 /**
400 * The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with `.fifo` .
401 *
402 * If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .
403 *
404 * > If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
405 *
406 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-topicname
407 */
408 topicName: string | undefined;
409 /**
410 * Create a new `AWS::SNS::Topic`.
411 *
412 * @param scope - scope in which this resource is defined
413 * @param id - scoped id of the resource
414 * @param props - resource properties
415 */
416 constructor(scope: cdk.Construct, id: string, props?: CfnTopicProps);
417 /**
418 * Examines the CloudFormation resource and discloses attributes.
419 *
420 * @param inspector - tree inspector to collect and process attributes
421 *
422 */
423 inspect(inspector: cdk.TreeInspector): void;
424 protected get cfnProperties(): {
425 [key: string]: any;
426 };
427 protected renderProperties(props: {
428 [key: string]: any;
429 }): {
430 [key: string]: any;
431 };
432}
433export declare namespace CfnTopic {
434 /**
435 * `Subscription` is an embedded property that describes the subscription endpoints of an Amazon SNS topic.
436 *
437 * > For full control over subscription behavior (for example, delivery policy, filtering, raw message delivery, and cross-region subscriptions), use the [AWS::SNS::Subscription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html) resource.
438 *
439 * @struct
440 * @stability external
441 *
442 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-subscription.html
443 */
444 interface SubscriptionProperty {
445 /**
446 * The endpoint that receives notifications from the Amazon SNS topic. The endpoint value depends on the protocol that you specify. For more information, see the `Endpoint` parameter of the `[Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)` action in the *Amazon SNS API Reference* .
447 *
448 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-subscription.html#cfn-sns-topic-subscription-endpoint
449 */
450 readonly endpoint: string;
451 /**
452 * The subscription's protocol. For more information, see the `Protocol` parameter of the `[Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)` action in the *Amazon SNS API Reference* .
453 *
454 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-subscription.html#cfn-sns-topic-subscription-protocol
455 */
456 readonly protocol: string;
457 }
458}
459/**
460 * Properties for defining a `CfnTopicPolicy`
461 *
462 * @struct
463 * @stability external
464 *
465 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html
466 */
467export interface CfnTopicPolicyProps {
468 /**
469 * A policy document that contains permissions to add to the specified SNS topics.
470 *
471 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html#cfn-sns-topicpolicy-policydocument
472 */
473 readonly policyDocument: any | cdk.IResolvable;
474 /**
475 * The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the `[Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)` function to specify an `[AWS::SNS::Topic](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html)` resource.
476 *
477 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html#cfn-sns-topicpolicy-topics
478 */
479 readonly topics: string[];
480}
481/**
482 * A CloudFormation `AWS::SNS::TopicPolicy`
483 *
484 * The `AWS::SNS::TopicPolicy` resource associates Amazon SNS topics with a policy. For an example snippet, see [Declaring an Amazon SNS policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-sns-policy) in the *AWS CloudFormation User Guide* .
485 *
486 * @cloudformationResource AWS::SNS::TopicPolicy
487 * @stability external
488 *
489 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html
490 */
491export declare class CfnTopicPolicy extends cdk.CfnResource implements cdk.IInspectable {
492 /**
493 * The CloudFormation resource type name for this resource class.
494 */
495 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::SNS::TopicPolicy";
496 /**
497 * A factory method that creates a new instance of this class from an object
498 * containing the CloudFormation properties of this resource.
499 * Used in the @aws-cdk/cloudformation-include module.
500 *
501 * @internal
502 */
503 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnTopicPolicy;
504 /**
505 * A policy document that contains permissions to add to the specified SNS topics.
506 *
507 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html#cfn-sns-topicpolicy-policydocument
508 */
509 policyDocument: any | cdk.IResolvable;
510 /**
511 * The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the `[Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)` function to specify an `[AWS::SNS::Topic](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html)` resource.
512 *
513 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html#cfn-sns-topicpolicy-topics
514 */
515 topics: string[];
516 /**
517 * Create a new `AWS::SNS::TopicPolicy`.
518 *
519 * @param scope - scope in which this resource is defined
520 * @param id - scoped id of the resource
521 * @param props - resource properties
522 */
523 constructor(scope: cdk.Construct, id: string, props: CfnTopicPolicyProps);
524 /**
525 * Examines the CloudFormation resource and discloses attributes.
526 *
527 * @param inspector - tree inspector to collect and process attributes
528 *
529 */
530 inspect(inspector: cdk.TreeInspector): void;
531 protected get cfnProperties(): {
532 [key: string]: any;
533 };
534 protected renderProperties(props: {
535 [key: string]: any;
536 }): {
537 [key: string]: any;
538 };
539}