software.amazon.awscdk.services.autoscaling

Interface AutoScalingGroupProps

All Superinterfaces:

CommonAutoScalingGroupProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AutoScalingGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:03.231Z")
 @Stability(value=Experimental)
public interface AutoScalingGroupProps
extends software.amazon.jsii.JsiiSerializable, CommonAutoScalingGroupProps

(experimental) Properties of a Fleet.

Example:

 Vpc vpc;
 InstanceType instanceType;
 IMachineImage machineImage;
 AutoScalingGroup.Builder.create(this, "ASG")
         .vpc(vpc)
         .instanceType(instanceType)
         .machineImage(machineImage)
         // ...
         .init(CloudFormationInit.fromElements(InitFile.fromString("/etc/my_instance", "This got written during instance startup")))
         .signals(Signals.waitForAll(SignalsOptions.builder()
                 .timeout(Duration.minutes(10))
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AutoScalingGroupProps.Builder A builder for AutoScalingGroupProps
static class	AutoScalingGroupProps.Jsii$Proxy An implementation for AutoScalingGroupProps

Method Summary

Modifier and Type	Method and Description
static AutoScalingGroupProps.Builder	builder()
default CloudFormationInit	getInit() (experimental) Apply the given CloudFormation Init configuration to the instances in the AutoScalingGroup at startup.
default ApplyCloudFormationInitOptions	getInitOptions() (experimental) Use the given options for applying CloudFormation Init.
InstanceType	getInstanceType() (experimental) Type of instance to launch.
IMachineImage	getMachineImage() (experimental) AMI to launch.
default Boolean	getRequireImdsv2() (experimental) Whether IMDSv2 should be required on launched instances.
default IRole	getRole() (experimental) An IAM role to associate with the instance profile assigned to this Auto Scaling Group.
default ISecurityGroup	getSecurityGroup() (experimental) Security group to launch the instances in.
default UserData	getUserData() (experimental) Specific UserData to use.
IVpc	getVpc() (experimental) VPC to launch these instances in.

Methods inherited from interface software.amazon.awscdk.services.autoscaling.CommonAutoScalingGroupProps

getAllowAllOutbound, getAssociatePublicIpAddress, getAutoScalingGroupName, getBlockDevices, getCooldown, getDesiredCapacity, getGroupMetrics, getHealthCheck, getIgnoreUnmodifiedSizeProperties, getInstanceMonitoring, getKeyName, getMaxCapacity, getMaxInstanceLifetime, getMinCapacity, getNewInstancesProtectedFromScaleIn, getNotifications, getNotificationsTopic, getReplacingUpdateMinSuccessfulInstancesPercent, getResourceSignalCount, getResourceSignalTimeout, getRollingUpdateConfiguration, getSignals, getSpotPrice, getTerminationPolicies, getUpdatePolicy, getUpdateType, getVpcSubnets

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getInstanceType

@Stability(value=Experimental)
 @NotNull
InstanceType getInstanceType()

(experimental) Type of instance to launch.

getMachineImage

@Stability(value=Experimental)
 @NotNull
IMachineImage getMachineImage()

(experimental) AMI to launch.

getVpc

@Stability(value=Experimental)
 @NotNull
IVpc getVpc()

(experimental) VPC to launch these instances in.

getInit

@Stability(value=Experimental)
 @Nullable
default CloudFormationInit getInit()

(experimental) Apply the given CloudFormation Init configuration to the instances in the AutoScalingGroup at startup.

If you specify init, you must also specify signals to configure the number of instances to wait for and the timeout for waiting for the init process.

Default: - no CloudFormation init

getInitOptions

@Stability(value=Experimental)
 @Nullable
default ApplyCloudFormationInitOptions getInitOptions()

(experimental) Use the given options for applying CloudFormation Init.

Describes the configsets to use and the timeout to wait

Default: - default options

getRequireImdsv2

@Stability(value=Experimental)
 @Nullable
default Boolean getRequireImdsv2()

(experimental) Whether IMDSv2 should be required on launched instances.

Default: - false

getRole

@Stability(value=Experimental)
 @Nullable
default IRole getRole()

(experimental) An IAM role to associate with the instance profile assigned to this Auto Scaling Group.

The role must be assumable by the service principal ec2.amazonaws.com:

Default: A role will automatically be created, it can be accessed via the `role` property

Example:

 Role role = Role.Builder.create(this, "MyRole")
         .assumedBy(new ServicePrincipal("ec2.amazonaws.com"))
         .build();
 

getSecurityGroup

@Stability(value=Experimental)
 @Nullable
default ISecurityGroup getSecurityGroup()

(experimental) Security group to launch the instances in.

Default: - A SecurityGroup will be created if none is specified.

getUserData

@Stability(value=Experimental)
 @Nullable
default UserData getUserData()

(experimental) Specific UserData to use.

The UserData may still be mutated after creation.

Default: - A UserData object appropriate for the MachineImage's Operating System is created.

builder

@Stability(value=Experimental)
static AutoScalingGroupProps.Builder builder()

Specified by:

builder in interface CommonAutoScalingGroupProps

Returns:

a AutoScalingGroupProps.Builder of AutoScalingGroupProps