-
Notifications
You must be signed in to change notification settings - Fork 17
/
CommonAutoScalingGroupProps.go
299 lines (296 loc) · 14.1 KB
/
CommonAutoScalingGroupProps.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
package awsautoscaling
import (
"github.com/aws/aws-cdk-go/awscdk/v2"
"github.com/aws/aws-cdk-go/awscdk/v2/awsec2"
)
// Basic properties of an AutoScalingGroup, except the exact machines to run and where they should run.
//
// Constructs that want to create AutoScalingGroups can inherit
// this interface and specialize the essential parts in various ways.
//
// Example:
// // The code below shows an example of how to instantiate this type.
// // The values are placeholders you should change.
// import "github.com/aws/aws-cdk-go/awscdk"
// import "github.com/aws/aws-cdk-go/awscdk"
// import "github.com/aws/aws-cdk-go/awscdk"
// import "github.com/aws/aws-cdk-go/awscdk"
//
// var blockDeviceVolume blockDeviceVolume
// var groupMetrics groupMetrics
// var healthCheck healthCheck
// var scalingEvents scalingEvents
// var signals signals
// var subnet subnet
// var subnetFilter subnetFilter
// var topic topic
// var updatePolicy updatePolicy
//
// commonAutoScalingGroupProps := &CommonAutoScalingGroupProps{
// AllowAllOutbound: jsii.Boolean(false),
// AssociatePublicIpAddress: jsii.Boolean(false),
// AutoScalingGroupName: jsii.String("autoScalingGroupName"),
// BlockDevices: []blockDevice{
// &blockDevice{
// DeviceName: jsii.String("deviceName"),
// Volume: blockDeviceVolume,
// },
// },
// CapacityRebalance: jsii.Boolean(false),
// Cooldown: cdk.Duration_Minutes(jsii.Number(30)),
// DefaultInstanceWarmup: cdk.Duration_*Minutes(jsii.Number(30)),
// DesiredCapacity: jsii.Number(123),
// GroupMetrics: []*groupMetrics{
// groupMetrics,
// },
// HealthCheck: healthCheck,
// IgnoreUnmodifiedSizeProperties: jsii.Boolean(false),
// InstanceMonitoring: awscdk.Aws_autoscaling.Monitoring_BASIC,
// KeyName: jsii.String("keyName"),
// MaxCapacity: jsii.Number(123),
// MaxInstanceLifetime: cdk.Duration_*Minutes(jsii.Number(30)),
// MinCapacity: jsii.Number(123),
// NewInstancesProtectedFromScaleIn: jsii.Boolean(false),
// Notifications: []notificationConfiguration{
// ¬ificationConfiguration{
// Topic: topic,
//
// // the properties below are optional
// ScalingEvents: scalingEvents,
// },
// },
// Signals: signals,
// SpotPrice: jsii.String("spotPrice"),
// SsmSessionPermissions: jsii.Boolean(false),
// TerminationPolicies: []terminationPolicy{
// awscdk.*Aws_autoscaling.*terminationPolicy_ALLOCATION_STRATEGY,
// },
// UpdatePolicy: updatePolicy,
// VpcSubnets: &SubnetSelection{
// AvailabilityZones: []*string{
// jsii.String("availabilityZones"),
// },
// OnePerAz: jsii.Boolean(false),
// SubnetFilters: []*subnetFilter{
// subnetFilter,
// },
// SubnetGroupName: jsii.String("subnetGroupName"),
// Subnets: []iSubnet{
// subnet,
// },
// SubnetType: awscdk.Aws_ec2.SubnetType_PRIVATE_ISOLATED,
// },
// }
//
type CommonAutoScalingGroupProps struct {
// Whether the instances can initiate connections to anywhere by default.
// Default: true.
//
AllowAllOutbound *bool `field:"optional" json:"allowAllOutbound" yaml:"allowAllOutbound"`
// Whether instances in the Auto Scaling Group should have public IP addresses associated with them.
//
// `launchTemplate` and `mixedInstancesPolicy` must not be specified when this property is specified.
// Default: - Use subnet setting.
//
AssociatePublicIpAddress *bool `field:"optional" json:"associatePublicIpAddress" yaml:"associatePublicIpAddress"`
// The name of the Auto Scaling group.
//
// This name must be unique per Region per account.
// Default: - Auto generated by CloudFormation.
//
AutoScalingGroupName *string `field:"optional" json:"autoScalingGroupName" yaml:"autoScalingGroupName"`
// Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
//
// Each instance that is launched has an associated root device volume,
// either an Amazon EBS volume or an instance store volume.
// You can use block device mappings to specify additional EBS volumes or
// instance store volumes to attach to an instance when it is launched.
//
// `launchTemplate` and `mixedInstancesPolicy` must not be specified when this property is specified.
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
//
// Default: - Uses the block device mapping of the AMI.
//
BlockDevices *[]*BlockDevice `field:"optional" json:"blockDevices" yaml:"blockDevices"`
// Indicates whether Capacity Rebalancing is enabled.
//
// When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling
// attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of
// interruption. After launching a new instance, it then terminates an old instance.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-capacityrebalance
//
// Default: false.
//
CapacityRebalance *bool `field:"optional" json:"capacityRebalance" yaml:"capacityRebalance"`
// Default scaling cooldown for this AutoScalingGroup.
// Default: Duration.minutes(5)
//
Cooldown awscdk.Duration `field:"optional" json:"cooldown" yaml:"cooldown"`
// The amount of time, in seconds, until a newly launched instance can contribute to the Amazon CloudWatch metrics.
//
// This delay lets an instance finish initializing before Amazon EC2 Auto Scaling aggregates instance metrics,
// resulting in more reliable usage data. Set this value equal to the amount of time that it takes for resource
// consumption to become stable after an instance reaches the InService state.
//
// To optimize the performance of scaling policies that scale continuously, such as target tracking and
// step scaling policies, we strongly recommend that you enable the default instance warmup, even if its value is set to 0 seconds
//
// Default instance warmup will not be added if no value is specified.
// See: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html
//
// Default: None.
//
DefaultInstanceWarmup awscdk.Duration `field:"optional" json:"defaultInstanceWarmup" yaml:"defaultInstanceWarmup"`
// Initial amount of instances in the fleet.
//
// If this is set to a number, every deployment will reset the amount of
// instances to this number. It is recommended to leave this value blank.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity
//
// Default: minCapacity, and leave unchanged during deployment.
//
DesiredCapacity *float64 `field:"optional" json:"desiredCapacity" yaml:"desiredCapacity"`
// Enable monitoring for group metrics, these metrics describe the group rather than any of its instances.
//
// To report all group metrics use `GroupMetrics.all()`
// Group metrics are reported in a granularity of 1 minute at no additional charge.
// Default: - no group metrics will be reported.
//
GroupMetrics *[]GroupMetrics `field:"optional" json:"groupMetrics" yaml:"groupMetrics"`
// Configuration for health checks.
// Default: - HealthCheck.ec2 with no grace period
//
HealthCheck HealthCheck `field:"optional" json:"healthCheck" yaml:"healthCheck"`
// If the ASG has scheduled actions, don't reset unchanged group sizes.
//
// Only used if the ASG has scheduled actions (which may scale your ASG up
// or down regardless of cdk deployments). If true, the size of the group
// will only be reset if it has been changed in the CDK app. If false, the
// sizes will always be changed back to what they were in the CDK app
// on deployment.
// Default: true.
//
IgnoreUnmodifiedSizeProperties *bool `field:"optional" json:"ignoreUnmodifiedSizeProperties" yaml:"ignoreUnmodifiedSizeProperties"`
// Controls whether instances in this group are launched with detailed or basic monitoring.
//
// When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account
// is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes.
//
// `launchTemplate` and `mixedInstancesPolicy` must not be specified when this property is specified.
// See: https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics
//
// Default: - Monitoring.DETAILED
//
InstanceMonitoring Monitoring `field:"optional" json:"instanceMonitoring" yaml:"instanceMonitoring"`
// Name of SSH keypair to grant access to instances.
//
// `launchTemplate` and `mixedInstancesPolicy` must not be specified when this property is specified.
// Default: - No SSH access will be possible.
//
KeyName *string `field:"optional" json:"keyName" yaml:"keyName"`
// Maximum number of instances in the fleet.
// Default: desiredCapacity.
//
MaxCapacity *float64 `field:"optional" json:"maxCapacity" yaml:"maxCapacity"`
// The maximum amount of time that an instance can be in service.
//
// The maximum duration applies
// to all current and future instances in the group. As an instance approaches its maximum duration,
// it is terminated and replaced, and cannot be used again.
//
// You must specify a value of at least 604,800 seconds (7 days). To clear a previously set value,
// leave this property undefined.
// See: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html
//
// Default: none.
//
MaxInstanceLifetime awscdk.Duration `field:"optional" json:"maxInstanceLifetime" yaml:"maxInstanceLifetime"`
// Minimum number of instances in the fleet.
// Default: 1.
//
MinCapacity *float64 `field:"optional" json:"minCapacity" yaml:"minCapacity"`
// Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
//
// By default, Auto Scaling can terminate an instance at any time after launch
// when scaling in an Auto Scaling Group, subject to the group's termination
// policy. However, you may wish to protect newly-launched instances from
// being scaled in if they are going to run critical applications that should
// not be prematurely terminated.
//
// This flag must be enabled if the Auto Scaling Group will be associated with
// an ECS Capacity Provider with managed termination protection.
// Default: false.
//
NewInstancesProtectedFromScaleIn *bool `field:"optional" json:"newInstancesProtectedFromScaleIn" yaml:"newInstancesProtectedFromScaleIn"`
// Configure autoscaling group to send notifications about fleet changes to an SNS topic(s).
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations
//
// Default: - No fleet change notifications will be sent.
//
Notifications *[]*NotificationConfiguration `field:"optional" json:"notifications" yaml:"notifications"`
// Configure waiting for signals during deployment.
//
// Use this to pause the CloudFormation deployment to wait for the instances
// in the AutoScalingGroup to report successful startup during
// creation and updates. The UserData script needs to invoke `cfn-signal`
// with a success or failure code after it is done setting up the instance.
//
// Without waiting for signals, the CloudFormation deployment will proceed as
// soon as the AutoScalingGroup has been created or updated but before the
// instances in the group have been started.
//
// For example, to have instances wait for an Elastic Load Balancing health check before
// they signal success, add a health-check verification by using the
// cfn-init helper script. For an example, see the verify_instance_health
// command in the Auto Scaling rolling updates sample template:
//
// https://github.com/awslabs/aws-cloudformation-templates/blob/master/aws/services/AutoScaling/AutoScalingRollingUpdates.yaml
// Default: - Do not wait for signals.
//
Signals Signals `field:"optional" json:"signals" yaml:"signals"`
// The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request.
//
// Spot Instances are
// launched when the price you specify exceeds the current Spot market price.
//
// `launchTemplate` and `mixedInstancesPolicy` must not be specified when this property is specified.
// Default: none.
//
SpotPrice *string `field:"optional" json:"spotPrice" yaml:"spotPrice"`
// Add SSM session permissions to the instance role.
//
// Setting this to `true` adds the necessary permissions to connect
// to the instance using SSM Session Manager. You can do this
// from the AWS Console.
//
// NOTE: Setting this flag to `true` may not be enough by itself.
// You must also use an AMI that comes with the SSM Agent, or install
// the SSM Agent yourself. See
// [Working with SSM Agent](https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-agent.html)
// in the SSM Developer Guide.
// Default: false.
//
SsmSessionPermissions *bool `field:"optional" json:"ssmSessionPermissions" yaml:"ssmSessionPermissions"`
// A policy or a list of policies that are used to select the instances to terminate.
//
// The policies are executed in the order that you list them.
// See: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html
//
// Default: - `TerminationPolicy.DEFAULT`
//
TerminationPolicies *[]TerminationPolicy `field:"optional" json:"terminationPolicies" yaml:"terminationPolicies"`
// What to do when an AutoScalingGroup's instance configuration is changed.
//
// This is applied when any of the settings on the ASG are changed that
// affect how the instances should be created (VPC, instance type, startup
// scripts, etc.). It indicates how the existing instances should be
// replaced with new instances matching the new config. By default, nothing
// is done and only new instances are launched with the new config.
// Default: - `UpdatePolicy.rollingUpdate()` if using `init`, `UpdatePolicy.none()` otherwise
//
UpdatePolicy UpdatePolicy `field:"optional" json:"updatePolicy" yaml:"updatePolicy"`
// Where to place instances within the VPC.
// Default: - All Private subnets.
//
VpcSubnets *awsec2.SubnetSelection `field:"optional" json:"vpcSubnets" yaml:"vpcSubnets"`
}