-
Notifications
You must be signed in to change notification settings - Fork 155
/
topic.ts
383 lines (376 loc) · 16.2 KB
/
topic.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
import * as pulumi from "@pulumi/pulumi";
import * as utilities from "../utilities";
import {ARN} from "../index";
/**
* Provides an SNS topic resource
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const userUpdates = new aws.sns.Topic("user_updates", {});
* ```
*
* ## Example with Delivery Policy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const userUpdates = new aws.sns.Topic("user_updates", {
* deliveryPolicy: `{
* "http": {
* "defaultHealthyRetryPolicy": {
* "minDelayTarget": 20,
* "maxDelayTarget": 20,
* "numRetries": 3,
* "numMaxDelayRetries": 0,
* "numNoDelayRetries": 0,
* "numMinDelayRetries": 0,
* "backoffFunction": "linear"
* },
* "disableSubscriptionOverrides": false,
* "defaultThrottlePolicy": {
* "maxReceivesPerSecond": 1
* }
* }
* }
* `,
* });
* ```
*
* ## Example with Server-side encryption (SSE)
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const userUpdates = new aws.sns.Topic("user_updates", {
* kmsMasterKeyId: "alias/aws/sns",
* });
* ```
*
* ## Message Delivery Status Arguments
*
* The `<endpoint>_success_feedback_role_arn` and `<endpoint>_failure_feedback_role_arn` arguments are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The `<endpoint>_success_feedback_sample_rate` argument is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the `<endpoint>_failure_feedback_role_arn` argument, then all failed message deliveries generate CloudWatch Logs.
*/
export class Topic extends pulumi.CustomResource {
/**
* Get an existing Topic resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
*/
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TopicState, opts?: pulumi.CustomResourceOptions): Topic {
return new Topic(name, <any>state, { ...opts, id: id });
}
/**
* IAM role for failure feedback
*/
public readonly applicationFailureFeedbackRoleArn!: pulumi.Output<string | undefined>;
/**
* The IAM role permitted to receive success feedback for this topic
*/
public readonly applicationSuccessFeedbackRoleArn!: pulumi.Output<string | undefined>;
/**
* Percentage of success to sample
*/
public readonly applicationSuccessFeedbackSampleRate!: pulumi.Output<number | undefined>;
/**
* The ARN of the SNS topic, as a more obvious property (clone of id)
*/
public /*out*/ readonly arn!: pulumi.Output<ARN>;
/**
* The SNS delivery policy. More on [AWS documentation](https://docs.aws.amazon.com/sns/latest/dg/DeliveryPolicies.html)
*/
public readonly deliveryPolicy!: pulumi.Output<string | undefined>;
/**
* The display name for the SNS topic
*/
public readonly displayName!: pulumi.Output<string | undefined>;
/**
* IAM role for failure feedback
*/
public readonly httpFailureFeedbackRoleArn!: pulumi.Output<string | undefined>;
/**
* The IAM role permitted to receive success feedback for this topic
*/
public readonly httpSuccessFeedbackRoleArn!: pulumi.Output<string | undefined>;
/**
* Percentage of success to sample
*/
public readonly httpSuccessFeedbackSampleRate!: pulumi.Output<number | undefined>;
/**
* 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)
*/
public readonly kmsMasterKeyId!: pulumi.Output<string | undefined>;
/**
* IAM role for failure feedback
*/
public readonly lambdaFailureFeedbackRoleArn!: pulumi.Output<string | undefined>;
/**
* The IAM role permitted to receive success feedback for this topic
*/
public readonly lambdaSuccessFeedbackRoleArn!: pulumi.Output<string | undefined>;
/**
* Percentage of success to sample
*/
public readonly lambdaSuccessFeedbackSampleRate!: pulumi.Output<number | undefined>;
/**
* The friendly name for the SNS topic. By default generated by Terraform.
*/
public readonly name!: pulumi.Output<string>;
/**
* The friendly name for the SNS topic. Conflicts with `name`.
*/
public readonly namePrefix!: pulumi.Output<string | undefined>;
/**
* The fully-formed AWS policy as JSON. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://www.terraform.io/docs/providers/aws/guides/iam-policy-documents.html).
*/
public readonly policy!: pulumi.Output<string>;
/**
* IAM role for failure feedback
*/
public readonly sqsFailureFeedbackRoleArn!: pulumi.Output<string | undefined>;
/**
* The IAM role permitted to receive success feedback for this topic
*/
public readonly sqsSuccessFeedbackRoleArn!: pulumi.Output<string | undefined>;
/**
* Percentage of success to sample
*/
public readonly sqsSuccessFeedbackSampleRate!: pulumi.Output<number | undefined>;
/**
* Key-value mapping of resource tags
*/
public readonly tags!: pulumi.Output<{[key: string]: any} | undefined>;
/**
* Create a Topic resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: TopicArgs, opts?: pulumi.CustomResourceOptions)
constructor(name: string, argsOrState?: TopicArgs | TopicState, opts?: pulumi.CustomResourceOptions) {
let inputs: pulumi.Inputs = {};
if (opts && opts.id) {
const state = argsOrState as TopicState | undefined;
inputs["applicationFailureFeedbackRoleArn"] = state ? state.applicationFailureFeedbackRoleArn : undefined;
inputs["applicationSuccessFeedbackRoleArn"] = state ? state.applicationSuccessFeedbackRoleArn : undefined;
inputs["applicationSuccessFeedbackSampleRate"] = state ? state.applicationSuccessFeedbackSampleRate : undefined;
inputs["arn"] = state ? state.arn : undefined;
inputs["deliveryPolicy"] = state ? state.deliveryPolicy : undefined;
inputs["displayName"] = state ? state.displayName : undefined;
inputs["httpFailureFeedbackRoleArn"] = state ? state.httpFailureFeedbackRoleArn : undefined;
inputs["httpSuccessFeedbackRoleArn"] = state ? state.httpSuccessFeedbackRoleArn : undefined;
inputs["httpSuccessFeedbackSampleRate"] = state ? state.httpSuccessFeedbackSampleRate : undefined;
inputs["kmsMasterKeyId"] = state ? state.kmsMasterKeyId : undefined;
inputs["lambdaFailureFeedbackRoleArn"] = state ? state.lambdaFailureFeedbackRoleArn : undefined;
inputs["lambdaSuccessFeedbackRoleArn"] = state ? state.lambdaSuccessFeedbackRoleArn : undefined;
inputs["lambdaSuccessFeedbackSampleRate"] = state ? state.lambdaSuccessFeedbackSampleRate : undefined;
inputs["name"] = state ? state.name : undefined;
inputs["namePrefix"] = state ? state.namePrefix : undefined;
inputs["policy"] = state ? state.policy : undefined;
inputs["sqsFailureFeedbackRoleArn"] = state ? state.sqsFailureFeedbackRoleArn : undefined;
inputs["sqsSuccessFeedbackRoleArn"] = state ? state.sqsSuccessFeedbackRoleArn : undefined;
inputs["sqsSuccessFeedbackSampleRate"] = state ? state.sqsSuccessFeedbackSampleRate : undefined;
inputs["tags"] = state ? state.tags : undefined;
} else {
const args = argsOrState as TopicArgs | undefined;
inputs["applicationFailureFeedbackRoleArn"] = args ? args.applicationFailureFeedbackRoleArn : undefined;
inputs["applicationSuccessFeedbackRoleArn"] = args ? args.applicationSuccessFeedbackRoleArn : undefined;
inputs["applicationSuccessFeedbackSampleRate"] = args ? args.applicationSuccessFeedbackSampleRate : undefined;
inputs["deliveryPolicy"] = args ? args.deliveryPolicy : undefined;
inputs["displayName"] = args ? args.displayName : undefined;
inputs["httpFailureFeedbackRoleArn"] = args ? args.httpFailureFeedbackRoleArn : undefined;
inputs["httpSuccessFeedbackRoleArn"] = args ? args.httpSuccessFeedbackRoleArn : undefined;
inputs["httpSuccessFeedbackSampleRate"] = args ? args.httpSuccessFeedbackSampleRate : undefined;
inputs["kmsMasterKeyId"] = args ? args.kmsMasterKeyId : undefined;
inputs["lambdaFailureFeedbackRoleArn"] = args ? args.lambdaFailureFeedbackRoleArn : undefined;
inputs["lambdaSuccessFeedbackRoleArn"] = args ? args.lambdaSuccessFeedbackRoleArn : undefined;
inputs["lambdaSuccessFeedbackSampleRate"] = args ? args.lambdaSuccessFeedbackSampleRate : undefined;
inputs["name"] = args ? args.name : undefined;
inputs["namePrefix"] = args ? args.namePrefix : undefined;
inputs["policy"] = args ? args.policy : undefined;
inputs["sqsFailureFeedbackRoleArn"] = args ? args.sqsFailureFeedbackRoleArn : undefined;
inputs["sqsSuccessFeedbackRoleArn"] = args ? args.sqsSuccessFeedbackRoleArn : undefined;
inputs["sqsSuccessFeedbackSampleRate"] = args ? args.sqsSuccessFeedbackSampleRate : undefined;
inputs["tags"] = args ? args.tags : undefined;
inputs["arn"] = undefined /*out*/;
}
super("aws:sns/topic:Topic", name, inputs, opts);
}
}
/**
* Input properties used for looking up and filtering Topic resources.
*/
export interface TopicState {
/**
* IAM role for failure feedback
*/
readonly applicationFailureFeedbackRoleArn?: pulumi.Input<string>;
/**
* The IAM role permitted to receive success feedback for this topic
*/
readonly applicationSuccessFeedbackRoleArn?: pulumi.Input<string>;
/**
* Percentage of success to sample
*/
readonly applicationSuccessFeedbackSampleRate?: pulumi.Input<number>;
/**
* The ARN of the SNS topic, as a more obvious property (clone of id)
*/
readonly arn?: pulumi.Input<ARN>;
/**
* The SNS delivery policy. More on [AWS documentation](https://docs.aws.amazon.com/sns/latest/dg/DeliveryPolicies.html)
*/
readonly deliveryPolicy?: pulumi.Input<string>;
/**
* The display name for the SNS topic
*/
readonly displayName?: pulumi.Input<string>;
/**
* IAM role for failure feedback
*/
readonly httpFailureFeedbackRoleArn?: pulumi.Input<string>;
/**
* The IAM role permitted to receive success feedback for this topic
*/
readonly httpSuccessFeedbackRoleArn?: pulumi.Input<string>;
/**
* Percentage of success to sample
*/
readonly httpSuccessFeedbackSampleRate?: pulumi.Input<number>;
/**
* 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)
*/
readonly kmsMasterKeyId?: pulumi.Input<string>;
/**
* IAM role for failure feedback
*/
readonly lambdaFailureFeedbackRoleArn?: pulumi.Input<string>;
/**
* The IAM role permitted to receive success feedback for this topic
*/
readonly lambdaSuccessFeedbackRoleArn?: pulumi.Input<string>;
/**
* Percentage of success to sample
*/
readonly lambdaSuccessFeedbackSampleRate?: pulumi.Input<number>;
/**
* The friendly name for the SNS topic. By default generated by Terraform.
*/
readonly name?: pulumi.Input<string>;
/**
* The friendly name for the SNS topic. Conflicts with `name`.
*/
readonly namePrefix?: pulumi.Input<string>;
/**
* The fully-formed AWS policy as JSON. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://www.terraform.io/docs/providers/aws/guides/iam-policy-documents.html).
*/
readonly policy?: pulumi.Input<string>;
/**
* IAM role for failure feedback
*/
readonly sqsFailureFeedbackRoleArn?: pulumi.Input<string>;
/**
* The IAM role permitted to receive success feedback for this topic
*/
readonly sqsSuccessFeedbackRoleArn?: pulumi.Input<string>;
/**
* Percentage of success to sample
*/
readonly sqsSuccessFeedbackSampleRate?: pulumi.Input<number>;
/**
* Key-value mapping of resource tags
*/
readonly tags?: pulumi.Input<{[key: string]: any}>;
}
/**
* The set of arguments for constructing a Topic resource.
*/
export interface TopicArgs {
/**
* IAM role for failure feedback
*/
readonly applicationFailureFeedbackRoleArn?: pulumi.Input<string>;
/**
* The IAM role permitted to receive success feedback for this topic
*/
readonly applicationSuccessFeedbackRoleArn?: pulumi.Input<string>;
/**
* Percentage of success to sample
*/
readonly applicationSuccessFeedbackSampleRate?: pulumi.Input<number>;
/**
* The SNS delivery policy. More on [AWS documentation](https://docs.aws.amazon.com/sns/latest/dg/DeliveryPolicies.html)
*/
readonly deliveryPolicy?: pulumi.Input<string>;
/**
* The display name for the SNS topic
*/
readonly displayName?: pulumi.Input<string>;
/**
* IAM role for failure feedback
*/
readonly httpFailureFeedbackRoleArn?: pulumi.Input<string>;
/**
* The IAM role permitted to receive success feedback for this topic
*/
readonly httpSuccessFeedbackRoleArn?: pulumi.Input<string>;
/**
* Percentage of success to sample
*/
readonly httpSuccessFeedbackSampleRate?: pulumi.Input<number>;
/**
* 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)
*/
readonly kmsMasterKeyId?: pulumi.Input<string>;
/**
* IAM role for failure feedback
*/
readonly lambdaFailureFeedbackRoleArn?: pulumi.Input<string>;
/**
* The IAM role permitted to receive success feedback for this topic
*/
readonly lambdaSuccessFeedbackRoleArn?: pulumi.Input<string>;
/**
* Percentage of success to sample
*/
readonly lambdaSuccessFeedbackSampleRate?: pulumi.Input<number>;
/**
* The friendly name for the SNS topic. By default generated by Terraform.
*/
readonly name?: pulumi.Input<string>;
/**
* The friendly name for the SNS topic. Conflicts with `name`.
*/
readonly namePrefix?: pulumi.Input<string>;
/**
* The fully-formed AWS policy as JSON. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://www.terraform.io/docs/providers/aws/guides/iam-policy-documents.html).
*/
readonly policy?: pulumi.Input<string>;
/**
* IAM role for failure feedback
*/
readonly sqsFailureFeedbackRoleArn?: pulumi.Input<string>;
/**
* The IAM role permitted to receive success feedback for this topic
*/
readonly sqsSuccessFeedbackRoleArn?: pulumi.Input<string>;
/**
* Percentage of success to sample
*/
readonly sqsSuccessFeedbackSampleRate?: pulumi.Input<number>;
/**
* Key-value mapping of resource tags
*/
readonly tags?: pulumi.Input<{[key: string]: any}>;
}