Protected OptionalalbReadonlyamiReadonlyappReadonlyautoArn of the AutoScalingGroup
ReadonlyautoName of the AutoScalingGroup
ReadonlyenvThe environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
ReadonlygrantThe principal to grant permissions to
ProtectedhasReadonlyidThe ID of the construct with the App suffix.
This should be used in place of id when trying to reference the construct.
Optional ReadonlyimageReadonlyinstanceOptional ReadonlymaxThe maximum amount of time that an instance can be in service.
Protected OptionalnewReadonlynodeThe tree node.
ReadonlyosThe type of OS instances of this fleet are running.
Protected ReadonlyphysicalReturns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
This value will resolve to one of the following:
"my-awesome-bucket")undefined, when a name should be generated by CloudFormationOptional ReadonlyspotThe maximum spot price configured for the autoscaling group. undefined
indicates that this group uses on-demand capacity.
ReadonlystackThe stack in which this resource is defined.
The network connections associated with this resource.
InternalCalled when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.
Send a message to either an SQS queue or SNS topic when instances launch or terminate
Add the security group to all instances via the launch template security groups array.
Adds a statement to the IAM role assumed by instances of this fleet.
Add a pool of pre-initialized EC2 instances that sits alongside an Auto Scaling group
Optionaloptions: WarmPoolOptionsUse a CloudFormation Init configuration at instance startup
This does the following:
cfn-init and cfn-signal.cfn-init to finish
before reporting success.Optionaloptions: ApplyCloudFormationInitOptionsApply the given removal policy to this resource
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).
Returns true if newly-launched instances are protected from scale-in.
Attach to ELBv2 Application Target Group
Attach to a classic load balancer
Attach to ELBv2 Application Target Group
ProtectedgenerateProtectedgetReturns an environment-sensitive token that should be used for the
resource's "ARN" attribute (e.g. bucket.bucketArn).
Normally, this token will resolve to arnAttr, but if the resource is
referenced across environments, arnComponents will be used to synthesize
a concrete ARN with the resource's physical name. Make sure to reference
this.physicalName in arnComponents.
The CFN attribute which resolves to the ARN of the resource.
Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes
it's the CFN resource's ref.
The format of the ARN of this resource. You must
reference this.physicalName somewhere within the ARN in order for
cross-environment references to work.
ProtectedgetReturns an environment-sensitive token that should be used for the
resource's "name" attribute (e.g. bucket.bucketName).
Normally, this token will resolve to nameAttr, but if the resource is
referenced across environments, it will be resolved to this.physicalName,
which will be a concrete name.
The CFN attribute which resolves to the resource's name.
Commonly this is the resource's ref.
Ensures newly-launched instances are protected from scale-in.
Scale out or in to achieve a target CPU utilization
Scale out or in, in response to a metric
Scale out or in to achieve a target request handling rate
The AutoScalingGroup must have been attached to an Application Load Balancer in order to be able to call this.
Scale out or in based on time
Scale out or in in order to keep a metric around a target value
Returns a string representation of an object.
StaticfromStaticisChecks if x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
Any object
true if x is an object created from a class which extends Construct.
StaticisReturns true if the construct was created by CDK, and false otherwise
StaticisCheck whether the given construct is a Resource
Construct which creates an Auto Scaling group.
By default, all EC2 instances in this group will use [[
GuInstanceRole]], which provides common permissions (e.g. the ability to download an artifact and write logs to the account's logging Kinesis stream).If additional IAM permissions are required, a custom role can be provided via the
roleprop. You may wish to instantiate [[GuInstanceRole]] yourself as a basis for this custom role, as it allows custom permissions to be passed in.All EC2 instances in this group will be automatically associated with the [[
GuHttpsEgressSecurityGroup]] security groups, which allows outbound traffic over HTTPS.If additional ingress or egress rules are required, define custom security groups and pass them in via the
additionalSecurityGroupsprop.All EC2 instances provisioned via this construct will use IMDSv2.