Class AutoScalingGroupProps.Jsii$Proxy
- All Implemented Interfaces:
AutoScalingGroupProps
,CommonAutoScalingGroupProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
AutoScalingGroupProps
AutoScalingGroupProps
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.autoscaling.AutoScalingGroupProps
AutoScalingGroupProps.Builder, AutoScalingGroupProps.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Jsii$Proxy
(AutoScalingGroupProps.Builder builder) Constructor that initializes the object based on literal property values passed by theAutoScalingGroupProps.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final Boolean
Whether the instances can initiate connections to anywhere by default.final Boolean
Whether instances in the Auto Scaling Group should have public IP addresses associated with them.final String
The name of the Auto Scaling group.final List<BlockDevice>
Specifies how block devices are exposed to the instance.final Boolean
Indicates whether Capacity Rebalancing is enabled.final Duration
Default scaling cooldown for this AutoScalingGroup.final Duration
The amount of time, in seconds, until a newly launched instance can contribute to the Amazon CloudWatch metrics.final Number
Initial amount of instances in the fleet.final List<GroupMetrics>
Enable monitoring for group metrics, these metrics describe the group rather than any of its instances.final HealthCheck
Configuration for health checks.final Boolean
If the ASG has scheduled actions, don't reset unchanged group sizes.final CloudFormationInit
getInit()
Apply the given CloudFormation Init configuration to the instances in the AutoScalingGroup at startup.Use the given options for applying CloudFormation Init.final Monitoring
Controls whether instances in this group are launched with detailed or basic monitoring.final InstanceType
Type of instance to launch.final String
(deprecated) Name of SSH keypair to grant access to instances.final IKeyPair
The SSH keypair to grant access to the instance.final ILaunchTemplate
Launch template to use.final IMachineImage
AMI to launch.final Number
Maximum number of instances in the fleet.final Number
Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group.final Duration
The maximum amount of time that an instance can be in service.final Number
Minimum number of instances in the fleet.final Number
Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group.final MixedInstancesPolicy
Mixed Instances Policy to use.final Boolean
Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.final List<NotificationConfiguration>
Configure autoscaling group to send notifications about fleet changes to an SNS topic(s).final Boolean
Whether IMDSv2 should be required on launched instances.final IRole
getRole()
An IAM role to associate with the instance profile assigned to this Auto Scaling Group.final ISecurityGroup
Security group to launch the instances in.final Signals
Configure waiting for signals during deployment.final String
The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request.final Boolean
Add SSM session permissions to the instance role.final List<TerminationPolicy>
A policy or a list of policies that are used to select the instances to terminate.final String
A lambda function Arn that can be used as a custom termination policy to select the instances to terminate.final UpdatePolicy
What to do when an AutoScalingGroup's instance configuration is changed.final UserData
Specific UserData to use.final IVpc
getVpc()
VPC to launch these instances in.final SubnetSelection
Where to place instances within the VPC.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theAutoScalingGroupProps.Builder
.
-
-
Method Details
-
getVpc
Description copied from interface:AutoScalingGroupProps
VPC to launch these instances in.- Specified by:
getVpc
in interfaceAutoScalingGroupProps
-
getInit
Description copied from interface:AutoScalingGroupProps
Apply the given CloudFormation Init configuration to the instances in the AutoScalingGroup at startup.If you specify
init
, you must also specifysignals
to configure the number of instances to wait for and the timeout for waiting for the init process.Default: - no CloudFormation init
- Specified by:
getInit
in interfaceAutoScalingGroupProps
-
getInitOptions
Description copied from interface:AutoScalingGroupProps
Use the given options for applying CloudFormation Init.Describes the configsets to use and the timeout to wait
Default: - default options
- Specified by:
getInitOptions
in interfaceAutoScalingGroupProps
-
getInstanceType
Description copied from interface:AutoScalingGroupProps
Type of instance to launch.launchTemplate
andmixedInstancesPolicy
must not be specified when this property is specifiedDefault: - Do not provide any instance type
- Specified by:
getInstanceType
in interfaceAutoScalingGroupProps
-
getLaunchTemplate
Description copied from interface:AutoScalingGroupProps
Launch template to use.Launch configuration related settings and MixedInstancesPolicy must not be specified when a launch template is specified.
Default: - Do not provide any launch template
- Specified by:
getLaunchTemplate
in interfaceAutoScalingGroupProps
-
getMachineImage
Description copied from interface:AutoScalingGroupProps
AMI to launch.launchTemplate
andmixedInstancesPolicy
must not be specified when this property is specifiedDefault: - Do not provide any machine image
- Specified by:
getMachineImage
in interfaceAutoScalingGroupProps
-
getMaxHealthyPercentage
Description copied from interface:AutoScalingGroupProps
Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group.It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances.
Value range is 0 to 100. After it's set, both
minHealthyPercentage
andmaxHealthyPercentage
to -1 will clear the previously set value.Both or neither of
minHealthyPercentage
andmaxHealthyPercentage
must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time.Default: - No instance maintenance policy.
- Specified by:
getMaxHealthyPercentage
in interfaceAutoScalingGroupProps
- See Also:
-
getMinHealthyPercentage
Description copied from interface:AutoScalingGroupProps
Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group.It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances.
Value range is 0 to 100. After it's set, both
minHealthyPercentage
andmaxHealthyPercentage
to -1 will clear the previously set value.Both or neither of
minHealthyPercentage
andmaxHealthyPercentage
must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time.Default: - No instance maintenance policy.
- Specified by:
getMinHealthyPercentage
in interfaceAutoScalingGroupProps
- See Also:
-
getMixedInstancesPolicy
Description copied from interface:AutoScalingGroupProps
Mixed Instances Policy to use.Launch configuration related settings and Launch Template must not be specified when a MixedInstancesPolicy is specified.
Default: - Do not provide any MixedInstancesPolicy
- Specified by:
getMixedInstancesPolicy
in interfaceAutoScalingGroupProps
-
getRequireImdsv2
Description copied from interface:AutoScalingGroupProps
Whether IMDSv2 should be required on launched instances.Default: false
- Specified by:
getRequireImdsv2
in interfaceAutoScalingGroupProps
-
getRole
Description copied from interface:AutoScalingGroupProps
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
:launchTemplate
andmixedInstancesPolicy
must not be specified when this property is specifiedDefault: 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();
- Specified by:
getRole
in interfaceAutoScalingGroupProps
-
getSecurityGroup
Description copied from interface:AutoScalingGroupProps
Security group to launch the instances in.launchTemplate
andmixedInstancesPolicy
must not be specified when this property is specifiedDefault: - A SecurityGroup will be created if none is specified.
- Specified by:
getSecurityGroup
in interfaceAutoScalingGroupProps
-
getUserData
Description copied from interface:AutoScalingGroupProps
Specific UserData to use.The UserData may still be mutated after creation.
launchTemplate
andmixedInstancesPolicy
must not be specified when this property is specifiedDefault: - A UserData object appropriate for the MachineImage's Operating System is created.
- Specified by:
getUserData
in interfaceAutoScalingGroupProps
-
getAllowAllOutbound
Description copied from interface:CommonAutoScalingGroupProps
Whether the instances can initiate connections to anywhere by default.Default: true
- Specified by:
getAllowAllOutbound
in interfaceCommonAutoScalingGroupProps
-
getAssociatePublicIpAddress
Description copied from interface:CommonAutoScalingGroupProps
Whether instances in the Auto Scaling Group should have public IP addresses associated with them.launchTemplate
andmixedInstancesPolicy
must not be specified when this property is specifiedDefault: - Use subnet setting.
- Specified by:
getAssociatePublicIpAddress
in interfaceCommonAutoScalingGroupProps
-
getAutoScalingGroupName
Description copied from interface:CommonAutoScalingGroupProps
The name of the Auto Scaling group.This name must be unique per Region per account.
Default: - Auto generated by CloudFormation
- Specified by:
getAutoScalingGroupName
in interfaceCommonAutoScalingGroupProps
-
getBlockDevices
Description copied from interface:CommonAutoScalingGroupProps
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
andmixedInstancesPolicy
must not be specified when this property is specifiedDefault: - Uses the block device mapping of the AMI
- Specified by:
getBlockDevices
in interfaceCommonAutoScalingGroupProps
- See Also:
-
getCapacityRebalance
Description copied from interface:CommonAutoScalingGroupProps
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.
Default: false
- Specified by:
getCapacityRebalance
in interfaceCommonAutoScalingGroupProps
- See Also:
-
getCooldown
Description copied from interface:CommonAutoScalingGroupProps
Default scaling cooldown for this AutoScalingGroup.Default: Duration.minutes(5)
- Specified by:
getCooldown
in interfaceCommonAutoScalingGroupProps
-
getDefaultInstanceWarmup
Description copied from interface:CommonAutoScalingGroupProps
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
Default: None
- Specified by:
getDefaultInstanceWarmup
in interfaceCommonAutoScalingGroupProps
- See Also:
-
getDesiredCapacity
Description copied from interface:CommonAutoScalingGroupProps
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.
Default: minCapacity, and leave unchanged during deployment
- Specified by:
getDesiredCapacity
in interfaceCommonAutoScalingGroupProps
- See Also:
-
getGroupMetrics
Description copied from interface:CommonAutoScalingGroupProps
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
- Specified by:
getGroupMetrics
in interfaceCommonAutoScalingGroupProps
-
getHealthCheck
Description copied from interface:CommonAutoScalingGroupProps
Configuration for health checks.Default: - HealthCheck.ec2 with no grace period
- Specified by:
getHealthCheck
in interfaceCommonAutoScalingGroupProps
-
getIgnoreUnmodifiedSizeProperties
Description copied from interface:CommonAutoScalingGroupProps
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
- Specified by:
getIgnoreUnmodifiedSizeProperties
in interfaceCommonAutoScalingGroupProps
-
getInstanceMonitoring
Description copied from interface:CommonAutoScalingGroupProps
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
andmixedInstancesPolicy
must not be specified when this property is specifiedDefault: - Monitoring.DETAILED
- Specified by:
getInstanceMonitoring
in interfaceCommonAutoScalingGroupProps
- See Also:
-
getKeyName
Description copied from interface:CommonAutoScalingGroupProps
(deprecated) Name of SSH keypair to grant access to instances.launchTemplate
andmixedInstancesPolicy
must not be specified when this property is specifiedYou can either specify
keyPair
orkeyName
, not both.Default: - No SSH access will be possible.
- Specified by:
getKeyName
in interfaceCommonAutoScalingGroupProps
-
getKeyPair
Description copied from interface:CommonAutoScalingGroupProps
The SSH keypair to grant access to the instance.Feature flag
AUTOSCALING_GENERATE_LAUNCH_TEMPLATE
must be enabled to use this property.launchTemplate
andmixedInstancesPolicy
must not be specified when this property is specified.You can either specify
keyPair
orkeyName
, not both.Default: - No SSH access will be possible.
- Specified by:
getKeyPair
in interfaceCommonAutoScalingGroupProps
-
getMaxCapacity
Description copied from interface:CommonAutoScalingGroupProps
Maximum number of instances in the fleet.Default: desiredCapacity
- Specified by:
getMaxCapacity
in interfaceCommonAutoScalingGroupProps
-
getMaxInstanceLifetime
Description copied from interface:CommonAutoScalingGroupProps
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.
Default: none
- Specified by:
getMaxInstanceLifetime
in interfaceCommonAutoScalingGroupProps
- See Also:
-
getMinCapacity
Description copied from interface:CommonAutoScalingGroupProps
Minimum number of instances in the fleet.Default: 1
- Specified by:
getMinCapacity
in interfaceCommonAutoScalingGroupProps
-
getNewInstancesProtectedFromScaleIn
Description copied from interface:CommonAutoScalingGroupProps
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
- Specified by:
getNewInstancesProtectedFromScaleIn
in interfaceCommonAutoScalingGroupProps
-
getNotifications
Description copied from interface:CommonAutoScalingGroupProps
Configure autoscaling group to send notifications about fleet changes to an SNS topic(s).Default: - No fleet change notifications will be sent.
- Specified by:
getNotifications
in interfaceCommonAutoScalingGroupProps
- See Also:
-
getSignals
Description copied from interface:CommonAutoScalingGroupProps
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
- Specified by:
getSignals
in interfaceCommonAutoScalingGroupProps
-
getSpotPrice
Description copied from interface:CommonAutoScalingGroupProps
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
andmixedInstancesPolicy
must not be specified when this property is specifiedDefault: none
- Specified by:
getSpotPrice
in interfaceCommonAutoScalingGroupProps
-
getSsmSessionPermissions
Description copied from interface:CommonAutoScalingGroupProps
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 in the SSM Developer Guide.Default: false
- Specified by:
getSsmSessionPermissions
in interfaceCommonAutoScalingGroupProps
-
getTerminationPolicies
Description copied from interface:CommonAutoScalingGroupProps
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.
Default: - `TerminationPolicy.DEFAULT`
- Specified by:
getTerminationPolicies
in interfaceCommonAutoScalingGroupProps
- See Also:
-
getTerminationPolicyCustomLambdaFunctionArn
Description copied from interface:CommonAutoScalingGroupProps
A lambda function Arn that can be used as a custom termination policy to select the instances to terminate.This property must be specified if the TerminationPolicy.CUSTOM_LAMBDA_FUNCTION is used.
Default: - No lambda function Arn will be supplied
- Specified by:
getTerminationPolicyCustomLambdaFunctionArn
in interfaceCommonAutoScalingGroupProps
- See Also:
-
getUpdatePolicy
Description copied from interface:CommonAutoScalingGroupProps
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
- Specified by:
getUpdatePolicy
in interfaceCommonAutoScalingGroupProps
-
getVpcSubnets
Description copied from interface:CommonAutoScalingGroupProps
Where to place instances within the VPC.Default: - All Private subnets.
- Specified by:
getVpcSubnets
in interfaceCommonAutoScalingGroupProps
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-