-
Notifications
You must be signed in to change notification settings - Fork 17
/
awsapplicationautoscaling.go
3023 lines (2695 loc) · 104 KB
/
awsapplicationautoscaling.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
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package awsapplicationautoscaling
import (
"time"
_init_ "github.com/aws/aws-cdk-go/awscdk/v2/jsii"
_jsii_ "github.com/aws/jsii-runtime-go/runtime"
"github.com/aws/aws-cdk-go/awscdk/v2"
"github.com/aws/aws-cdk-go/awscdk/v2/awsapplicationautoscaling/internal"
"github.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch"
"github.com/aws/aws-cdk-go/awscdk/v2/awsiam"
"github.com/aws/constructs-go/constructs/v10"
)
// An adjustment.
//
// TODO: EXAMPLE
//
type AdjustmentTier struct {
// What number to adjust the capacity with.
//
// The number is interpeted as an added capacity, a new fixed capacity or an
// added percentage depending on the AdjustmentType value of the
// StepScalingPolicy.
//
// Can be positive or negative.
Adjustment *float64 `json:"adjustment"`
// Lower bound where this scaling tier applies.
//
// The scaling tier applies if the difference between the metric
// value and its alarm threshold is higher than this value.
LowerBound *float64 `json:"lowerBound"`
// Upper bound where this scaling tier applies.
//
// The scaling tier applies if the difference between the metric
// value and its alarm threshold is lower than this value.
UpperBound *float64 `json:"upperBound"`
}
// How adjustment numbers are interpreted.
//
// TODO: EXAMPLE
//
type AdjustmentType string
const (
AdjustmentType_CHANGE_IN_CAPACITY AdjustmentType = "CHANGE_IN_CAPACITY"
AdjustmentType_PERCENT_CHANGE_IN_CAPACITY AdjustmentType = "PERCENT_CHANGE_IN_CAPACITY"
AdjustmentType_EXACT_CAPACITY AdjustmentType = "EXACT_CAPACITY"
)
// Represent an attribute for which autoscaling can be configured.
//
// This class is basically a light wrapper around ScalableTarget, but with
// all methods protected instead of public so they can be selectively
// exposed and/or more specific versions of them can be exposed by derived
// classes for individual services support autoscaling.
//
// Typical use cases:
//
// - Hide away the PredefinedMetric enum for target tracking policies.
// - Don't expose all scaling methods (for example Dynamo tables don't support
// Step Scaling, so the Dynamo subclass won't expose this method).
type BaseScalableAttribute interface {
constructs.Construct
Node() constructs.Node
Props() *BaseScalableAttributeProps
DoScaleOnMetric(id *string, props *BasicStepScalingPolicyProps)
DoScaleOnSchedule(id *string, props *ScalingSchedule)
DoScaleToTrackMetric(id *string, props *BasicTargetTrackingScalingPolicyProps)
ToString() *string
}
// The jsii proxy struct for BaseScalableAttribute
type jsiiProxy_BaseScalableAttribute struct {
internal.Type__constructsConstruct
}
func (j *jsiiProxy_BaseScalableAttribute) Node() constructs.Node {
var returns constructs.Node
_jsii_.Get(
j,
"node",
&returns,
)
return returns
}
func (j *jsiiProxy_BaseScalableAttribute) Props() *BaseScalableAttributeProps {
var returns *BaseScalableAttributeProps
_jsii_.Get(
j,
"props",
&returns,
)
return returns
}
func NewBaseScalableAttribute_Override(b BaseScalableAttribute, scope constructs.Construct, id *string, props *BaseScalableAttributeProps) {
_init_.Initialize()
_jsii_.Create(
"aws-cdk-lib.aws_applicationautoscaling.BaseScalableAttribute",
[]interface{}{scope, id, props},
b,
)
}
// Checks if `x` is a construct.
//
// Returns: true if `x` is an object created from a class which extends `Construct`.
// Deprecated: use `x instanceof Construct` instead
func BaseScalableAttribute_IsConstruct(x interface{}) *bool {
_init_.Initialize()
var returns *bool
_jsii_.StaticInvoke(
"aws-cdk-lib.aws_applicationautoscaling.BaseScalableAttribute",
"isConstruct",
[]interface{}{x},
&returns,
)
return returns
}
// Scale out or in based on a metric value.
func (b *jsiiProxy_BaseScalableAttribute) DoScaleOnMetric(id *string, props *BasicStepScalingPolicyProps) {
_jsii_.InvokeVoid(
b,
"doScaleOnMetric",
[]interface{}{id, props},
)
}
// Scale out or in based on time.
func (b *jsiiProxy_BaseScalableAttribute) DoScaleOnSchedule(id *string, props *ScalingSchedule) {
_jsii_.InvokeVoid(
b,
"doScaleOnSchedule",
[]interface{}{id, props},
)
}
// Scale out or in in order to keep a metric around a target value.
func (b *jsiiProxy_BaseScalableAttribute) DoScaleToTrackMetric(id *string, props *BasicTargetTrackingScalingPolicyProps) {
_jsii_.InvokeVoid(
b,
"doScaleToTrackMetric",
[]interface{}{id, props},
)
}
// Returns a string representation of this construct.
func (b *jsiiProxy_BaseScalableAttribute) ToString() *string {
var returns *string
_jsii_.Invoke(
b,
"toString",
nil, // no parameters
&returns,
)
return returns
}
// Properties for a ScalableTableAttribute.
//
// TODO: EXAMPLE
//
type BaseScalableAttributeProps struct {
// Maximum capacity to scale to.
MaxCapacity *float64 `json:"maxCapacity"`
// Minimum capacity to scale to.
MinCapacity *float64 `json:"minCapacity"`
// Scalable dimension of the attribute.
Dimension *string `json:"dimension"`
// Resource ID of the attribute.
ResourceId *string `json:"resourceId"`
// Role to use for scaling.
Role awsiam.IRole `json:"role"`
// Service namespace of the scalable attribute.
ServiceNamespace ServiceNamespace `json:"serviceNamespace"`
}
// Base interface for target tracking props.
//
// Contains the attributes that are common to target tracking policies,
// except the ones relating to the metric and to the scalable target.
//
// This interface is reused by more specific target tracking props objects
// in other services.
//
// TODO: EXAMPLE
//
type BaseTargetTrackingProps struct {
// Indicates whether scale in by the target tracking policy is disabled.
//
// If the value is true, scale in is disabled and the target tracking policy
// won't remove capacity from the scalable resource. Otherwise, scale in is
// enabled and the target tracking policy can remove capacity from the
// scalable resource.
DisableScaleIn *bool `json:"disableScaleIn"`
// A name for the scaling policy.
PolicyName *string `json:"policyName"`
// Period after a scale in activity completes before another scale in activity can start.
ScaleInCooldown awscdk.Duration `json:"scaleInCooldown"`
// Period after a scale out activity completes before another scale out activity can start.
ScaleOutCooldown awscdk.Duration `json:"scaleOutCooldown"`
}
// TODO: EXAMPLE
//
type BasicStepScalingPolicyProps struct {
// Metric to scale on.
Metric awscloudwatch.IMetric `json:"metric"`
// The intervals for scaling.
//
// Maps a range of metric values to a particular scaling behavior.
ScalingSteps *[]*ScalingInterval `json:"scalingSteps"`
// How the adjustment numbers inside 'intervals' are interpreted.
AdjustmentType AdjustmentType `json:"adjustmentType"`
// Grace period after scaling activity.
//
// Subsequent scale outs during the cooldown period are squashed so that only
// the biggest scale out happens.
//
// Subsequent scale ins during the cooldown period are ignored.
// See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepScalingPolicyConfiguration.html
//
Cooldown awscdk.Duration `json:"cooldown"`
// The number of data points out of the evaluation periods that must be breaching to trigger a scaling action.
//
// Creates an "M out of N" alarm, where this property is the M and the value set for
// `evaluationPeriods` is the N value.
//
// Only has meaning if `evaluationPeriods != 1`.
DatapointsToAlarm *float64 `json:"datapointsToAlarm"`
// How many evaluation periods of the metric to wait before triggering a scaling action.
//
// Raising this value can be used to smooth out the metric, at the expense
// of slower response times.
//
// If `datapointsToAlarm` is not set, then all data points in the evaluation period
// must meet the criteria to trigger a scaling action.
EvaluationPeriods *float64 `json:"evaluationPeriods"`
// Aggregation to apply to all data points over the evaluation periods.
//
// Only has meaning if `evaluationPeriods != 1`.
MetricAggregationType MetricAggregationType `json:"metricAggregationType"`
// Minimum absolute number to adjust capacity with as result of percentage scaling.
//
// Only when using AdjustmentType = PercentChangeInCapacity, this number controls
// the minimum absolute effect size.
MinAdjustmentMagnitude *float64 `json:"minAdjustmentMagnitude"`
}
// Properties for a Target Tracking policy that include the metric but exclude the target.
//
// TODO: EXAMPLE
//
type BasicTargetTrackingScalingPolicyProps struct {
// Indicates whether scale in by the target tracking policy is disabled.
//
// If the value is true, scale in is disabled and the target tracking policy
// won't remove capacity from the scalable resource. Otherwise, scale in is
// enabled and the target tracking policy can remove capacity from the
// scalable resource.
DisableScaleIn *bool `json:"disableScaleIn"`
// A name for the scaling policy.
PolicyName *string `json:"policyName"`
// Period after a scale in activity completes before another scale in activity can start.
ScaleInCooldown awscdk.Duration `json:"scaleInCooldown"`
// Period after a scale out activity completes before another scale out activity can start.
ScaleOutCooldown awscdk.Duration `json:"scaleOutCooldown"`
// The target value for the metric.
TargetValue *float64 `json:"targetValue"`
// A custom metric for application autoscaling.
//
// The metric must track utilization. Scaling out will happen if the metric is higher than
// the target value, scaling in will happen in the metric is lower than the target value.
//
// Exactly one of customMetric or predefinedMetric must be specified.
CustomMetric awscloudwatch.IMetric `json:"customMetric"`
// A predefined metric for application autoscaling.
//
// The metric must track utilization. Scaling out will happen if the metric is higher than
// the target value, scaling in will happen in the metric is lower than the target value.
//
// Exactly one of customMetric or predefinedMetric must be specified.
PredefinedMetric PredefinedMetric `json:"predefinedMetric"`
// Identify the resource associated with the metric type.
//
// Only used for predefined metric ALBRequestCountPerTarget.
//
// Example value: `app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>`
ResourceLabel *string `json:"resourceLabel"`
}
// A CloudFormation `AWS::ApplicationAutoScaling::ScalableTarget`.
//
// The `AWS::ApplicationAutoScaling::ScalableTarget` resource specifies a resource that Application Auto Scaling can scale, such as an AWS::DynamoDB::Table or AWS::ECS::Service resource.
//
// > If the resource that you want Application Auto Scaling to scale is not yet created in your account, add a dependency on the resource when registering it as a scalable target using the [DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) attribute.
//
// For more information, see [RegisterScalableTarget](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html) in the *Application Auto Scaling API Reference* .
//
// TODO: EXAMPLE
//
type CfnScalableTarget interface {
awscdk.CfnResource
awscdk.IInspectable
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
LogicalId() *string
MaxCapacity() *float64
SetMaxCapacity(val *float64)
MinCapacity() *float64
SetMinCapacity(val *float64)
Node() constructs.Node
Ref() *string
ResourceId() *string
SetResourceId(val *string)
RoleArn() *string
SetRoleArn(val *string)
ScalableDimension() *string
SetScalableDimension(val *string)
ScheduledActions() interface{}
SetScheduledActions(val interface{})
ServiceNamespace() *string
SetServiceNamespace(val *string)
Stack() awscdk.Stack
SuspendedState() interface{}
SetSuspendedState(val interface{})
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
// The jsii proxy struct for CfnScalableTarget
type jsiiProxy_CfnScalableTarget struct {
internal.Type__awscdkCfnResource
internal.Type__awscdkIInspectable
}
func (j *jsiiProxy_CfnScalableTarget) CfnOptions() awscdk.ICfnResourceOptions {
var returns awscdk.ICfnResourceOptions
_jsii_.Get(
j,
"cfnOptions",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnScalableTarget) CfnProperties() *map[string]interface{} {
var returns *map[string]interface{}
_jsii_.Get(
j,
"cfnProperties",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnScalableTarget) CfnResourceType() *string {
var returns *string
_jsii_.Get(
j,
"cfnResourceType",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnScalableTarget) CreationStack() *[]*string {
var returns *[]*string
_jsii_.Get(
j,
"creationStack",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnScalableTarget) LogicalId() *string {
var returns *string
_jsii_.Get(
j,
"logicalId",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnScalableTarget) MaxCapacity() *float64 {
var returns *float64
_jsii_.Get(
j,
"maxCapacity",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnScalableTarget) MinCapacity() *float64 {
var returns *float64
_jsii_.Get(
j,
"minCapacity",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnScalableTarget) Node() constructs.Node {
var returns constructs.Node
_jsii_.Get(
j,
"node",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnScalableTarget) Ref() *string {
var returns *string
_jsii_.Get(
j,
"ref",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnScalableTarget) ResourceId() *string {
var returns *string
_jsii_.Get(
j,
"resourceId",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnScalableTarget) RoleArn() *string {
var returns *string
_jsii_.Get(
j,
"roleArn",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnScalableTarget) ScalableDimension() *string {
var returns *string
_jsii_.Get(
j,
"scalableDimension",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnScalableTarget) ScheduledActions() interface{} {
var returns interface{}
_jsii_.Get(
j,
"scheduledActions",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnScalableTarget) ServiceNamespace() *string {
var returns *string
_jsii_.Get(
j,
"serviceNamespace",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnScalableTarget) Stack() awscdk.Stack {
var returns awscdk.Stack
_jsii_.Get(
j,
"stack",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnScalableTarget) SuspendedState() interface{} {
var returns interface{}
_jsii_.Get(
j,
"suspendedState",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnScalableTarget) UpdatedProperites() *map[string]interface{} {
var returns *map[string]interface{}
_jsii_.Get(
j,
"updatedProperites",
&returns,
)
return returns
}
// Create a new `AWS::ApplicationAutoScaling::ScalableTarget`.
func NewCfnScalableTarget(scope constructs.Construct, id *string, props *CfnScalableTargetProps) CfnScalableTarget {
_init_.Initialize()
j := jsiiProxy_CfnScalableTarget{}
_jsii_.Create(
"aws-cdk-lib.aws_applicationautoscaling.CfnScalableTarget",
[]interface{}{scope, id, props},
&j,
)
return &j
}
// Create a new `AWS::ApplicationAutoScaling::ScalableTarget`.
func NewCfnScalableTarget_Override(c CfnScalableTarget, scope constructs.Construct, id *string, props *CfnScalableTargetProps) {
_init_.Initialize()
_jsii_.Create(
"aws-cdk-lib.aws_applicationautoscaling.CfnScalableTarget",
[]interface{}{scope, id, props},
c,
)
}
func (j *jsiiProxy_CfnScalableTarget) SetMaxCapacity(val *float64) {
_jsii_.Set(
j,
"maxCapacity",
val,
)
}
func (j *jsiiProxy_CfnScalableTarget) SetMinCapacity(val *float64) {
_jsii_.Set(
j,
"minCapacity",
val,
)
}
func (j *jsiiProxy_CfnScalableTarget) SetResourceId(val *string) {
_jsii_.Set(
j,
"resourceId",
val,
)
}
func (j *jsiiProxy_CfnScalableTarget) SetRoleArn(val *string) {
_jsii_.Set(
j,
"roleArn",
val,
)
}
func (j *jsiiProxy_CfnScalableTarget) SetScalableDimension(val *string) {
_jsii_.Set(
j,
"scalableDimension",
val,
)
}
func (j *jsiiProxy_CfnScalableTarget) SetScheduledActions(val interface{}) {
_jsii_.Set(
j,
"scheduledActions",
val,
)
}
func (j *jsiiProxy_CfnScalableTarget) SetServiceNamespace(val *string) {
_jsii_.Set(
j,
"serviceNamespace",
val,
)
}
func (j *jsiiProxy_CfnScalableTarget) SetSuspendedState(val interface{}) {
_jsii_.Set(
j,
"suspendedState",
val,
)
}
// Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
//
// Uses duck-typing instead of `instanceof` to allow stack elements from different
// versions of this library to be included in the same stack.
//
// Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnScalableTarget_IsCfnElement(x interface{}) *bool {
_init_.Initialize()
var returns *bool
_jsii_.StaticInvoke(
"aws-cdk-lib.aws_applicationautoscaling.CfnScalableTarget",
"isCfnElement",
[]interface{}{x},
&returns,
)
return returns
}
// Check whether the given construct is a CfnResource.
func CfnScalableTarget_IsCfnResource(construct constructs.IConstruct) *bool {
_init_.Initialize()
var returns *bool
_jsii_.StaticInvoke(
"aws-cdk-lib.aws_applicationautoscaling.CfnScalableTarget",
"isCfnResource",
[]interface{}{construct},
&returns,
)
return returns
}
// Checks if `x` is a construct.
//
// Returns: true if `x` is an object created from a class which extends `Construct`.
// Deprecated: use `x instanceof Construct` instead
func CfnScalableTarget_IsConstruct(x interface{}) *bool {
_init_.Initialize()
var returns *bool
_jsii_.StaticInvoke(
"aws-cdk-lib.aws_applicationautoscaling.CfnScalableTarget",
"isConstruct",
[]interface{}{x},
&returns,
)
return returns
}
func CfnScalableTarget_CFN_RESOURCE_TYPE_NAME() *string {
_init_.Initialize()
var returns *string
_jsii_.StaticGet(
"aws-cdk-lib.aws_applicationautoscaling.CfnScalableTarget",
"CFN_RESOURCE_TYPE_NAME",
&returns,
)
return returns
}
// Syntactic sugar for `addOverride(path, undefined)`.
func (c *jsiiProxy_CfnScalableTarget) AddDeletionOverride(path *string) {
_jsii_.InvokeVoid(
c,
"addDeletionOverride",
[]interface{}{path},
)
}
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
func (c *jsiiProxy_CfnScalableTarget) AddDependsOn(target awscdk.CfnResource) {
_jsii_.InvokeVoid(
c,
"addDependsOn",
[]interface{}{target},
)
}
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
func (c *jsiiProxy_CfnScalableTarget) AddMetadata(key *string, value interface{}) {
_jsii_.InvokeVoid(
c,
"addMetadata",
[]interface{}{key, value},
)
}
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// ```typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// ```
// would add the overrides
// ```json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// ```
func (c *jsiiProxy_CfnScalableTarget) AddOverride(path *string, value interface{}) {
_jsii_.InvokeVoid(
c,
"addOverride",
[]interface{}{path, value},
)
}
// Adds an override that deletes the value of a property from the resource definition.
func (c *jsiiProxy_CfnScalableTarget) AddPropertyDeletionOverride(propertyPath *string) {
_jsii_.InvokeVoid(
c,
"addPropertyDeletionOverride",
[]interface{}{propertyPath},
)
}
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
func (c *jsiiProxy_CfnScalableTarget) AddPropertyOverride(propertyPath *string, value interface{}) {
_jsii_.InvokeVoid(
c,
"addPropertyOverride",
[]interface{}{propertyPath, value},
)
}
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
func (c *jsiiProxy_CfnScalableTarget) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) {
_jsii_.InvokeVoid(
c,
"applyRemovalPolicy",
[]interface{}{policy, options},
)
}
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
func (c *jsiiProxy_CfnScalableTarget) GetAtt(attributeName *string) awscdk.Reference {
var returns awscdk.Reference
_jsii_.Invoke(
c,
"getAtt",
[]interface{}{attributeName},
&returns,
)
return returns
}
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
func (c *jsiiProxy_CfnScalableTarget) GetMetadata(key *string) interface{} {
var returns interface{}
_jsii_.Invoke(
c,
"getMetadata",
[]interface{}{key},
&returns,
)
return returns
}
// Examines the CloudFormation resource and discloses attributes.
func (c *jsiiProxy_CfnScalableTarget) Inspect(inspector awscdk.TreeInspector) {
_jsii_.InvokeVoid(
c,
"inspect",
[]interface{}{inspector},
)
}
// Overrides the auto-generated logical ID with a specific ID.
func (c *jsiiProxy_CfnScalableTarget) OverrideLogicalId(newLogicalId *string) {
_jsii_.InvokeVoid(
c,
"overrideLogicalId",
[]interface{}{newLogicalId},
)
}
func (c *jsiiProxy_CfnScalableTarget) RenderProperties(props *map[string]interface{}) *map[string]interface{} {
var returns *map[string]interface{}
_jsii_.Invoke(
c,
"renderProperties",
[]interface{}{props},
&returns,
)
return returns
}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
func (c *jsiiProxy_CfnScalableTarget) ShouldSynthesize() *bool {
var returns *bool
_jsii_.Invoke(
c,
"shouldSynthesize",
nil, // no parameters
&returns,
)
return returns
}
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource
func (c *jsiiProxy_CfnScalableTarget) ToString() *string {
var returns *string
_jsii_.Invoke(
c,
"toString",
nil, // no parameters
&returns,
)
return returns
}
func (c *jsiiProxy_CfnScalableTarget) ValidateProperties(_properties interface{}) {
_jsii_.InvokeVoid(
c,
"validateProperties",
[]interface{}{_properties},
)
}
// `ScalableTargetAction` specifies the minimum and maximum capacity for the `ScalableTargetAction` property of the [AWS::ApplicationAutoScaling::ScalableTarget ScheduledAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html) property type.
//
// TODO: EXAMPLE
//
type CfnScalableTarget_ScalableTargetActionProperty struct {
// The maximum capacity.
MaxCapacity *float64 `json:"maxCapacity"`
// The minimum capacity.
MinCapacity *float64 `json:"minCapacity"`
}
// `ScheduledAction` is a property of the [AWS::ApplicationAutoScaling::ScalableTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html) resource that specifies a scheduled action for a scalable target.
//
// For more information, see [PutScheduledAction](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PutScheduledAction.html) in the *Application Auto Scaling API Reference* . For more information about scheduled scaling, including the format for cron expressions, see [Scheduled scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html) in the *Application Auto Scaling User Guide* .
//
// TODO: EXAMPLE
//
type CfnScalableTarget_ScheduledActionProperty struct {
// The schedule for this action. The following formats are supported:.
//
// - At expressions - " `at( *yyyy* - *mm* - *dd* T *hh* : *mm* : *ss* )` "
// - Rate expressions - " `rate( *value* *unit* )` "
// - Cron expressions - " `cron( *fields* )` "
//
// At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.
//
// At and cron expressions use Universal Coordinated Time (UTC) by default.
//
// The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
//
// For rate expressions, *value* is a positive integer and *unit* is `minute` | `minutes` | `hour` | `hours` | `day` | `days` .
Schedule *string `json:"schedule"`
// The name of the scheduled action.
//
// This name must be unique among all other scheduled actions on the specified scalable target.
ScheduledActionName *string `json:"scheduledActionName"`
// The date and time that the action is scheduled to end, in UTC.
EndTime interface{} `json:"endTime"`
// The new minimum and maximum capacity.
//
// You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
ScalableTargetAction interface{} `json:"scalableTargetAction"`
// The date and time that the action is scheduled to begin, in UTC.
StartTime interface{} `json:"startTime"`
// The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.
Timezone *string `json:"timezone"`
}
// `SuspendedState` is a property of the [AWS::ApplicationAutoScaling::ScalableTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html) resource that specifies whether the scaling activities for a scalable target are in a suspended state.
//
// TODO: EXAMPLE
//
type CfnScalableTarget_SuspendedStateProperty struct {
// Whether scale in by a target tracking scaling policy or a step scaling policy is suspended.
//
// Set the value to `true` if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is `false` .
DynamicScalingInSuspended interface{} `json:"dynamicScalingInSuspended"`
// Whether scale out by a target tracking scaling policy or a step scaling policy is suspended.
//
// Set the value to `true` if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is `false` .
DynamicScalingOutSuspended interface{} `json:"dynamicScalingOutSuspended"`
// Whether scheduled scaling is suspended.
//
// Set the value to `true` if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is `false` .
ScheduledScalingSuspended interface{} `json:"scheduledScalingSuspended"`
}
// Properties for defining a `CfnScalableTarget`.
//
// TODO: EXAMPLE
//
type CfnScalableTargetProps struct {
// The maximum value that you plan to scale out to.
//
// When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand.
MaxCapacity *float64 `json:"maxCapacity"`
// The minimum value that you plan to scale in to.
//
// When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand.
MinCapacity *float64 `json:"minCapacity"`
// The identifier of the resource associated with the scalable target.