@Stability(value=Stable) @Internal public static final class CfnAutoScalingGroupProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnAutoScalingGroupProps
CfnAutoScalingGroupPropssoftware.amazon.jsii.JsiiObject.InitializationModeCfnAutoScalingGroupProps.Builder, CfnAutoScalingGroupProps.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
protected |
Jsii$Proxy(CfnAutoScalingGroupProps.Builder builder)
Constructor that initializes the object based on literal property values passed by the
CfnAutoScalingGroupProps.Builder. |
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
| Modifier and Type | Method and Description |
|---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(Object o) |
String |
getAutoScalingGroupName()
The name of the Auto Scaling group.
|
List<String> |
getAvailabilityZones()
A list of Availability Zones where instances in the Auto Scaling group can be created.
|
Object |
getCapacityRebalance()
Indicates whether Capacity Rebalancing is enabled.
|
String |
getContext()
Reserved.
|
String |
getCooldown()
*Only needed if you use simple scaling policies.*.
|
Number |
getDefaultInstanceWarmup()
Not currently supported by CloudFormation.
|
String |
getDesiredCapacity()
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.
|
String |
getDesiredCapacityType()
The unit of measurement for the value specified for desired capacity.
|
Number |
getHealthCheckGracePeriod()
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 Elastic Load Balancing or custom health check.
|
String |
getHealthCheckType()
The service to use for the health checks.
|
String |
getInstanceId()
The ID of the instance used to base the launch configuration on.
|
String |
getLaunchConfigurationName()
The name of the launch configuration to use to launch instances.
|
Object |
getLaunchTemplate()
Information used to specify the launch template and version to use to launch instances.
|
Object |
getLifecycleHookSpecificationList()
One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
|
List<String> |
getLoadBalancerNames()
A list of Classic Load Balancers associated with this Auto Scaling group.
|
Number |
getMaxInstanceLifetime()
The maximum amount of time, in seconds, that an instance can be in service.
|
String |
getMaxSize()
The maximum size of the group.
|
Object |
getMetricsCollection()
Enables the monitoring of group metrics of an Auto Scaling group.
|
String |
getMinSize()
The minimum size of the group.
|
Object |
getMixedInstancesPolicy()
An embedded object that specifies a mixed instances policy.
|
Object |
getNewInstancesProtectedFromScaleIn()
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
|
Object |
getNotificationConfigurations()
Configures an Auto Scaling group to send notifications when specified events take place.
|
String |
getPlacementGroup()
The name of the placement group into which to launch your instances.
|
String |
getServiceLinkedRoleArn()
The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf.
|
List<CfnAutoScalingGroup.TagPropertyProperty> |
getTags()
One or more tags.
|
List<String> |
getTargetGroupArns()
The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling group.
|
List<String> |
getTerminationPolicies()
A policy or a list of policies that are used to select the instance to terminate.
|
List<String> |
getVpcZoneIdentifier()
A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.
|
int |
hashCode() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.protected Jsii$Proxy(CfnAutoScalingGroupProps.Builder builder)
CfnAutoScalingGroupProps.Builder.public final String getMaxSize()
CfnAutoScalingGroupProps
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above
MaxSizeto meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go aboveMaxSizeby more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).
getMaxSize in interface CfnAutoScalingGroupPropspublic final String getMinSize()
CfnAutoScalingGroupPropsgetMinSize in interface CfnAutoScalingGroupPropspublic final String getAutoScalingGroupName()
CfnAutoScalingGroupPropsThis name must be unique per Region per account.
getAutoScalingGroupName in interface CfnAutoScalingGroupPropspublic final List<String> getAvailabilityZones()
CfnAutoScalingGroupProps
Used for launching into EC2-Classic or 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.
getAvailabilityZones in interface CfnAutoScalingGroupPropspublic final Object getCapacityRebalance()
CfnAutoScalingGroupPropsOtherwise, 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 .
getCapacityRebalance in interface CfnAutoScalingGroupPropspublic final String getContext()
CfnAutoScalingGroupPropsgetContext in interface CfnAutoScalingGroupPropspublic final String getCooldown()
CfnAutoScalingGroupPropsThe 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
getCooldown in interface CfnAutoScalingGroupPropspublic final Number getDefaultInstanceWarmup()
CfnAutoScalingGroupPropsgetDefaultInstanceWarmup in interface CfnAutoScalingGroupPropspublic final String getDesiredCapacity()
CfnAutoScalingGroupPropsIt 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.
getDesiredCapacity in interface CfnAutoScalingGroupPropspublic final String getDesiredCapacityType()
CfnAutoScalingGroupProps
Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only. For more information, see Creating an Auto Scaling 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
getDesiredCapacityType in interface CfnAutoScalingGroupPropspublic final Number getHealthCheckGracePeriod()
CfnAutoScalingGroupProps
This is useful if your instances do not immediately pass these health checks after they enter the InService state. For more information, see Health check grace period in the Amazon EC2 Auto Scaling User Guide .
Default: 0 seconds
getHealthCheckGracePeriod in interface CfnAutoScalingGroupPropspublic final String getHealthCheckType()
CfnAutoScalingGroupProps
The valid values are EC2 (default) and ELB . If you configure an Auto Scaling group to use load balancer (ELB) health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks. For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide .
getHealthCheckType in interface CfnAutoScalingGroupPropspublic final String getInstanceId()
CfnAutoScalingGroupPropsFor 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 , or LaunchConfigurationName , don't specify InstanceId .
getInstanceId in interface CfnAutoScalingGroupPropspublic final String getLaunchConfigurationName()
CfnAutoScalingGroupProps
Required only if you don't specify LaunchTemplate , MixedInstancesPolicy , or InstanceId .
getLaunchConfigurationName in interface CfnAutoScalingGroupPropspublic final Object getLaunchTemplate()
CfnAutoScalingGroupProps
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 , or InstanceId .
getLaunchTemplate in interface CfnAutoScalingGroupPropspublic final Object getLifecycleHookSpecificationList()
CfnAutoScalingGroupPropsgetLifecycleHookSpecificationList in interface CfnAutoScalingGroupPropspublic final List<String> getLoadBalancerNames()
CfnAutoScalingGroupProps
For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the TargetGroupARNs property instead.
getLoadBalancerNames in interface CfnAutoScalingGroupPropspublic final Number getMaxInstanceLifetime()
CfnAutoScalingGroupPropsThe 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 Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide .
getMaxInstanceLifetime in interface CfnAutoScalingGroupPropspublic final Object getMetricsCollection()
CfnAutoScalingGroupPropsBy default, these metrics are disabled.
getMetricsCollection in interface CfnAutoScalingGroupPropspublic final Object getMixedInstancesPolicy()
CfnAutoScalingGroupPropsThe 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 .
getMixedInstancesPolicy in interface CfnAutoScalingGroupPropspublic final Object getNewInstancesProtectedFromScaleIn()
CfnAutoScalingGroupPropsFor more information about preventing instances from terminating on scale in, see Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide .
getNewInstancesProtectedFromScaleIn in interface CfnAutoScalingGroupPropspublic final Object getNotificationConfigurations()
CfnAutoScalingGroupPropsgetNotificationConfigurations in interface CfnAutoScalingGroupPropspublic final String getPlacementGroup()
CfnAutoScalingGroupPropsFor 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.
getPlacementGroup in interface CfnAutoScalingGroupPropspublic final String getServiceLinkedRoleArn()
CfnAutoScalingGroupProps
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 .
getServiceLinkedRoleArn in interface CfnAutoScalingGroupPropspublic final List<CfnAutoScalingGroup.TagPropertyProperty> getTags()
CfnAutoScalingGroupPropsYou 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 .
getTags in interface CfnAutoScalingGroupPropspublic final List<String> getTargetGroupArns()
CfnAutoScalingGroupPropsInstances are registered as targets in a target group, and traffic is routed to the target group. For more information, see Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .
getTargetGroupArns in interface CfnAutoScalingGroupPropspublic final List<String> getTerminationPolicies()
CfnAutoScalingGroupPropsThese policies are executed in the order that you list them. For more information, see Work with Amazon EC2 Auto Scaling termination policies 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
getTerminationPolicies in interface CfnAutoScalingGroupPropspublic final List<String> getVpcZoneIdentifier()
CfnAutoScalingGroupProps
If you specify VPCZoneIdentifier with AvailabilityZones , the subnets that you specify for this property must reside in those Availability Zones.
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 .
Conditional: If your account supports EC2-Classic and VPC, this property is required to launch instances into a VPC.
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 .
getVpcZoneIdentifier in interface CfnAutoScalingGroupProps@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2022. All rights reserved.