UNPKG

28.2 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 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy
40 */
41 readonly filterPolicy?: any | cdk.IResolvable;
42 /**
43 * 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* .
44 *
45 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-rawmessagedelivery
46 */
47 readonly rawMessageDelivery?: boolean | cdk.IResolvable;
48 /**
49 * 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.
50 *
51 * 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* .
52 *
53 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-redrivepolicy
54 */
55 readonly redrivePolicy?: any | cdk.IResolvable;
56 /**
57 * For cross-region subscriptions, the region in which the topic resides.
58 *
59 * If no region is specified, AWS CloudFormation uses the region of the caller as the default.
60 *
61 * 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:
62 *
63 * - Updating the `Region` from `NULL` to the caller region.
64 * - Updating the `Region` from the caller region to `NULL` .
65 *
66 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-region
67 */
68 readonly region?: string;
69 /**
70 * This property applies only to Amazon Kinesis Data Firehose delivery stream subscriptions. Specify the ARN of the IAM role that has the following:
71 *
72 * - Permission to write to the Amazon Kinesis Data Firehose delivery stream
73 * - Amazon SNS listed as a trusted entity
74 *
75 * 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.*
76 *
77 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-subscriptionrolearn
78 */
79 readonly subscriptionRoleArn?: string;
80}
81/**
82 * A CloudFormation `AWS::SNS::Subscription`
83 *
84 * 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.
85 *
86 * @cloudformationResource AWS::SNS::Subscription
87 * @stability external
88 *
89 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html
90 */
91export declare class CfnSubscription extends cdk.CfnResource implements cdk.IInspectable {
92 /**
93 * The CloudFormation resource type name for this resource class.
94 */
95 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::SNS::Subscription";
96 /**
97 * A factory method that creates a new instance of this class from an object
98 * containing the CloudFormation properties of this resource.
99 * Used in the @aws-cdk/cloudformation-include module.
100 *
101 * @internal
102 */
103 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnSubscription;
104 /**
105 * 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* .
106 *
107 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-protocol
108 */
109 protocol: string;
110 /**
111 * The ARN of the topic to subscribe to.
112 *
113 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#topicarn
114 */
115 topicArn: string;
116 /**
117 * 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* .
118 *
119 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-deliverypolicy
120 */
121 deliveryPolicy: any | cdk.IResolvable | undefined;
122 /**
123 * 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* .
124 *
125 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-endpoint
126 */
127 endpoint: string | undefined;
128 /**
129 * 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* .
130 *
131 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy
132 */
133 filterPolicy: any | cdk.IResolvable | undefined;
134 /**
135 * 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* .
136 *
137 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-rawmessagedelivery
138 */
139 rawMessageDelivery: boolean | cdk.IResolvable | undefined;
140 /**
141 * 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.
142 *
143 * 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* .
144 *
145 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-redrivepolicy
146 */
147 redrivePolicy: any | cdk.IResolvable | undefined;
148 /**
149 * For cross-region subscriptions, the region in which the topic resides.
150 *
151 * If no region is specified, AWS CloudFormation uses the region of the caller as the default.
152 *
153 * 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:
154 *
155 * - Updating the `Region` from `NULL` to the caller region.
156 * - Updating the `Region` from the caller region to `NULL` .
157 *
158 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-region
159 */
160 region: string | undefined;
161 /**
162 * This property applies only to Amazon Kinesis Data Firehose delivery stream subscriptions. Specify the ARN of the IAM role that has the following:
163 *
164 * - Permission to write to the Amazon Kinesis Data Firehose delivery stream
165 * - Amazon SNS listed as a trusted entity
166 *
167 * 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.*
168 *
169 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-subscriptionrolearn
170 */
171 subscriptionRoleArn: string | undefined;
172 /**
173 * Create a new `AWS::SNS::Subscription`.
174 *
175 * @param scope - scope in which this resource is defined
176 * @param id - scoped id of the resource
177 * @param props - resource properties
178 */
179 constructor(scope: cdk.Construct, id: string, props: CfnSubscriptionProps);
180 /**
181 * Examines the CloudFormation resource and discloses attributes.
182 *
183 * @param inspector - tree inspector to collect and process attributes
184 *
185 */
186 inspect(inspector: cdk.TreeInspector): void;
187 protected get cfnProperties(): {
188 [key: string]: any;
189 };
190 protected renderProperties(props: {
191 [key: string]: any;
192 }): {
193 [key: string]: any;
194 };
195}
196/**
197 * Properties for defining a `CfnTopic`
198 *
199 * @struct
200 * @stability external
201 *
202 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html
203 */
204export interface CfnTopicProps {
205 /**
206 * Enables content-based deduplication for FIFO topics.
207 *
208 * - 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.
209 * - 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).
210 *
211 * (Optional) To override the generated value, you can specify a value for the the `MessageDeduplicationId` parameter for the `Publish` action.
212 *
213 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-contentbaseddeduplication
214 */
215 readonly contentBasedDeduplication?: boolean | cdk.IResolvable;
216 /**
217 * The display name to use for an Amazon SNS topic with SMS subscriptions.
218 *
219 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-displayname
220 */
221 readonly displayName?: string;
222 /**
223 * Set to true to create a FIFO topic.
224 *
225 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-fifotopic
226 */
227 readonly fifoTopic?: boolean | cdk.IResolvable;
228 /**
229 * 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* .
230 *
231 * This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html) .
232 *
233 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-kmsmasterkeyid
234 */
235 readonly kmsMasterKeyId?: string;
236 /**
237 * The Amazon SNS subscriptions (endpoints) for this topic.
238 *
239 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-subscription
240 */
241 readonly subscription?: Array<CfnTopic.SubscriptionProperty | cdk.IResolvable> | cdk.IResolvable;
242 /**
243 * The list of tags to add to a new topic.
244 *
245 * > To be able to tag a topic on creation, you must have the `sns:CreateTopic` and `sns:TagResource` permissions.
246 *
247 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-tags
248 */
249 readonly tags?: cdk.CfnTag[];
250 /**
251 * 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` .
252 *
253 * 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) .
254 *
255 * > 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.
256 *
257 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-topicname
258 */
259 readonly topicName?: string;
260}
261/**
262 * A CloudFormation `AWS::SNS::Topic`
263 *
264 * The `AWS::SNS::Topic` resource creates a topic to which notifications can be published.
265 *
266 * > 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* .
267 *
268 * @cloudformationResource AWS::SNS::Topic
269 * @stability external
270 *
271 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html
272 */
273export declare class CfnTopic extends cdk.CfnResource implements cdk.IInspectable {
274 /**
275 * The CloudFormation resource type name for this resource class.
276 */
277 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::SNS::Topic";
278 /**
279 * A factory method that creates a new instance of this class from an object
280 * containing the CloudFormation properties of this resource.
281 * Used in the @aws-cdk/cloudformation-include module.
282 *
283 * @internal
284 */
285 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnTopic;
286 /**
287 * Returns the name of an Amazon SNS topic.
288 * @cloudformationAttribute TopicName
289 */
290 readonly attrTopicName: string;
291 /**
292 * Enables content-based deduplication for FIFO topics.
293 *
294 * - 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.
295 * - 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).
296 *
297 * (Optional) To override the generated value, you can specify a value for the the `MessageDeduplicationId` parameter for the `Publish` action.
298 *
299 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-contentbaseddeduplication
300 */
301 contentBasedDeduplication: boolean | cdk.IResolvable | undefined;
302 /**
303 * The display name to use for an Amazon SNS topic with SMS subscriptions.
304 *
305 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-displayname
306 */
307 displayName: string | undefined;
308 /**
309 * Set to true to create a FIFO topic.
310 *
311 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-fifotopic
312 */
313 fifoTopic: boolean | cdk.IResolvable | undefined;
314 /**
315 * 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* .
316 *
317 * This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html) .
318 *
319 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-kmsmasterkeyid
320 */
321 kmsMasterKeyId: string | undefined;
322 /**
323 * The Amazon SNS subscriptions (endpoints) for this topic.
324 *
325 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-subscription
326 */
327 subscription: Array<CfnTopic.SubscriptionProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
328 /**
329 * The list of tags to add to a new topic.
330 *
331 * > To be able to tag a topic on creation, you must have the `sns:CreateTopic` and `sns:TagResource` permissions.
332 *
333 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-tags
334 */
335 readonly tags: cdk.TagManager;
336 /**
337 * 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` .
338 *
339 * 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) .
340 *
341 * > 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.
342 *
343 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-topicname
344 */
345 topicName: string | undefined;
346 /**
347 * Create a new `AWS::SNS::Topic`.
348 *
349 * @param scope - scope in which this resource is defined
350 * @param id - scoped id of the resource
351 * @param props - resource properties
352 */
353 constructor(scope: cdk.Construct, id: string, props?: CfnTopicProps);
354 /**
355 * Examines the CloudFormation resource and discloses attributes.
356 *
357 * @param inspector - tree inspector to collect and process attributes
358 *
359 */
360 inspect(inspector: cdk.TreeInspector): void;
361 protected get cfnProperties(): {
362 [key: string]: any;
363 };
364 protected renderProperties(props: {
365 [key: string]: any;
366 }): {
367 [key: string]: any;
368 };
369}
370export declare namespace CfnTopic {
371 /**
372 * `Subscription` is an embedded property that describes the subscription endpoints of an Amazon SNS topic.
373 *
374 * > 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.
375 *
376 * @struct
377 * @stability external
378 *
379 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-subscription.html
380 */
381 interface SubscriptionProperty {
382 /**
383 * 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* .
384 *
385 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-subscription.html#cfn-sns-topic-subscription-endpoint
386 */
387 readonly endpoint: string;
388 /**
389 * 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* .
390 *
391 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-subscription.html#cfn-sns-topic-subscription-protocol
392 */
393 readonly protocol: string;
394 }
395}
396/**
397 * Properties for defining a `CfnTopicPolicy`
398 *
399 * @struct
400 * @stability external
401 *
402 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html
403 */
404export interface CfnTopicPolicyProps {
405 /**
406 * A policy document that contains permissions to add to the specified SNS topics.
407 *
408 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html#cfn-sns-topicpolicy-policydocument
409 */
410 readonly policyDocument: any | cdk.IResolvable;
411 /**
412 * 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.
413 *
414 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html#cfn-sns-topicpolicy-topics
415 */
416 readonly topics: string[];
417}
418/**
419 * A CloudFormation `AWS::SNS::TopicPolicy`
420 *
421 * 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* .
422 *
423 * @cloudformationResource AWS::SNS::TopicPolicy
424 * @stability external
425 *
426 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html
427 */
428export declare class CfnTopicPolicy extends cdk.CfnResource implements cdk.IInspectable {
429 /**
430 * The CloudFormation resource type name for this resource class.
431 */
432 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::SNS::TopicPolicy";
433 /**
434 * A factory method that creates a new instance of this class from an object
435 * containing the CloudFormation properties of this resource.
436 * Used in the @aws-cdk/cloudformation-include module.
437 *
438 * @internal
439 */
440 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnTopicPolicy;
441 /**
442 * A policy document that contains permissions to add to the specified SNS topics.
443 *
444 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html#cfn-sns-topicpolicy-policydocument
445 */
446 policyDocument: any | cdk.IResolvable;
447 /**
448 * 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.
449 *
450 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html#cfn-sns-topicpolicy-topics
451 */
452 topics: string[];
453 /**
454 * Create a new `AWS::SNS::TopicPolicy`.
455 *
456 * @param scope - scope in which this resource is defined
457 * @param id - scoped id of the resource
458 * @param props - resource properties
459 */
460 constructor(scope: cdk.Construct, id: string, props: CfnTopicPolicyProps);
461 /**
462 * Examines the CloudFormation resource and discloses attributes.
463 *
464 * @param inspector - tree inspector to collect and process attributes
465 *
466 */
467 inspect(inspector: cdk.TreeInspector): void;
468 protected get cfnProperties(): {
469 [key: string]: any;
470 };
471 protected renderProperties(props: {
472 [key: string]: any;
473 }): {
474 [key: string]: any;
475 };
476}