/
policy.go
652 lines (597 loc) · 31.3 KB
/
policy.go
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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***
package appautoscaling
import (
"context"
"reflect"
"errors"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
// Provides an Application AutoScaling Policy resource.
//
// ## Example Usage
// ### DynamoDB Table Autoscaling
//
// ```go
// package main
//
// import (
//
// "github.com/pulumi/pulumi-aws/sdk/v5/go/aws/appautoscaling"
// "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
// func main() {
// pulumi.Run(func(ctx *pulumi.Context) error {
// dynamodbTableReadTarget, err := appautoscaling.NewTarget(ctx, "dynamodbTableReadTarget", &appautoscaling.TargetArgs{
// MaxCapacity: pulumi.Int(100),
// MinCapacity: pulumi.Int(5),
// ResourceId: pulumi.String("table/tableName"),
// ScalableDimension: pulumi.String("dynamodb:table:ReadCapacityUnits"),
// ServiceNamespace: pulumi.String("dynamodb"),
// })
// if err != nil {
// return err
// }
// _, err = appautoscaling.NewPolicy(ctx, "dynamodbTableReadPolicy", &appautoscaling.PolicyArgs{
// PolicyType: pulumi.String("TargetTrackingScaling"),
// ResourceId: dynamodbTableReadTarget.ResourceId,
// ScalableDimension: dynamodbTableReadTarget.ScalableDimension,
// ServiceNamespace: dynamodbTableReadTarget.ServiceNamespace,
// TargetTrackingScalingPolicyConfiguration: &appautoscaling.PolicyTargetTrackingScalingPolicyConfigurationArgs{
// PredefinedMetricSpecification: &appautoscaling.PolicyTargetTrackingScalingPolicyConfigurationPredefinedMetricSpecificationArgs{
// PredefinedMetricType: pulumi.String("DynamoDBReadCapacityUtilization"),
// },
// TargetValue: pulumi.Float64(70),
// },
// })
// if err != nil {
// return err
// }
// return nil
// })
// }
//
// ```
// ### ECS Service Autoscaling
//
// ```go
// package main
//
// import (
//
// "github.com/pulumi/pulumi-aws/sdk/v5/go/aws/appautoscaling"
// "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
// func main() {
// pulumi.Run(func(ctx *pulumi.Context) error {
// ecsTarget, err := appautoscaling.NewTarget(ctx, "ecsTarget", &appautoscaling.TargetArgs{
// MaxCapacity: pulumi.Int(4),
// MinCapacity: pulumi.Int(1),
// ResourceId: pulumi.String("service/clusterName/serviceName"),
// ScalableDimension: pulumi.String("ecs:service:DesiredCount"),
// ServiceNamespace: pulumi.String("ecs"),
// })
// if err != nil {
// return err
// }
// _, err = appautoscaling.NewPolicy(ctx, "ecsPolicy", &appautoscaling.PolicyArgs{
// PolicyType: pulumi.String("StepScaling"),
// ResourceId: ecsTarget.ResourceId,
// ScalableDimension: ecsTarget.ScalableDimension,
// ServiceNamespace: ecsTarget.ServiceNamespace,
// StepScalingPolicyConfiguration: &appautoscaling.PolicyStepScalingPolicyConfigurationArgs{
// AdjustmentType: pulumi.String("ChangeInCapacity"),
// Cooldown: pulumi.Int(60),
// MetricAggregationType: pulumi.String("Maximum"),
// StepAdjustments: appautoscaling.PolicyStepScalingPolicyConfigurationStepAdjustmentArray{
// &appautoscaling.PolicyStepScalingPolicyConfigurationStepAdjustmentArgs{
// MetricIntervalUpperBound: pulumi.String("0"),
// ScalingAdjustment: -1,
// },
// },
// },
// })
// if err != nil {
// return err
// }
// return nil
// })
// }
//
// ```
// ### Preserve desired count when updating an autoscaled ECS Service
//
// ```go
// package main
//
// import (
//
// "github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ecs"
// "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
// func main() {
// pulumi.Run(func(ctx *pulumi.Context) error {
// _, err := ecs.NewService(ctx, "ecsService", &ecs.ServiceArgs{
// Cluster: pulumi.String("clusterName"),
// TaskDefinition: pulumi.String("taskDefinitionFamily:1"),
// DesiredCount: pulumi.Int(2),
// })
// if err != nil {
// return err
// }
// return nil
// })
// }
//
// ```
// ### Aurora Read Replica Autoscaling
//
// ```go
// package main
//
// import (
//
// "fmt"
//
// "github.com/pulumi/pulumi-aws/sdk/v5/go/aws/appautoscaling"
// "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
// func main() {
// pulumi.Run(func(ctx *pulumi.Context) error {
// replicasTarget, err := appautoscaling.NewTarget(ctx, "replicasTarget", &appautoscaling.TargetArgs{
// ServiceNamespace: pulumi.String("rds"),
// ScalableDimension: pulumi.String("rds:cluster:ReadReplicaCount"),
// ResourceId: pulumi.String(fmt.Sprintf("cluster:%v", aws_rds_cluster.Example.Id)),
// MinCapacity: pulumi.Int(1),
// MaxCapacity: pulumi.Int(15),
// })
// if err != nil {
// return err
// }
// _, err = appautoscaling.NewPolicy(ctx, "replicasPolicy", &appautoscaling.PolicyArgs{
// ServiceNamespace: replicasTarget.ServiceNamespace,
// ScalableDimension: replicasTarget.ScalableDimension,
// ResourceId: replicasTarget.ResourceId,
// PolicyType: pulumi.String("TargetTrackingScaling"),
// TargetTrackingScalingPolicyConfiguration: &appautoscaling.PolicyTargetTrackingScalingPolicyConfigurationArgs{
// PredefinedMetricSpecification: &appautoscaling.PolicyTargetTrackingScalingPolicyConfigurationPredefinedMetricSpecificationArgs{
// PredefinedMetricType: pulumi.String("RDSReaderAverageCPUUtilization"),
// },
// TargetValue: pulumi.Float64(75),
// ScaleInCooldown: pulumi.Int(300),
// ScaleOutCooldown: pulumi.Int(300),
// },
// })
// if err != nil {
// return err
// }
// return nil
// })
// }
//
// ```
// ### Create target tracking scaling policy using metric math
//
// ```go
// package main
//
// import (
//
// "github.com/pulumi/pulumi-aws/sdk/v5/go/aws/appautoscaling"
// "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
// func main() {
// pulumi.Run(func(ctx *pulumi.Context) error {
// ecsTarget, err := appautoscaling.NewTarget(ctx, "ecsTarget", &appautoscaling.TargetArgs{
// MaxCapacity: pulumi.Int(4),
// MinCapacity: pulumi.Int(1),
// ResourceId: pulumi.String("service/clusterName/serviceName"),
// ScalableDimension: pulumi.String("ecs:service:DesiredCount"),
// ServiceNamespace: pulumi.String("ecs"),
// })
// if err != nil {
// return err
// }
// _, err = appautoscaling.NewPolicy(ctx, "example", &appautoscaling.PolicyArgs{
// PolicyType: pulumi.String("TargetTrackingScaling"),
// ResourceId: ecsTarget.ResourceId,
// ScalableDimension: ecsTarget.ScalableDimension,
// ServiceNamespace: ecsTarget.ServiceNamespace,
// TargetTrackingScalingPolicyConfiguration: &appautoscaling.PolicyTargetTrackingScalingPolicyConfigurationArgs{
// TargetValue: pulumi.Float64(100),
// CustomizedMetricSpecification: &appautoscaling.PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationArgs{
// Metrics: appautoscaling.PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricArray{
// &appautoscaling.PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricArgs{
// Label: pulumi.String("Get the queue size (the number of messages waiting to be processed)"),
// Id: pulumi.String("m1"),
// MetricStat: &appautoscaling.PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricMetricStatArgs{
// Metric: &appautoscaling.PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricMetricStatMetricArgs{
// MetricName: pulumi.String("ApproximateNumberOfMessagesVisible"),
// Namespace: pulumi.String("AWS/SQS"),
// Dimensions: appautoscaling.PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricMetricStatMetricDimensionArray{
// &appautoscaling.PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricMetricStatMetricDimensionArgs{
// Name: pulumi.String("QueueName"),
// Value: pulumi.String("my-queue"),
// },
// },
// },
// Stat: pulumi.String("Sum"),
// },
// ReturnData: pulumi.Bool(false),
// },
// &appautoscaling.PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricArgs{
// Label: pulumi.String("Get the ECS running task count (the number of currently running tasks)"),
// Id: pulumi.String("m2"),
// MetricStat: &appautoscaling.PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricMetricStatArgs{
// Metric: &appautoscaling.PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricMetricStatMetricArgs{
// MetricName: pulumi.String("RunningTaskCount"),
// Namespace: pulumi.String("ECS/ContainerInsights"),
// Dimensions: appautoscaling.PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricMetricStatMetricDimensionArray{
// &appautoscaling.PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricMetricStatMetricDimensionArgs{
// Name: pulumi.String("ClusterName"),
// Value: pulumi.String("default"),
// },
// &appautoscaling.PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricMetricStatMetricDimensionArgs{
// Name: pulumi.String("ServiceName"),
// Value: pulumi.String("web-app"),
// },
// },
// },
// Stat: pulumi.String("Average"),
// },
// ReturnData: pulumi.Bool(false),
// },
// &appautoscaling.PolicyTargetTrackingScalingPolicyConfigurationCustomizedMetricSpecificationMetricArgs{
// Label: pulumi.String("Calculate the backlog per instance"),
// Id: pulumi.String("e1"),
// Expression: pulumi.String("m1 / m2"),
// ReturnData: pulumi.Bool(true),
// },
// },
// },
// },
// })
// if err != nil {
// return err
// }
// return nil
// })
// }
//
// ```
// ### MSK / Kafka Autoscaling
//
// ```go
// package main
//
// import (
//
// "github.com/pulumi/pulumi-aws/sdk/v5/go/aws/appautoscaling"
// "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
// func main() {
// pulumi.Run(func(ctx *pulumi.Context) error {
// mskTarget, err := appautoscaling.NewTarget(ctx, "mskTarget", &appautoscaling.TargetArgs{
// ServiceNamespace: pulumi.String("kafka"),
// ScalableDimension: pulumi.String("kafka:broker-storage:VolumeSize"),
// ResourceId: pulumi.Any(aws_msk_cluster.Example.Arn),
// MinCapacity: pulumi.Int(1),
// MaxCapacity: pulumi.Int(8),
// })
// if err != nil {
// return err
// }
// _, err = appautoscaling.NewPolicy(ctx, "targets", &appautoscaling.PolicyArgs{
// ServiceNamespace: mskTarget.ServiceNamespace,
// ScalableDimension: mskTarget.ScalableDimension,
// ResourceId: mskTarget.ResourceId,
// PolicyType: pulumi.String("TargetTrackingScaling"),
// TargetTrackingScalingPolicyConfiguration: &appautoscaling.PolicyTargetTrackingScalingPolicyConfigurationArgs{
// PredefinedMetricSpecification: &appautoscaling.PolicyTargetTrackingScalingPolicyConfigurationPredefinedMetricSpecificationArgs{
// PredefinedMetricType: pulumi.String("KafkaBrokerStorageUtilization"),
// },
// TargetValue: pulumi.Float64(55),
// },
// })
// if err != nil {
// return err
// }
// return nil
// })
// }
//
// ```
//
// ## Import
//
// Application AutoScaling Policy can be imported using the `service-namespace` , `resource-id`, `scalable-dimension` and `policy-name` separated by `/`.
//
// ```sh
//
// $ pulumi import aws:appautoscaling/policy:Policy test-policy service-namespace/resource-id/scalable-dimension/policy-name
//
// ```
type Policy struct {
pulumi.CustomResourceState
// List of CloudWatch alarm ARNs associated with the scaling policy.
AlarmArns pulumi.StringArrayOutput `pulumi:"alarmArns"`
// ARN assigned by AWS to the scaling policy.
Arn pulumi.StringOutput `pulumi:"arn"`
// Name of the policy. Must be between 1 and 255 characters in length.
Name pulumi.StringOutput `pulumi:"name"`
// Policy type. Valid values are `StepScaling` and `TargetTrackingScaling`. Defaults to `StepScaling`. Certain services only support only one policy type. For more information see the [Target Tracking Scaling Policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and [Step Scaling Policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) documentation.
PolicyType pulumi.StringPtrOutput `pulumi:"policyType"`
// Resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the `ResourceId` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html)
ResourceId pulumi.StringOutput `pulumi:"resourceId"`
// Scalable dimension of the scalable target. Documentation can be found in the `ScalableDimension` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html)
ScalableDimension pulumi.StringOutput `pulumi:"scalableDimension"`
// AWS service namespace of the scalable target. Documentation can be found in the `ServiceNamespace` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html)
ServiceNamespace pulumi.StringOutput `pulumi:"serviceNamespace"`
// Step scaling policy configuration, requires `policyType = "StepScaling"` (default). See supported fields below.
StepScalingPolicyConfiguration PolicyStepScalingPolicyConfigurationPtrOutput `pulumi:"stepScalingPolicyConfiguration"`
// Target tracking policy, requires `policyType = "TargetTrackingScaling"`. See supported fields below.
TargetTrackingScalingPolicyConfiguration PolicyTargetTrackingScalingPolicyConfigurationPtrOutput `pulumi:"targetTrackingScalingPolicyConfiguration"`
}
// NewPolicy registers a new resource with the given unique name, arguments, and options.
func NewPolicy(ctx *pulumi.Context,
name string, args *PolicyArgs, opts ...pulumi.ResourceOption) (*Policy, error) {
if args == nil {
return nil, errors.New("missing one or more required arguments")
}
if args.ResourceId == nil {
return nil, errors.New("invalid value for required argument 'ResourceId'")
}
if args.ScalableDimension == nil {
return nil, errors.New("invalid value for required argument 'ScalableDimension'")
}
if args.ServiceNamespace == nil {
return nil, errors.New("invalid value for required argument 'ServiceNamespace'")
}
var resource Policy
err := ctx.RegisterResource("aws:appautoscaling/policy:Policy", name, args, &resource, opts...)
if err != nil {
return nil, err
}
return &resource, nil
}
// GetPolicy gets an existing Policy resource's state with the given name, ID, and optional
// state properties that are used to uniquely qualify the lookup (nil if not required).
func GetPolicy(ctx *pulumi.Context,
name string, id pulumi.IDInput, state *PolicyState, opts ...pulumi.ResourceOption) (*Policy, error) {
var resource Policy
err := ctx.ReadResource("aws:appautoscaling/policy:Policy", name, id, state, &resource, opts...)
if err != nil {
return nil, err
}
return &resource, nil
}
// Input properties used for looking up and filtering Policy resources.
type policyState struct {
// List of CloudWatch alarm ARNs associated with the scaling policy.
AlarmArns []string `pulumi:"alarmArns"`
// ARN assigned by AWS to the scaling policy.
Arn *string `pulumi:"arn"`
// Name of the policy. Must be between 1 and 255 characters in length.
Name *string `pulumi:"name"`
// Policy type. Valid values are `StepScaling` and `TargetTrackingScaling`. Defaults to `StepScaling`. Certain services only support only one policy type. For more information see the [Target Tracking Scaling Policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and [Step Scaling Policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) documentation.
PolicyType *string `pulumi:"policyType"`
// Resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the `ResourceId` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html)
ResourceId *string `pulumi:"resourceId"`
// Scalable dimension of the scalable target. Documentation can be found in the `ScalableDimension` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html)
ScalableDimension *string `pulumi:"scalableDimension"`
// AWS service namespace of the scalable target. Documentation can be found in the `ServiceNamespace` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html)
ServiceNamespace *string `pulumi:"serviceNamespace"`
// Step scaling policy configuration, requires `policyType = "StepScaling"` (default). See supported fields below.
StepScalingPolicyConfiguration *PolicyStepScalingPolicyConfiguration `pulumi:"stepScalingPolicyConfiguration"`
// Target tracking policy, requires `policyType = "TargetTrackingScaling"`. See supported fields below.
TargetTrackingScalingPolicyConfiguration *PolicyTargetTrackingScalingPolicyConfiguration `pulumi:"targetTrackingScalingPolicyConfiguration"`
}
type PolicyState struct {
// List of CloudWatch alarm ARNs associated with the scaling policy.
AlarmArns pulumi.StringArrayInput
// ARN assigned by AWS to the scaling policy.
Arn pulumi.StringPtrInput
// Name of the policy. Must be between 1 and 255 characters in length.
Name pulumi.StringPtrInput
// Policy type. Valid values are `StepScaling` and `TargetTrackingScaling`. Defaults to `StepScaling`. Certain services only support only one policy type. For more information see the [Target Tracking Scaling Policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and [Step Scaling Policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) documentation.
PolicyType pulumi.StringPtrInput
// Resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the `ResourceId` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html)
ResourceId pulumi.StringPtrInput
// Scalable dimension of the scalable target. Documentation can be found in the `ScalableDimension` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html)
ScalableDimension pulumi.StringPtrInput
// AWS service namespace of the scalable target. Documentation can be found in the `ServiceNamespace` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html)
ServiceNamespace pulumi.StringPtrInput
// Step scaling policy configuration, requires `policyType = "StepScaling"` (default). See supported fields below.
StepScalingPolicyConfiguration PolicyStepScalingPolicyConfigurationPtrInput
// Target tracking policy, requires `policyType = "TargetTrackingScaling"`. See supported fields below.
TargetTrackingScalingPolicyConfiguration PolicyTargetTrackingScalingPolicyConfigurationPtrInput
}
func (PolicyState) ElementType() reflect.Type {
return reflect.TypeOf((*policyState)(nil)).Elem()
}
type policyArgs struct {
// Name of the policy. Must be between 1 and 255 characters in length.
Name *string `pulumi:"name"`
// Policy type. Valid values are `StepScaling` and `TargetTrackingScaling`. Defaults to `StepScaling`. Certain services only support only one policy type. For more information see the [Target Tracking Scaling Policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and [Step Scaling Policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) documentation.
PolicyType *string `pulumi:"policyType"`
// Resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the `ResourceId` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html)
ResourceId string `pulumi:"resourceId"`
// Scalable dimension of the scalable target. Documentation can be found in the `ScalableDimension` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html)
ScalableDimension string `pulumi:"scalableDimension"`
// AWS service namespace of the scalable target. Documentation can be found in the `ServiceNamespace` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html)
ServiceNamespace string `pulumi:"serviceNamespace"`
// Step scaling policy configuration, requires `policyType = "StepScaling"` (default). See supported fields below.
StepScalingPolicyConfiguration *PolicyStepScalingPolicyConfiguration `pulumi:"stepScalingPolicyConfiguration"`
// Target tracking policy, requires `policyType = "TargetTrackingScaling"`. See supported fields below.
TargetTrackingScalingPolicyConfiguration *PolicyTargetTrackingScalingPolicyConfiguration `pulumi:"targetTrackingScalingPolicyConfiguration"`
}
// The set of arguments for constructing a Policy resource.
type PolicyArgs struct {
// Name of the policy. Must be between 1 and 255 characters in length.
Name pulumi.StringPtrInput
// Policy type. Valid values are `StepScaling` and `TargetTrackingScaling`. Defaults to `StepScaling`. Certain services only support only one policy type. For more information see the [Target Tracking Scaling Policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and [Step Scaling Policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) documentation.
PolicyType pulumi.StringPtrInput
// Resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the `ResourceId` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html)
ResourceId pulumi.StringInput
// Scalable dimension of the scalable target. Documentation can be found in the `ScalableDimension` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html)
ScalableDimension pulumi.StringInput
// AWS service namespace of the scalable target. Documentation can be found in the `ServiceNamespace` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html)
ServiceNamespace pulumi.StringInput
// Step scaling policy configuration, requires `policyType = "StepScaling"` (default). See supported fields below.
StepScalingPolicyConfiguration PolicyStepScalingPolicyConfigurationPtrInput
// Target tracking policy, requires `policyType = "TargetTrackingScaling"`. See supported fields below.
TargetTrackingScalingPolicyConfiguration PolicyTargetTrackingScalingPolicyConfigurationPtrInput
}
func (PolicyArgs) ElementType() reflect.Type {
return reflect.TypeOf((*policyArgs)(nil)).Elem()
}
type PolicyInput interface {
pulumi.Input
ToPolicyOutput() PolicyOutput
ToPolicyOutputWithContext(ctx context.Context) PolicyOutput
}
func (*Policy) ElementType() reflect.Type {
return reflect.TypeOf((**Policy)(nil)).Elem()
}
func (i *Policy) ToPolicyOutput() PolicyOutput {
return i.ToPolicyOutputWithContext(context.Background())
}
func (i *Policy) ToPolicyOutputWithContext(ctx context.Context) PolicyOutput {
return pulumi.ToOutputWithContext(ctx, i).(PolicyOutput)
}
// PolicyArrayInput is an input type that accepts PolicyArray and PolicyArrayOutput values.
// You can construct a concrete instance of `PolicyArrayInput` via:
//
// PolicyArray{ PolicyArgs{...} }
type PolicyArrayInput interface {
pulumi.Input
ToPolicyArrayOutput() PolicyArrayOutput
ToPolicyArrayOutputWithContext(context.Context) PolicyArrayOutput
}
type PolicyArray []PolicyInput
func (PolicyArray) ElementType() reflect.Type {
return reflect.TypeOf((*[]*Policy)(nil)).Elem()
}
func (i PolicyArray) ToPolicyArrayOutput() PolicyArrayOutput {
return i.ToPolicyArrayOutputWithContext(context.Background())
}
func (i PolicyArray) ToPolicyArrayOutputWithContext(ctx context.Context) PolicyArrayOutput {
return pulumi.ToOutputWithContext(ctx, i).(PolicyArrayOutput)
}
// PolicyMapInput is an input type that accepts PolicyMap and PolicyMapOutput values.
// You can construct a concrete instance of `PolicyMapInput` via:
//
// PolicyMap{ "key": PolicyArgs{...} }
type PolicyMapInput interface {
pulumi.Input
ToPolicyMapOutput() PolicyMapOutput
ToPolicyMapOutputWithContext(context.Context) PolicyMapOutput
}
type PolicyMap map[string]PolicyInput
func (PolicyMap) ElementType() reflect.Type {
return reflect.TypeOf((*map[string]*Policy)(nil)).Elem()
}
func (i PolicyMap) ToPolicyMapOutput() PolicyMapOutput {
return i.ToPolicyMapOutputWithContext(context.Background())
}
func (i PolicyMap) ToPolicyMapOutputWithContext(ctx context.Context) PolicyMapOutput {
return pulumi.ToOutputWithContext(ctx, i).(PolicyMapOutput)
}
type PolicyOutput struct{ *pulumi.OutputState }
func (PolicyOutput) ElementType() reflect.Type {
return reflect.TypeOf((**Policy)(nil)).Elem()
}
func (o PolicyOutput) ToPolicyOutput() PolicyOutput {
return o
}
func (o PolicyOutput) ToPolicyOutputWithContext(ctx context.Context) PolicyOutput {
return o
}
// List of CloudWatch alarm ARNs associated with the scaling policy.
func (o PolicyOutput) AlarmArns() pulumi.StringArrayOutput {
return o.ApplyT(func(v *Policy) pulumi.StringArrayOutput { return v.AlarmArns }).(pulumi.StringArrayOutput)
}
// ARN assigned by AWS to the scaling policy.
func (o PolicyOutput) Arn() pulumi.StringOutput {
return o.ApplyT(func(v *Policy) pulumi.StringOutput { return v.Arn }).(pulumi.StringOutput)
}
// Name of the policy. Must be between 1 and 255 characters in length.
func (o PolicyOutput) Name() pulumi.StringOutput {
return o.ApplyT(func(v *Policy) pulumi.StringOutput { return v.Name }).(pulumi.StringOutput)
}
// Policy type. Valid values are `StepScaling` and `TargetTrackingScaling`. Defaults to `StepScaling`. Certain services only support only one policy type. For more information see the [Target Tracking Scaling Policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and [Step Scaling Policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) documentation.
func (o PolicyOutput) PolicyType() pulumi.StringPtrOutput {
return o.ApplyT(func(v *Policy) pulumi.StringPtrOutput { return v.PolicyType }).(pulumi.StringPtrOutput)
}
// Resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the `ResourceId` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html)
func (o PolicyOutput) ResourceId() pulumi.StringOutput {
return o.ApplyT(func(v *Policy) pulumi.StringOutput { return v.ResourceId }).(pulumi.StringOutput)
}
// Scalable dimension of the scalable target. Documentation can be found in the `ScalableDimension` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html)
func (o PolicyOutput) ScalableDimension() pulumi.StringOutput {
return o.ApplyT(func(v *Policy) pulumi.StringOutput { return v.ScalableDimension }).(pulumi.StringOutput)
}
// AWS service namespace of the scalable target. Documentation can be found in the `ServiceNamespace` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html)
func (o PolicyOutput) ServiceNamespace() pulumi.StringOutput {
return o.ApplyT(func(v *Policy) pulumi.StringOutput { return v.ServiceNamespace }).(pulumi.StringOutput)
}
// Step scaling policy configuration, requires `policyType = "StepScaling"` (default). See supported fields below.
func (o PolicyOutput) StepScalingPolicyConfiguration() PolicyStepScalingPolicyConfigurationPtrOutput {
return o.ApplyT(func(v *Policy) PolicyStepScalingPolicyConfigurationPtrOutput { return v.StepScalingPolicyConfiguration }).(PolicyStepScalingPolicyConfigurationPtrOutput)
}
// Target tracking policy, requires `policyType = "TargetTrackingScaling"`. See supported fields below.
func (o PolicyOutput) TargetTrackingScalingPolicyConfiguration() PolicyTargetTrackingScalingPolicyConfigurationPtrOutput {
return o.ApplyT(func(v *Policy) PolicyTargetTrackingScalingPolicyConfigurationPtrOutput {
return v.TargetTrackingScalingPolicyConfiguration
}).(PolicyTargetTrackingScalingPolicyConfigurationPtrOutput)
}
type PolicyArrayOutput struct{ *pulumi.OutputState }
func (PolicyArrayOutput) ElementType() reflect.Type {
return reflect.TypeOf((*[]*Policy)(nil)).Elem()
}
func (o PolicyArrayOutput) ToPolicyArrayOutput() PolicyArrayOutput {
return o
}
func (o PolicyArrayOutput) ToPolicyArrayOutputWithContext(ctx context.Context) PolicyArrayOutput {
return o
}
func (o PolicyArrayOutput) Index(i pulumi.IntInput) PolicyOutput {
return pulumi.All(o, i).ApplyT(func(vs []interface{}) *Policy {
return vs[0].([]*Policy)[vs[1].(int)]
}).(PolicyOutput)
}
type PolicyMapOutput struct{ *pulumi.OutputState }
func (PolicyMapOutput) ElementType() reflect.Type {
return reflect.TypeOf((*map[string]*Policy)(nil)).Elem()
}
func (o PolicyMapOutput) ToPolicyMapOutput() PolicyMapOutput {
return o
}
func (o PolicyMapOutput) ToPolicyMapOutputWithContext(ctx context.Context) PolicyMapOutput {
return o
}
func (o PolicyMapOutput) MapIndex(k pulumi.StringInput) PolicyOutput {
return pulumi.All(o, k).ApplyT(func(vs []interface{}) *Policy {
return vs[0].(map[string]*Policy)[vs[1].(string)]
}).(PolicyOutput)
}
func init() {
pulumi.RegisterInputType(reflect.TypeOf((*PolicyInput)(nil)).Elem(), &Policy{})
pulumi.RegisterInputType(reflect.TypeOf((*PolicyArrayInput)(nil)).Elem(), PolicyArray{})
pulumi.RegisterInputType(reflect.TypeOf((*PolicyMapInput)(nil)).Elem(), PolicyMap{})
pulumi.RegisterOutputType(PolicyOutput{})
pulumi.RegisterOutputType(PolicyArrayOutput{})
pulumi.RegisterOutputType(PolicyMapOutput{})
}