-
Notifications
You must be signed in to change notification settings - Fork 155
/
eventSubscription.ts
265 lines (257 loc) · 11.8 KB
/
eventSubscription.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
// *** 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";
/**
* Provides a DB event subscription resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const _default = new aws.rds.Instance("default", {
* allocatedStorage: 10,
* engine: "mysql",
* engineVersion: "5.6.17",
* instanceClass: aws.rds.InstanceType.T2_Micro,
* dbName: "mydb",
* username: "foo",
* password: "bar",
* dbSubnetGroupName: "my_database_subnet_group",
* parameterGroupName: "default.mysql5.6",
* });
* const defaultTopic = new aws.sns.Topic("default", {name: "rds-events"});
* const defaultEventSubscription = new aws.rds.EventSubscription("default", {
* name: "rds-event-sub",
* snsTopic: defaultTopic.arn,
* sourceType: "db-instance",
* sourceIds: [_default.identifier],
* eventCategories: [
* "availability",
* "deletion",
* "failover",
* "failure",
* "low storage",
* "maintenance",
* "notification",
* "read replica",
* "recovery",
* "restoration",
* ],
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import DB Event Subscriptions using the `name`. For example:
*
* ```sh
* $ pulumi import aws:rds/eventSubscription:EventSubscription default rds-event-sub
* ```
*/
export class EventSubscription extends pulumi.CustomResource {
/**
* Get an existing EventSubscription 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.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EventSubscriptionState, opts?: pulumi.CustomResourceOptions): EventSubscription {
return new EventSubscription(name, <any>state, { ...opts, id: id });
}
/** @internal */
public static readonly __pulumiType = 'aws:rds/eventSubscription:EventSubscription';
/**
* Returns true if the given object is an instance of EventSubscription. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
public static isInstance(obj: any): obj is EventSubscription {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === EventSubscription.__pulumiType;
}
/**
* The Amazon Resource Name of the RDS event notification subscription
*/
public /*out*/ readonly arn!: pulumi.Output<string>;
/**
* The AWS customer account associated with the RDS event notification subscription
*/
public /*out*/ readonly customerAwsId!: pulumi.Output<string>;
/**
* A boolean flag to enable/disable the subscription. Defaults to true.
*/
public readonly enabled!: pulumi.Output<boolean | undefined>;
/**
* A list of event categories for a SourceType that you want to subscribe to. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html or run `aws rds describe-event-categories`.
*/
public readonly eventCategories!: pulumi.Output<string[] | undefined>;
/**
* The name of the DB event subscription. By default generated by this provider.
*/
public readonly name!: pulumi.Output<string>;
/**
* The name of the DB event subscription. Conflicts with `name`.
*/
public readonly namePrefix!: pulumi.Output<string>;
/**
* The SNS topic to send events to.
*/
public readonly snsTopic!: pulumi.Output<string>;
/**
* A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a sourceType must also be specified.
*/
public readonly sourceIds!: pulumi.Output<string[] | undefined>;
/**
* The type of source that will be generating the events. Valid options are `db-instance`, `db-security-group`, `db-parameter-group`, `db-snapshot`, `db-cluster`, `db-cluster-snapshot`, or `db-proxy`. If not set, all sources will be subscribed to.
*/
public readonly sourceType!: pulumi.Output<string | undefined>;
/**
* A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
public readonly tags!: pulumi.Output<{[key: string]: string} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*
* @deprecated Please use `tags` instead.
*/
public /*out*/ readonly tagsAll!: pulumi.Output<{[key: string]: string}>;
/**
* Create a EventSubscription 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: EventSubscriptionArgs, opts?: pulumi.CustomResourceOptions)
constructor(name: string, argsOrState?: EventSubscriptionArgs | EventSubscriptionState, opts?: pulumi.CustomResourceOptions) {
let resourceInputs: pulumi.Inputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState as EventSubscriptionState | undefined;
resourceInputs["arn"] = state ? state.arn : undefined;
resourceInputs["customerAwsId"] = state ? state.customerAwsId : undefined;
resourceInputs["enabled"] = state ? state.enabled : undefined;
resourceInputs["eventCategories"] = state ? state.eventCategories : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["namePrefix"] = state ? state.namePrefix : undefined;
resourceInputs["snsTopic"] = state ? state.snsTopic : undefined;
resourceInputs["sourceIds"] = state ? state.sourceIds : undefined;
resourceInputs["sourceType"] = state ? state.sourceType : undefined;
resourceInputs["tags"] = state ? state.tags : undefined;
resourceInputs["tagsAll"] = state ? state.tagsAll : undefined;
} else {
const args = argsOrState as EventSubscriptionArgs | undefined;
if ((!args || args.snsTopic === undefined) && !opts.urn) {
throw new Error("Missing required property 'snsTopic'");
}
resourceInputs["enabled"] = args ? args.enabled : undefined;
resourceInputs["eventCategories"] = args ? args.eventCategories : undefined;
resourceInputs["name"] = args ? args.name : undefined;
resourceInputs["namePrefix"] = args ? args.namePrefix : undefined;
resourceInputs["snsTopic"] = args ? args.snsTopic : undefined;
resourceInputs["sourceIds"] = args ? args.sourceIds : undefined;
resourceInputs["sourceType"] = args ? args.sourceType : undefined;
resourceInputs["tags"] = args ? args.tags : undefined;
resourceInputs["arn"] = undefined /*out*/;
resourceInputs["customerAwsId"] = undefined /*out*/;
resourceInputs["tagsAll"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(EventSubscription.__pulumiType, name, resourceInputs, opts);
}
}
/**
* Input properties used for looking up and filtering EventSubscription resources.
*/
export interface EventSubscriptionState {
/**
* The Amazon Resource Name of the RDS event notification subscription
*/
arn?: pulumi.Input<string>;
/**
* The AWS customer account associated with the RDS event notification subscription
*/
customerAwsId?: pulumi.Input<string>;
/**
* A boolean flag to enable/disable the subscription. Defaults to true.
*/
enabled?: pulumi.Input<boolean>;
/**
* A list of event categories for a SourceType that you want to subscribe to. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html or run `aws rds describe-event-categories`.
*/
eventCategories?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name of the DB event subscription. By default generated by this provider.
*/
name?: pulumi.Input<string>;
/**
* The name of the DB event subscription. Conflicts with `name`.
*/
namePrefix?: pulumi.Input<string>;
/**
* The SNS topic to send events to.
*/
snsTopic?: pulumi.Input<string>;
/**
* A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a sourceType must also be specified.
*/
sourceIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The type of source that will be generating the events. Valid options are `db-instance`, `db-security-group`, `db-parameter-group`, `db-snapshot`, `db-cluster`, `db-cluster-snapshot`, or `db-proxy`. If not set, all sources will be subscribed to.
*/
sourceType?: pulumi.Input<string>;
/**
* A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*
* @deprecated Please use `tags` instead.
*/
tagsAll?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
}
/**
* The set of arguments for constructing a EventSubscription resource.
*/
export interface EventSubscriptionArgs {
/**
* A boolean flag to enable/disable the subscription. Defaults to true.
*/
enabled?: pulumi.Input<boolean>;
/**
* A list of event categories for a SourceType that you want to subscribe to. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html or run `aws rds describe-event-categories`.
*/
eventCategories?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name of the DB event subscription. By default generated by this provider.
*/
name?: pulumi.Input<string>;
/**
* The name of the DB event subscription. Conflicts with `name`.
*/
namePrefix?: pulumi.Input<string>;
/**
* The SNS topic to send events to.
*/
snsTopic: pulumi.Input<string>;
/**
* A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a sourceType must also be specified.
*/
sourceIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The type of source that will be generating the events. Valid options are `db-instance`, `db-security-group`, `db-parameter-group`, `db-snapshot`, `db-cluster`, `db-cluster-snapshot`, or `db-proxy`. If not set, all sources will be subscribed to.
*/
sourceType?: pulumi.Input<string>;
/**
* A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
}