-
Notifications
You must be signed in to change notification settings - Fork 155
/
eventTarget.ts
429 lines (423 loc) · 17.5 KB
/
eventTarget.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
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
// *** 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 CloudWatch Event Target resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const console = new aws.cloudwatch.EventRule("console", {
* description: "Capture all EC2 scaling events",
* eventPattern: `{
* "source": [
* "aws.autoscaling"
* ],
* "detail-type": [
* "EC2 Instance Launch Successful",
* "EC2 Instance Terminate Successful",
* "EC2 Instance Launch Unsuccessful",
* "EC2 Instance Terminate Unsuccessful"
* ]
* }
* `,
* });
* const testStream = new aws.kinesis.Stream("test_stream", {
* shardCount: 1,
* });
* const yada = new aws.cloudwatch.EventTarget("yada", {
* arn: testStream.arn,
* rule: console.name,
* runCommandTargets: [
* {
* key: "tag:Name",
* values: ["FooBar"],
* },
* {
* key: "InstanceIds",
* values: ["i-162058cd308bffec2"],
* },
* ],
* });
* ```
*
* ## Example SSM Document Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const stopInstancesEventRule = new aws.cloudwatch.EventRule("stop_instances", {
* description: "Stop instances nightly",
* scheduleExpression: "cron(0 0 * * ? *)",
* });
* const stopInstance = new aws.ssm.Document("stop_instance", {
* content: ` {
* "schemaVersion": "1.2",
* "description": "Stop an instance",
* "parameters": {
*
* },
* "runtimeConfig": {
* "aws:runShellScript": {
* "properties": [
* {
* "id": "0.aws:runShellScript",
* "runCommand": ["halt"]
* }
* ]
* }
* }
* }
* `,
* documentType: "Command",
* });
* const ssmLifecycleTrust = pulumi.output(aws.iam.getPolicyDocument({
* statements: [{
* actions: ["sts:AssumeRole"],
* principals: [{
* identifiers: ["events.amazonaws.com"],
* type: "Service",
* }],
* }],
* }));
* const ssmLifecycleRole = new aws.iam.Role("ssm_lifecycle", {
* assumeRolePolicy: ssmLifecycleTrust.json,
* });
* const stopInstancesEventTarget = new aws.cloudwatch.EventTarget("stop_instances", {
* arn: stopInstance.arn,
* roleArn: ssmLifecycleRole.arn,
* rule: stopInstancesEventRule.name,
* runCommandTargets: [{
* key: "tag:Terminate",
* values: ["midnight"],
* }],
* });
* const ssmLifecyclePolicyDocument = stopInstance.arn.apply(arn => aws.iam.getPolicyDocument({
* statements: [
* {
* actions: ["ssm:SendCommand"],
* conditions: [{
* test: "StringEquals",
* values: ["*"],
* variable: "ec2:ResourceTag/Terminate",
* }],
* effect: "Allow",
* resources: ["arn:aws:ec2:eu-west-1:1234567890:instance/*"],
* },
* {
* actions: ["ssm:SendCommand"],
* effect: "Allow",
* resources: [arn],
* },
* ],
* }));
* const ssmLifecyclePolicy = new aws.iam.Policy("ssm_lifecycle", {
* policy: ssmLifecyclePolicyDocument.json,
* });
* ```
*
* ## Example RunCommand Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const stopInstancesEventRule = new aws.cloudwatch.EventRule("stop_instances", {
* description: "Stop instances nightly",
* scheduleExpression: "cron(0 0 * * ? *)",
* });
* const stopInstancesEventTarget = new aws.cloudwatch.EventTarget("stop_instances", {
* arn: `arn:aws:ssm:${var_aws_region}::document/AWS-RunShellScript`,
* input: "{\"commands\":[\"halt\"]}",
* roleArn: aws_iam_role_ssm_lifecycle.arn,
* rule: stopInstancesEventRule.name,
* runCommandTargets: [{
* key: "tag:Terminate",
* values: ["midnight"],
* }],
* });
* ```
*
* ## Example ECS Run Task with Role and Task Override Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const ecsEvents = new aws.iam.Role("ecs_events", {
* assumeRolePolicy: `{
* "Version": "2012-10-17",
* "Statement": [
* {
* "Sid": "",
* "Effect": "Allow",
* "Principal": {
* "Service": "events.amazonaws.com"
* },
* "Action": "sts:AssumeRole"
* }
* ]
* }
* `,
* });
* const ecsScheduledTask = new aws.cloudwatch.EventTarget("ecs_scheduled_task", {
* arn: aws_ecs_cluster_cluster_name.arn,
* ecsTarget: {
* taskCount: 1,
* taskDefinitionArn: aws_ecs_task_definition_task_name.arn,
* },
* input: `{
* "containerOverrides": [
* {
* "name": "name-of-container-to-override",
* "command": ["bin/console", "scheduled-task"]
* }
* ]
* }
* `,
* roleArn: ecsEvents.arn,
* rule: aws_cloudwatch_event_rule_every_hour.name,
* });
* const ecsEventsRunTaskWithAnyRole = new aws.iam.RolePolicy("ecs_events_run_task_with_any_role", {
* policy: aws_ecs_task_definition_task_name.arn.apply(arn => `{
* "Version": "2012-10-17",
* "Statement": [
* {
* "Effect": "Allow",
* "Action": "iam:PassRole",
* "Resource": "*"
* },
* {
* "Effect": "Allow",
* "Action": "ecs:RunTask",
* "Resource": "${arn.replace("/:\\d+$/", ":*")}"
* }
* ]
* }
* `),
* role: ecsEvents.id,
* });
* ```
*/
export class EventTarget extends pulumi.CustomResource {
/**
* Get an existing EventTarget 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?: EventTargetState, opts?: pulumi.CustomResourceOptions): EventTarget {
return new EventTarget(name, <any>state, { ...opts, id: id });
}
/**
* The Amazon Resource Name (ARN) associated of the target.
*/
public readonly arn!: pulumi.Output<string>;
/**
* Parameters used when you are using the rule to invoke an Amazon Batch Job. Documented below. A maximum of 1 are allowed.
*/
public readonly batchTarget!: pulumi.Output<{ arraySize?: number, jobAttempts?: number, jobDefinition: string, jobName: string } | undefined>;
/**
* Parameters used when you are using the rule to invoke Amazon ECS Task. Documented below. A maximum of 1 are allowed.
*/
public readonly ecsTarget!: pulumi.Output<{ group?: string, launchType?: string, networkConfiguration?: { assignPublicIp?: boolean, securityGroups?: string[], subnets: string[] }, platformVersion?: string, taskCount?: number, taskDefinitionArn: string } | undefined>;
/**
* Valid JSON text passed to the target.
*/
public readonly input!: pulumi.Output<string | undefined>;
/**
* The value of the [JSONPath](http://goessner.net/articles/JsonPath/)
* that is used for extracting part of the matched event when passing it to the target.
*/
public readonly inputPath!: pulumi.Output<string | undefined>;
/**
* Parameters used when you are providing a custom input to a target based on certain event data.
*/
public readonly inputTransformer!: pulumi.Output<{ inputPaths?: {[key: string]: any}, inputTemplate: string } | undefined>;
/**
* Parameters used when you are using the rule to invoke an Amazon Kinesis Stream. Documented below. A maximum of 1 are allowed.
*/
public readonly kinesisTarget!: pulumi.Output<{ partitionKeyPath?: string } | undefined>;
/**
* The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. Required if `ecs_target` is used.
*/
public readonly roleArn!: pulumi.Output<string | undefined>;
/**
* The name of the rule you want to add targets to.
*/
public readonly rule!: pulumi.Output<string>;
/**
* Parameters used when you are using the rule to invoke Amazon EC2 Run Command. Documented below. A maximum of 5 are allowed.
*/
public readonly runCommandTargets!: pulumi.Output<{ key: string, values: string[] }[] | undefined>;
/**
* Parameters used when you are using the rule to invoke an Amazon SQS Queue. Documented below. A maximum of 1 are allowed.
*/
public readonly sqsTarget!: pulumi.Output<{ messageGroupId?: string } | undefined>;
/**
* The unique target assignment ID. If missing, will generate a random, unique id.
*/
public readonly targetId!: pulumi.Output<string>;
/**
* Create a EventTarget 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: EventTargetArgs, opts?: pulumi.CustomResourceOptions)
constructor(name: string, argsOrState?: EventTargetArgs | EventTargetState, opts?: pulumi.CustomResourceOptions) {
let inputs: pulumi.Inputs = {};
if (opts && opts.id) {
const state = argsOrState as EventTargetState | undefined;
inputs["arn"] = state ? state.arn : undefined;
inputs["batchTarget"] = state ? state.batchTarget : undefined;
inputs["ecsTarget"] = state ? state.ecsTarget : undefined;
inputs["input"] = state ? state.input : undefined;
inputs["inputPath"] = state ? state.inputPath : undefined;
inputs["inputTransformer"] = state ? state.inputTransformer : undefined;
inputs["kinesisTarget"] = state ? state.kinesisTarget : undefined;
inputs["roleArn"] = state ? state.roleArn : undefined;
inputs["rule"] = state ? state.rule : undefined;
inputs["runCommandTargets"] = state ? state.runCommandTargets : undefined;
inputs["sqsTarget"] = state ? state.sqsTarget : undefined;
inputs["targetId"] = state ? state.targetId : undefined;
} else {
const args = argsOrState as EventTargetArgs | undefined;
if (!args || args.arn === undefined) {
throw new Error("Missing required property 'arn'");
}
if (!args || args.rule === undefined) {
throw new Error("Missing required property 'rule'");
}
inputs["arn"] = args ? args.arn : undefined;
inputs["batchTarget"] = args ? args.batchTarget : undefined;
inputs["ecsTarget"] = args ? args.ecsTarget : undefined;
inputs["input"] = args ? args.input : undefined;
inputs["inputPath"] = args ? args.inputPath : undefined;
inputs["inputTransformer"] = args ? args.inputTransformer : undefined;
inputs["kinesisTarget"] = args ? args.kinesisTarget : undefined;
inputs["roleArn"] = args ? args.roleArn : undefined;
inputs["rule"] = args ? args.rule : undefined;
inputs["runCommandTargets"] = args ? args.runCommandTargets : undefined;
inputs["sqsTarget"] = args ? args.sqsTarget : undefined;
inputs["targetId"] = args ? args.targetId : undefined;
}
super("aws:cloudwatch/eventTarget:EventTarget", name, inputs, opts);
}
}
/**
* Input properties used for looking up and filtering EventTarget resources.
*/
export interface EventTargetState {
/**
* The Amazon Resource Name (ARN) associated of the target.
*/
readonly arn?: pulumi.Input<string>;
/**
* Parameters used when you are using the rule to invoke an Amazon Batch Job. Documented below. A maximum of 1 are allowed.
*/
readonly batchTarget?: pulumi.Input<{ arraySize?: pulumi.Input<number>, jobAttempts?: pulumi.Input<number>, jobDefinition: pulumi.Input<string>, jobName: pulumi.Input<string> }>;
/**
* Parameters used when you are using the rule to invoke Amazon ECS Task. Documented below. A maximum of 1 are allowed.
*/
readonly ecsTarget?: pulumi.Input<{ group?: pulumi.Input<string>, launchType?: pulumi.Input<string>, networkConfiguration?: pulumi.Input<{ assignPublicIp?: pulumi.Input<boolean>, securityGroups?: pulumi.Input<pulumi.Input<string>[]>, subnets: pulumi.Input<pulumi.Input<string>[]> }>, platformVersion?: pulumi.Input<string>, taskCount?: pulumi.Input<number>, taskDefinitionArn: pulumi.Input<string> }>;
/**
* Valid JSON text passed to the target.
*/
readonly input?: pulumi.Input<string>;
/**
* The value of the [JSONPath](http://goessner.net/articles/JsonPath/)
* that is used for extracting part of the matched event when passing it to the target.
*/
readonly inputPath?: pulumi.Input<string>;
/**
* Parameters used when you are providing a custom input to a target based on certain event data.
*/
readonly inputTransformer?: pulumi.Input<{ inputPaths?: pulumi.Input<{[key: string]: any}>, inputTemplate: pulumi.Input<string> }>;
/**
* Parameters used when you are using the rule to invoke an Amazon Kinesis Stream. Documented below. A maximum of 1 are allowed.
*/
readonly kinesisTarget?: pulumi.Input<{ partitionKeyPath?: pulumi.Input<string> }>;
/**
* The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. Required if `ecs_target` is used.
*/
readonly roleArn?: pulumi.Input<string>;
/**
* The name of the rule you want to add targets to.
*/
readonly rule?: pulumi.Input<string>;
/**
* Parameters used when you are using the rule to invoke Amazon EC2 Run Command. Documented below. A maximum of 5 are allowed.
*/
readonly runCommandTargets?: pulumi.Input<pulumi.Input<{ key: pulumi.Input<string>, values: pulumi.Input<pulumi.Input<string>[]> }>[]>;
/**
* Parameters used when you are using the rule to invoke an Amazon SQS Queue. Documented below. A maximum of 1 are allowed.
*/
readonly sqsTarget?: pulumi.Input<{ messageGroupId?: pulumi.Input<string> }>;
/**
* The unique target assignment ID. If missing, will generate a random, unique id.
*/
readonly targetId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a EventTarget resource.
*/
export interface EventTargetArgs {
/**
* The Amazon Resource Name (ARN) associated of the target.
*/
readonly arn: pulumi.Input<string>;
/**
* Parameters used when you are using the rule to invoke an Amazon Batch Job. Documented below. A maximum of 1 are allowed.
*/
readonly batchTarget?: pulumi.Input<{ arraySize?: pulumi.Input<number>, jobAttempts?: pulumi.Input<number>, jobDefinition: pulumi.Input<string>, jobName: pulumi.Input<string> }>;
/**
* Parameters used when you are using the rule to invoke Amazon ECS Task. Documented below. A maximum of 1 are allowed.
*/
readonly ecsTarget?: pulumi.Input<{ group?: pulumi.Input<string>, launchType?: pulumi.Input<string>, networkConfiguration?: pulumi.Input<{ assignPublicIp?: pulumi.Input<boolean>, securityGroups?: pulumi.Input<pulumi.Input<string>[]>, subnets: pulumi.Input<pulumi.Input<string>[]> }>, platformVersion?: pulumi.Input<string>, taskCount?: pulumi.Input<number>, taskDefinitionArn: pulumi.Input<string> }>;
/**
* Valid JSON text passed to the target.
*/
readonly input?: pulumi.Input<string>;
/**
* The value of the [JSONPath](http://goessner.net/articles/JsonPath/)
* that is used for extracting part of the matched event when passing it to the target.
*/
readonly inputPath?: pulumi.Input<string>;
/**
* Parameters used when you are providing a custom input to a target based on certain event data.
*/
readonly inputTransformer?: pulumi.Input<{ inputPaths?: pulumi.Input<{[key: string]: any}>, inputTemplate: pulumi.Input<string> }>;
/**
* Parameters used when you are using the rule to invoke an Amazon Kinesis Stream. Documented below. A maximum of 1 are allowed.
*/
readonly kinesisTarget?: pulumi.Input<{ partitionKeyPath?: pulumi.Input<string> }>;
/**
* The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. Required if `ecs_target` is used.
*/
readonly roleArn?: pulumi.Input<string>;
/**
* The name of the rule you want to add targets to.
*/
readonly rule: pulumi.Input<string>;
/**
* Parameters used when you are using the rule to invoke Amazon EC2 Run Command. Documented below. A maximum of 5 are allowed.
*/
readonly runCommandTargets?: pulumi.Input<pulumi.Input<{ key: pulumi.Input<string>, values: pulumi.Input<pulumi.Input<string>[]> }>[]>;
/**
* Parameters used when you are using the rule to invoke an Amazon SQS Queue. Documented below. A maximum of 1 are allowed.
*/
readonly sqsTarget?: pulumi.Input<{ messageGroupId?: pulumi.Input<string> }>;
/**
* The unique target assignment ID. If missing, will generate a random, unique id.
*/
readonly targetId?: pulumi.Input<string>;
}