Class CfnAutoScalingGroupProps.Jsii$Proxy
- All Implemented Interfaces:
CfnAutoScalingGroupProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnAutoScalingGroupProps
CfnAutoScalingGroupProps
-
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.CfnAutoScalingGroupProps
CfnAutoScalingGroupProps.Builder, CfnAutoScalingGroupProps.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Constructor that initializes the object based on literal property values passed by theCfnAutoScalingGroupProps.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 String
The name of the Auto Scaling group.final Object
A list of Availability Zones where instances in the Auto Scaling group can be created.final Object
Indicates whether Capacity Rebalancing is enabled.final String
Reserved.final String
Only needed if you use simple scaling policies..final Number
The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters theInService
state.final String
The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain.final String
The unit of measurement for the value specified for desired capacity.final Number
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check.final String
A comma-separated value string of one or more health check types.final String
The ID of the instance used to base the launch configuration on.final Object
An instance maintenance policy.final String
The name of the launch configuration to use to launch instances.final Object
Information used to specify the launch template and version to use to launch instances.final Object
One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.A list of Classic Load Balancers associated with this Auto Scaling group.final Number
The maximum amount of time, in seconds, that an instance can be in service.final String
The maximum size of the group.final Object
Enables the monitoring of group metrics of an Auto Scaling group.final String
The minimum size of the group.final Object
An embedded object that specifies a mixed instances policy.final Object
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.final Object
(deprecated) A structure that specifies an Amazon SNS notification configuration for theNotificationConfigurations
property of the AWS::AutoScaling::AutoScalingGroup resource.final Object
Configures an Auto Scaling group to send notifications when specified events take place.final String
The name of the placement group into which to launch your instances.final String
The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf.getTags()
One or more tags.The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group.A policy or a list of policies that are used to select the instance to terminate.final Object
The traffic sources associated with this Auto Scaling group.A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.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 theCfnAutoScalingGroupProps.Builder
.
-
-
Method Details
-
getMaxSize
Description copied from interface:CfnAutoScalingGroupProps
The maximum size of the group.With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above
MaxSize
to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go aboveMaxSize
by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).- Specified by:
getMaxSize
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getMinSize
Description copied from interface:CfnAutoScalingGroupProps
The minimum size of the group.- Specified by:
getMinSize
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getAutoScalingGroupName
Description copied from interface:CfnAutoScalingGroupProps
The name of the Auto Scaling group. This name must be unique per Region per account.The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.
You cannot use a colon (:) in the name.
- Specified by:
getAutoScalingGroupName
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getAvailabilityZoneDistribution
- Specified by:
getAvailabilityZoneDistribution
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getAvailabilityZones
Description copied from interface:CfnAutoScalingGroupProps
A list of Availability Zones where instances in the Auto Scaling group can be created.Used for launching into the default VPC subnet in each Availability Zone when not using the
VPCZoneIdentifier
property, or for attaching a network interface when an existing network interface ID is specified in a launch template.- Specified by:
getAvailabilityZones
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getCapacityRebalance
Description copied from interface:CfnAutoScalingGroupProps
Indicates whether Capacity Rebalancing is enabled.Otherwise, Capacity Rebalancing is disabled. 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. For more information, see Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions in the in the Amazon EC2 Auto Scaling User Guide .
- Specified by:
getCapacityRebalance
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getContext
Description copied from interface:CfnAutoScalingGroupProps
Reserved.- Specified by:
getContext
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getCooldown
Description copied from interface:CfnAutoScalingGroupProps
Only needed if you use simple scaling policies..The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .
Default:
300
seconds- Specified by:
getCooldown
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getDefaultInstanceWarmup
Description copied from interface:CfnAutoScalingGroupProps
The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters theInService
state.During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide .
To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, even if it is set to 0 seconds . To remove a value that you previously set, include the property but specify
-1
for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of0
or other nominal value.Default: None
- Specified by:
getDefaultInstanceWarmup
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getDesiredCapacity
Description copied from interface:CfnAutoScalingGroupProps
The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain.It can scale beyond this capacity if you configure automatic scaling.
The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group.
CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.
- Specified by:
getDesiredCapacity
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getDesiredCapacityType
Description copied from interface:CfnAutoScalingGroupProps
The unit of measurement for the value specified for desired capacity.Amazon EC2 Auto Scaling supports
DesiredCapacityType
for attribute-based instance type selection only. For more information, see Create a mixed instances group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide .By default, Amazon EC2 Auto Scaling specifies
units
, which translates into number of instances.Valid values:
units
|vcpu
|memory-mib
- Specified by:
getDesiredCapacityType
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getHealthCheckGracePeriod
Description copied from interface:CfnAutoScalingGroupProps
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check.This is useful if your instances do not immediately pass their health checks after they enter the
InService
state. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide .Default:
0
seconds- Specified by:
getHealthCheckGracePeriod
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getHealthCheckType
Description copied from interface:CfnAutoScalingGroupProps
A comma-separated value string of one or more health check types.The valid values are
EC2
,EBS
,ELB
, andVPC_LATTICE
.EC2
is the default health check and cannot be disabled. For more information, see Health checks for instances in an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide .Only specify
EC2
if you must clear a value that was previously set.- Specified by:
getHealthCheckType
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getInstanceId
Description copied from interface:CfnAutoScalingGroupProps
The ID of the instance used to base the launch configuration on.For more information, see Create an Auto Scaling group using an EC2 instance in the Amazon EC2 Auto Scaling User Guide .
If you specify
LaunchTemplate
,MixedInstancesPolicy
, orLaunchConfigurationName
, don't specifyInstanceId
.- Specified by:
getInstanceId
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getInstanceMaintenancePolicy
Description copied from interface:CfnAutoScalingGroupProps
An instance maintenance policy.For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide .
- Specified by:
getInstanceMaintenancePolicy
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getLaunchConfigurationName
Description copied from interface:CfnAutoScalingGroupProps
The name of the launch configuration to use to launch instances.Required only if you don't specify
LaunchTemplate
,MixedInstancesPolicy
, orInstanceId
.- Specified by:
getLaunchConfigurationName
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getLaunchTemplate
Description copied from interface:CfnAutoScalingGroupProps
Information used to specify the launch template and version to use to launch instances.You can alternatively associate a launch template to the Auto Scaling group by specifying a
MixedInstancesPolicy
. For more information about creating launch templates, see Create a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide .If you omit this property, you must specify
MixedInstancesPolicy
,LaunchConfigurationName
, orInstanceId
.- Specified by:
getLaunchTemplate
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getLifecycleHookSpecificationList
Description copied from interface:CfnAutoScalingGroupProps
One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.- Specified by:
getLifecycleHookSpecificationList
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getLoadBalancerNames
Description copied from interface:CfnAutoScalingGroupProps
A list of Classic Load Balancers associated with this Auto Scaling group.For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the
TargetGroupARNs
property instead.- Specified by:
getLoadBalancerNames
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getMaxInstanceLifetime
Description copied from interface:CfnAutoScalingGroupProps
The maximum amount of time, in seconds, that an instance can be in service.The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see Replace Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide .
- Specified by:
getMaxInstanceLifetime
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getMetricsCollection
Description copied from interface:CfnAutoScalingGroupProps
Enables the monitoring of group metrics of an Auto Scaling group.By default, these metrics are disabled.
- Specified by:
getMetricsCollection
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getMixedInstancesPolicy
Description copied from interface:CfnAutoScalingGroupProps
An embedded object that specifies a mixed instances policy.The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types.
For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide .
- Specified by:
getMixedInstancesPolicy
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getNewInstancesProtectedFromScaleIn
Description copied from interface:CfnAutoScalingGroupProps
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.For more information about preventing instances from terminating on scale in, see Use instance scale-in protection in the Amazon EC2 Auto Scaling User Guide .
- Specified by:
getNewInstancesProtectedFromScaleIn
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getNotificationConfiguration
Description copied from interface:CfnAutoScalingGroupProps
(deprecated) A structure that specifies an Amazon SNS notification configuration for theNotificationConfigurations
property of the AWS::AutoScaling::AutoScalingGroup resource. For an example template snippet, see Configure Amazon EC2 Auto Scaling resources. For more information, see Get Amazon SNS notifications when your Auto Scaling group scales in the Amazon EC2 Auto Scaling User Guide.- Specified by:
getNotificationConfiguration
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getNotificationConfigurations
Description copied from interface:CfnAutoScalingGroupProps
Configures an Auto Scaling group to send notifications when specified events take place.- Specified by:
getNotificationConfigurations
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getPlacementGroup
Description copied from interface:CfnAutoScalingGroupProps
The name of the placement group into which to launch your instances.For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances .
A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
- Specified by:
getPlacementGroup
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getServiceLinkedRoleArn
Description copied from interface:CfnAutoScalingGroupProps
The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf.By default, Amazon EC2 Auto Scaling uses a service-linked role named
AWSServiceRoleForAutoScaling
, which it creates if it does not exist. For more information, see Service-linked roles in the Amazon EC2 Auto Scaling User Guide .- Specified by:
getServiceLinkedRoleArn
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getTags
Description copied from interface:CfnAutoScalingGroupProps
One or more tags.You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide .
- Specified by:
getTags
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getTargetGroupArns
Description copied from interface:CfnAutoScalingGroupProps
The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group.Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide .
- Specified by:
getTargetGroupArns
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getTerminationPolicies
Description copied from interface:CfnAutoScalingGroupProps
A policy or a list of policies that are used to select the instance to terminate.These policies are executed in the order that you list them. For more information, see Configure termination policies for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .
Valid values:
Default
|AllocationStrategy
|ClosestToNextInstanceHour
|NewestInstance
|OldestInstance
|OldestLaunchConfiguration
|OldestLaunchTemplate
|arn:aws:lambda:region:account-id:function:my-function:my-alias
- Specified by:
getTerminationPolicies
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getTrafficSources
Description copied from interface:CfnAutoScalingGroupProps
The traffic sources associated with this Auto Scaling group.- Specified by:
getTrafficSources
in interfaceCfnAutoScalingGroupProps
- See Also:
-
getVpcZoneIdentifier
Description copied from interface:CfnAutoScalingGroupProps
A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the DependsOn attribute to declare a dependency on the VPC-gateway attachment .
When you update
VPCZoneIdentifier
, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an UpdatePolicy attribute .Required to launch instances into a nondefault VPC. If you specify
VPCZoneIdentifier
withAvailabilityZones
, the subnets that you specify for this property must reside in those Availability Zones.- Specified by:
getVpcZoneIdentifier
in interfaceCfnAutoScalingGroupProps
- See Also:
-
$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()
-