Class CfnAutoScalingGroup
- All Implemented Interfaces:
IInspectable,IAutoScalingGroupRef,IEnvironmentAware,ITaggable,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
AWS::AutoScaling::AutoScalingGroup resource defines an Amazon EC2 Auto Scaling group, which is a collection of Amazon EC2 instances that are treated as a logical grouping for the purposes of automatic scaling and management.
For more information about Amazon EC2 Auto Scaling, see the Amazon EC2 Auto Scaling User Guide .
Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template or a launch configuration. We strongly recommend that you do not use launch configurations. For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide .
For help migrating from launch configurations to launch templates, see Migrate AWS CloudFormation stacks from launch configurations to launch templates in the Amazon EC2 Auto Scaling User Guide .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.autoscaling.*;
CfnAutoScalingGroup cfnAutoScalingGroup = CfnAutoScalingGroup.Builder.create(this, "MyCfnAutoScalingGroup")
.maxSize("maxSize")
.minSize("minSize")
// the properties below are optional
.autoScalingGroupName("autoScalingGroupName")
.availabilityZoneDistribution(AvailabilityZoneDistributionProperty.builder()
.capacityDistributionStrategy("capacityDistributionStrategy")
.build())
.availabilityZoneImpairmentPolicy(AvailabilityZoneImpairmentPolicyProperty.builder()
.impairedZoneHealthCheckBehavior("impairedZoneHealthCheckBehavior")
.zonalShiftEnabled(false)
.build())
.availabilityZones(List.of("availabilityZones"))
.capacityRebalance(false)
.capacityReservationSpecification(CapacityReservationSpecificationProperty.builder()
.capacityReservationPreference("capacityReservationPreference")
// the properties below are optional
.capacityReservationTarget(CapacityReservationTargetProperty.builder()
.capacityReservationIds(List.of("capacityReservationIds"))
.capacityReservationResourceGroupArns(List.of("capacityReservationResourceGroupArns"))
.build())
.build())
.context("context")
.cooldown("cooldown")
.defaultInstanceWarmup(123)
.desiredCapacity("desiredCapacity")
.desiredCapacityType("desiredCapacityType")
.healthCheckGracePeriod(123)
.healthCheckType("healthCheckType")
.instanceId("instanceId")
.instanceLifecyclePolicy(InstanceLifecyclePolicyProperty.builder()
.retentionTriggers(RetentionTriggersProperty.builder()
.terminateHookAbandon("terminateHookAbandon")
.build())
.build())
.instanceMaintenancePolicy(InstanceMaintenancePolicyProperty.builder()
.maxHealthyPercentage(123)
.minHealthyPercentage(123)
.build())
.launchConfigurationName("launchConfigurationName")
.launchTemplate(LaunchTemplateSpecificationProperty.builder()
.version("version")
// the properties below are optional
.launchTemplateId("launchTemplateId")
.launchTemplateName("launchTemplateName")
.build())
.lifecycleHookSpecificationList(List.of(LifecycleHookSpecificationProperty.builder()
.lifecycleHookName("lifecycleHookName")
.lifecycleTransition("lifecycleTransition")
// the properties below are optional
.defaultResult("defaultResult")
.heartbeatTimeout(123)
.notificationMetadata("notificationMetadata")
.notificationTargetArn("notificationTargetArn")
.roleArn("roleArn")
.build()))
.loadBalancerNames(List.of("loadBalancerNames"))
.maxInstanceLifetime(123)
.metricsCollection(List.of(MetricsCollectionProperty.builder()
.granularity("granularity")
// the properties below are optional
.metrics(List.of("metrics"))
.build()))
.mixedInstancesPolicy(MixedInstancesPolicyProperty.builder()
.launchTemplate(LaunchTemplateProperty.builder()
.launchTemplateSpecification(LaunchTemplateSpecificationProperty.builder()
.version("version")
// the properties below are optional
.launchTemplateId("launchTemplateId")
.launchTemplateName("launchTemplateName")
.build())
// the properties below are optional
.overrides(List.of(LaunchTemplateOverridesProperty.builder()
.imageId("imageId")
.instanceRequirements(InstanceRequirementsProperty.builder()
.memoryMiB(MemoryMiBRequestProperty.builder()
.max(123)
.min(123)
.build())
.vCpuCount(VCpuCountRequestProperty.builder()
.max(123)
.min(123)
.build())
// the properties below are optional
.acceleratorCount(AcceleratorCountRequestProperty.builder()
.max(123)
.min(123)
.build())
.acceleratorManufacturers(List.of("acceleratorManufacturers"))
.acceleratorNames(List.of("acceleratorNames"))
.acceleratorTotalMemoryMiB(AcceleratorTotalMemoryMiBRequestProperty.builder()
.max(123)
.min(123)
.build())
.acceleratorTypes(List.of("acceleratorTypes"))
.allowedInstanceTypes(List.of("allowedInstanceTypes"))
.bareMetal("bareMetal")
.baselineEbsBandwidthMbps(BaselineEbsBandwidthMbpsRequestProperty.builder()
.max(123)
.min(123)
.build())
.baselinePerformanceFactors(BaselinePerformanceFactorsRequestProperty.builder()
.cpu(CpuPerformanceFactorRequestProperty.builder()
.references(List.of(PerformanceFactorReferenceRequestProperty.builder()
.instanceFamily("instanceFamily")
.build()))
.build())
.build())
.burstablePerformance("burstablePerformance")
.cpuManufacturers(List.of("cpuManufacturers"))
.excludedInstanceTypes(List.of("excludedInstanceTypes"))
.instanceGenerations(List.of("instanceGenerations"))
.localStorage("localStorage")
.localStorageTypes(List.of("localStorageTypes"))
.maxSpotPriceAsPercentageOfOptimalOnDemandPrice(123)
.memoryGiBPerVCpu(MemoryGiBPerVCpuRequestProperty.builder()
.max(123)
.min(123)
.build())
.networkBandwidthGbps(NetworkBandwidthGbpsRequestProperty.builder()
.max(123)
.min(123)
.build())
.networkInterfaceCount(NetworkInterfaceCountRequestProperty.builder()
.max(123)
.min(123)
.build())
.onDemandMaxPricePercentageOverLowestPrice(123)
.requireHibernateSupport(false)
.spotMaxPricePercentageOverLowestPrice(123)
.totalLocalStorageGb(TotalLocalStorageGBRequestProperty.builder()
.max(123)
.min(123)
.build())
.build())
.instanceType("instanceType")
.launchTemplateSpecification(LaunchTemplateSpecificationProperty.builder()
.version("version")
// the properties below are optional
.launchTemplateId("launchTemplateId")
.launchTemplateName("launchTemplateName")
.build())
.weightedCapacity("weightedCapacity")
.build()))
.build())
// the properties below are optional
.instancesDistribution(InstancesDistributionProperty.builder()
.onDemandAllocationStrategy("onDemandAllocationStrategy")
.onDemandBaseCapacity(123)
.onDemandPercentageAboveBaseCapacity(123)
.spotAllocationStrategy("spotAllocationStrategy")
.spotInstancePools(123)
.spotMaxPrice("spotMaxPrice")
.build())
.build())
.newInstancesProtectedFromScaleIn(false)
.notificationConfiguration(NotificationConfigurationProperty.builder()
.topicArn("topicArn")
// the properties below are optional
.notificationTypes(List.of("notificationTypes"))
.build())
.notificationConfigurations(List.of(NotificationConfigurationProperty.builder()
.topicArn("topicArn")
// the properties below are optional
.notificationTypes(List.of("notificationTypes"))
.build()))
.placementGroup("placementGroup")
.serviceLinkedRoleArn("serviceLinkedRoleArn")
.skipZonalShiftValidation(false)
.tags(List.of(TagPropertyProperty.builder()
.key("key")
.propagateAtLaunch(false)
.value("value")
.build()))
.targetGroupArns(List.of("targetGroupArns"))
.terminationPolicies(List.of("terminationPolicies"))
.trafficSources(List.of(TrafficSourceIdentifierProperty.builder()
.identifier("identifier")
.type("type")
.build()))
.vpcZoneIdentifier(List.of("vpcZoneIdentifier"))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceAcceleratorCountRequestis a property of theInstanceRequirementsproperty of the AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides property type that describes the minimum and maximum number of accelerators for an instance type.static interfaceAcceleratorTotalMemoryMiBRequestis a property of theInstanceRequirementsproperty of the AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides property type that describes the minimum and maximum total memory size for the accelerators for an instance type, in MiB.static interfaceAvailabilityZoneDistributionis a property of the AWS::AutoScaling::AutoScalingGroup resource.static interfaceDescribes an Availability Zone impairment policy.static interfaceBaselineEbsBandwidthMbpsRequestis a property of theInstanceRequirementsproperty of the AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides property type that describes the minimum and maximum baseline bandwidth performance for an instance type, in Mbps.static interfaceThe baseline performance to consider, using an instance family as a baseline reference.static final classA fluent builder forCfnAutoScalingGroup.static interfaceDescribes the Capacity Reservation preference and targeting options.static interfaceThe target for the Capacity Reservation.static interfaceThe CPU performance to consider, using an instance family as the baseline reference.static interfaceExample:static interfaceInstanceMaintenancePolicyis a property of the AWS::AutoScaling::AutoScalingGroup resource.static interfaceThe attributes for the instance types for a mixed instances policy.static interfaceUse this structure to specify the distribution of On-Demand Instances and Spot Instances and the allocation strategies used to fulfill On-Demand and Spot capacities for a mixed instances policy.static interfaceUse this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed instances policy: - Override the instance type that is specified in the launch template.static interfaceUse this structure to specify the launch templates and instance types (overrides) for a mixed instances policy.static interfaceSpecifies a launch template to use when provisioning EC2 instances for an Auto Scaling group.static interfaceLifecycleHookSpecificationspecifies a lifecycle hook for theLifecycleHookSpecificationListproperty of the AWS::AutoScaling::AutoScalingGroup resource.static interfaceMemoryGiBPerVCpuRequestis a property of theInstanceRequirementsproperty of the AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides property type that describes the minimum and maximum amount of memory per vCPU for an instance type, in GiB.static interfaceMemoryMiBRequestis a property of theInstanceRequirementsproperty of the AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides property type that describes the minimum and maximum instance memory size for an instance type, in MiB.static interfaceMetricsCollectionis a property of the AWS::AutoScaling::AutoScalingGroup resource that describes the group metrics that an Amazon EC2 Auto Scaling group sends to Amazon CloudWatch.static interfaceUse this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group.static interfaceNetworkBandwidthGbpsRequestis a property of theInstanceRequirementsproperty of the AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides property type that describes the minimum and maximum network bandwidth for an instance type, in Gbps.static interfaceNetworkInterfaceCountRequestis a property of theInstanceRequirementsproperty of the AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides property type that describes the minimum and maximum number of network interfaces for an instance type.static interfaceA structure that specifies an Amazon SNS notification configuration for theNotificationConfigurationsproperty of the AWS::AutoScaling::AutoScalingGroup resource.static interfaceSpecify an instance family to use as the baseline reference for CPU performance.static interfaceExample:static interfaceA structure that specifies a tag for theTagsproperty of AWS::AutoScaling::AutoScalingGroup resource.static interfaceTotalLocalStorageGBRequestis a property of theInstanceRequirementsproperty of the AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides property type that describes the minimum and maximum total local storage size for an instance type, in GB.static interfaceIdentifying information for a traffic source.static interfaceVCpuCountRequestis a property of theInstanceRequirementsproperty of the AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides property type that describes the minimum and maximum number of vCPUs for an instance type.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.autoscaling.IAutoScalingGroupRef
IAutoScalingGroupRef.Jsii$Default, IAutoScalingGroupRef.Jsii$ProxyNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnAutoScalingGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnAutoScalingGroup(software.amazon.jsii.JsiiObjectRef objRef) CfnAutoScalingGroup(software.constructs.Construct scope, String id, CfnAutoScalingGroupProps props) Create a newAWS::AutoScaling::AutoScalingGroup. -
Method Summary
Modifier and TypeMethodDescriptionstatic StringarnForAutoScalingGroup(IAutoScalingGroupRef resource) The Amazon Resource Name (ARN) of the Auto Scaling group.The name of the Auto Scaling group.A reference to a AutoScalingGroup resource.The EC2 instance capacity distribution across Availability Zones for the Auto Scaling group.The Availability Zone impairment policy for the Auto Scaling group.A list of Availability Zones where instances in the Auto Scaling group can be created.Indicates whether Capacity Rebalancing is enabled.The capacity reservation specification for the Auto Scaling group.Reserved.Only needed if you use simple scaling policies..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 theInServicestate.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.The unit of measurement for the value specified for desired capacity.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.A comma-separated value string of one or more health check types.The ID of the instance used to base the launch configuration on.Returns union: eitherIResolvableorCfnAutoScalingGroup.InstanceLifecyclePolicyPropertyAn instance maintenance policy.The name of the launch configuration to use to launch instances.Information used to specify the launch template and version to use to launch instances.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.The maximum amount of time, in seconds, that an instance can be in service.The maximum size of the group.Enables the monitoring of group metrics of an Auto Scaling group.The minimum size of the group.An embedded object that specifies a mixed instances policy.Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.Deprecated.this property has been deprecatedConfigures an Auto Scaling group to send notifications when specified events take place.The name of the placement group into which to launch your instances.The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf.Returns union: eitherBooleanorIResolvablegetTags()Tag Manager which manages the tags for this resource.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.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.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.static BooleanChecks whether the given object is a CfnAutoScalingGroup.renderProperties(Map<String, Object> props) voidsetAutoScalingGroupName(String value) The name of the Auto Scaling group.voidThe EC2 instance capacity distribution across Availability Zones for the Auto Scaling group.voidThe EC2 instance capacity distribution across Availability Zones for the Auto Scaling group.voidThe Availability Zone impairment policy for the Auto Scaling group.voidsetAvailabilityZoneImpairmentPolicy(CfnAutoScalingGroup.AvailabilityZoneImpairmentPolicyProperty value) The Availability Zone impairment policy for the Auto Scaling group.voidsetAvailabilityZones(List<String> value) A list of Availability Zones where instances in the Auto Scaling group can be created.voidsetCapacityRebalance(Boolean value) Indicates whether Capacity Rebalancing is enabled.voidsetCapacityRebalance(IResolvable value) Indicates whether Capacity Rebalancing is enabled.voidThe capacity reservation specification for the Auto Scaling group.voidsetCapacityReservationSpecification(CfnAutoScalingGroup.CapacityReservationSpecificationProperty value) The capacity reservation specification for the Auto Scaling group.voidsetContext(String value) Reserved.voidsetCooldown(String value) Only needed if you use simple scaling policies..voidsetDefaultInstanceWarmup(Number value) 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 theInServicestate.voidsetDesiredCapacity(String value) 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.voidsetDesiredCapacityType(String value) The unit of measurement for the value specified for desired capacity.voidsetHealthCheckGracePeriod(Number value) 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.voidsetHealthCheckType(String value) A comma-separated value string of one or more health check types.voidsetInstanceId(String value) The ID of the instance used to base the launch configuration on.voidvoidvoidAn instance maintenance policy.voidAn instance maintenance policy.voidsetLaunchConfigurationName(String value) The name of the launch configuration to use to launch instances.voidsetLaunchTemplate(IResolvable value) Information used to specify the launch template and version to use to launch instances.voidInformation used to specify the launch template and version to use to launch instances.voidOne or more lifecycle hooks to add to the Auto Scaling group before instances are launched.voidOne or more lifecycle hooks to add to the Auto Scaling group before instances are launched.voidsetLoadBalancerNames(List<String> value) A list of Classic Load Balancers associated with this Auto Scaling group.voidsetMaxInstanceLifetime(Number value) The maximum amount of time, in seconds, that an instance can be in service.voidsetMaxSize(String value) The maximum size of the group.voidsetMetricsCollection(List<Object> value) Enables the monitoring of group metrics of an Auto Scaling group.voidsetMetricsCollection(IResolvable value) Enables the monitoring of group metrics of an Auto Scaling group.voidsetMinSize(String value) The minimum size of the group.voidAn embedded object that specifies a mixed instances policy.voidAn embedded object that specifies a mixed instances policy.voidIndicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.voidIndicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.voidDeprecated.this property has been deprecatedvoidDeprecated.this property has been deprecatedvoidsetNotificationConfigurations(List<Object> value) Configures an Auto Scaling group to send notifications when specified events take place.voidConfigures an Auto Scaling group to send notifications when specified events take place.voidsetPlacementGroup(String value) The name of the placement group into which to launch your instances.voidsetServiceLinkedRoleArn(String value) The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf.voidvoidvoidOne or more tags.voidsetTargetGroupArns(List<String> value) The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group.voidsetTerminationPolicies(List<String> value) A policy or a list of policies that are used to select the instance to terminate.voidsetTrafficSources(List<Object> value) The traffic sources associated with this Auto Scaling group.voidsetTrafficSources(IResolvable value) The traffic sources associated with this Auto Scaling group.voidsetVpcZoneIdentifier(List<String> value) A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware
getEnvMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnAutoScalingGroup
protected CfnAutoScalingGroup(software.amazon.jsii.JsiiObjectRef objRef) -
CfnAutoScalingGroup
protected CfnAutoScalingGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnAutoScalingGroup
@Stability(Stable) public CfnAutoScalingGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAutoScalingGroupProps props) Create a newAWS::AutoScaling::AutoScalingGroup.- Parameters:
scope- Scope in which this resource is defined. This parameter is required.id- Construct identifier for this resource (unique in its scope). This parameter is required.props- Resource properties. This parameter is required.
-
-
Method Details
-
arnForAutoScalingGroup
@Stability(Stable) @NotNull public static String arnForAutoScalingGroup(@NotNull IAutoScalingGroupRef resource) - Parameters:
resource- This parameter is required.
-
isCfnAutoScalingGroup
Checks whether the given object is a CfnAutoScalingGroup.- Parameters:
x- This parameter is required.
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- Parameters:
inspector- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getAttrAutoScalingGroupArn
The Amazon Resource Name (ARN) of the Auto Scaling group. -
getAutoScalingGroupRef
A reference to a AutoScalingGroup resource.- Specified by:
getAutoScalingGroupRefin interfaceIAutoScalingGroupRef
-
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getMaxSize
The maximum size of the group. -
setMaxSize
The maximum size of the group. -
getMinSize
The minimum size of the group. -
setMinSize
The minimum size of the group. -
getAutoScalingGroupName
The name of the Auto Scaling group.This name must be unique per Region per account.
-
setAutoScalingGroupName
The name of the Auto Scaling group.This name must be unique per Region per account.
-
getAvailabilityZoneDistribution
The EC2 instance capacity distribution across Availability Zones for the Auto Scaling group.Returns union: either
IResolvableorCfnAutoScalingGroup.AvailabilityZoneDistributionProperty -
setAvailabilityZoneDistribution
The EC2 instance capacity distribution across Availability Zones for the Auto Scaling group. -
setAvailabilityZoneDistribution
@Stability(Stable) public void setAvailabilityZoneDistribution(@Nullable CfnAutoScalingGroup.AvailabilityZoneDistributionProperty value) The EC2 instance capacity distribution across Availability Zones for the Auto Scaling group. -
getAvailabilityZoneImpairmentPolicy
The Availability Zone impairment policy for the Auto Scaling group.Returns union: either
IResolvableorCfnAutoScalingGroup.AvailabilityZoneImpairmentPolicyProperty -
setAvailabilityZoneImpairmentPolicy
The Availability Zone impairment policy for the Auto Scaling group. -
setAvailabilityZoneImpairmentPolicy
@Stability(Stable) public void setAvailabilityZoneImpairmentPolicy(@Nullable CfnAutoScalingGroup.AvailabilityZoneImpairmentPolicyProperty value) The Availability Zone impairment policy for the Auto Scaling group. -
getAvailabilityZones
A list of Availability Zones where instances in the Auto Scaling group can be created. -
setAvailabilityZones
A list of Availability Zones where instances in the Auto Scaling group can be created. -
getCapacityRebalance
Indicates whether Capacity Rebalancing is enabled.Returns union: either
BooleanorIResolvable -
setCapacityRebalance
Indicates whether Capacity Rebalancing is enabled. -
setCapacityRebalance
Indicates whether Capacity Rebalancing is enabled. -
getCapacityReservationSpecification
The capacity reservation specification for the Auto Scaling group.Returns union: either
IResolvableorCfnAutoScalingGroup.CapacityReservationSpecificationProperty -
setCapacityReservationSpecification
The capacity reservation specification for the Auto Scaling group. -
setCapacityReservationSpecification
@Stability(Stable) public void setCapacityReservationSpecification(@Nullable CfnAutoScalingGroup.CapacityReservationSpecificationProperty value) The capacity reservation specification for the Auto Scaling group. -
getContext
Reserved. -
setContext
Reserved. -
getCooldown
Only needed if you use simple scaling policies.. -
setCooldown
Only needed if you use simple scaling policies.. -
getDefaultInstanceWarmup
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 theInServicestate. -
setDefaultInstanceWarmup
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 theInServicestate. -
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. -
setDesiredCapacity
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. -
getDesiredCapacityType
The unit of measurement for the value specified for desired capacity. -
setDesiredCapacityType
The unit of measurement for the value specified for desired capacity. -
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 health check. -
setHealthCheckGracePeriod
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. -
getHealthCheckType
A comma-separated value string of one or more health check types. -
setHealthCheckType
A comma-separated value string of one or more health check types. -
getInstanceId
The ID of the instance used to base the launch configuration on. -
setInstanceId
The ID of the instance used to base the launch configuration on. -
getInstanceLifecyclePolicy
Returns union: eitherIResolvableorCfnAutoScalingGroup.InstanceLifecyclePolicyProperty -
setInstanceLifecyclePolicy
-
setInstanceLifecyclePolicy
@Stability(Stable) public void setInstanceLifecyclePolicy(@Nullable CfnAutoScalingGroup.InstanceLifecyclePolicyProperty value) -
getInstanceMaintenancePolicy
An instance maintenance policy.Returns union: either
IResolvableorCfnAutoScalingGroup.InstanceMaintenancePolicyProperty -
setInstanceMaintenancePolicy
An instance maintenance policy. -
setInstanceMaintenancePolicy
@Stability(Stable) public void setInstanceMaintenancePolicy(@Nullable CfnAutoScalingGroup.InstanceMaintenancePolicyProperty value) An instance maintenance policy. -
getLaunchConfigurationName
The name of the launch configuration to use to launch instances. -
setLaunchConfigurationName
The name of the launch configuration to use to launch instances. -
getLaunchTemplate
Information used to specify the launch template and version to use to launch instances.Returns union: either
IResolvableorCfnAutoScalingGroup.LaunchTemplateSpecificationProperty -
setLaunchTemplate
Information used to specify the launch template and version to use to launch instances. -
setLaunchTemplate
@Stability(Stable) public void setLaunchTemplate(@Nullable CfnAutoScalingGroup.LaunchTemplateSpecificationProperty value) Information used to specify the launch template and version to use to launch instances. -
getLifecycleHookSpecificationList
One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnAutoScalingGroup.LifecycleHookSpecificationProperty> -
setLifecycleHookSpecificationList
One or more lifecycle hooks to add to the Auto Scaling group before instances are launched. -
setLifecycleHookSpecificationList
One or more lifecycle hooks to add to the Auto Scaling group before instances are launched. -
getLoadBalancerNames
A list of Classic Load Balancers associated with this Auto Scaling group. -
setLoadBalancerNames
A list of Classic Load Balancers associated with this Auto Scaling group. -
getMaxInstanceLifetime
The maximum amount of time, in seconds, that an instance can be in service. -
setMaxInstanceLifetime
The maximum amount of time, in seconds, that an instance can be in service. -
getMetricsCollection
Enables the monitoring of group metrics of an Auto Scaling group.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnAutoScalingGroup.MetricsCollectionProperty> -
setMetricsCollection
Enables the monitoring of group metrics of an Auto Scaling group. -
setMetricsCollection
Enables the monitoring of group metrics of an Auto Scaling group. -
getMixedInstancesPolicy
An embedded object that specifies a mixed instances policy.Returns union: either
IResolvableorCfnAutoScalingGroup.MixedInstancesPolicyProperty -
setMixedInstancesPolicy
An embedded object that specifies a mixed instances policy. -
setMixedInstancesPolicy
@Stability(Stable) public void setMixedInstancesPolicy(@Nullable CfnAutoScalingGroup.MixedInstancesPolicyProperty value) An embedded object that specifies a mixed instances policy. -
getNewInstancesProtectedFromScaleIn
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.Returns union: either
BooleanorIResolvable -
setNewInstancesProtectedFromScaleIn
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. -
setNewInstancesProtectedFromScaleIn
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. -
getNotificationConfiguration
Deprecated.this property has been deprecated(deprecated) A structure that specifies an Amazon SNS notification configuration for theNotificationConfigurationsproperty 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.Returns union: either
IResolvableorCfnAutoScalingGroup.NotificationConfigurationProperty -
setNotificationConfiguration
@Stability(Deprecated) @Deprecated public void setNotificationConfiguration(@Nullable IResolvable value) Deprecated.this property has been deprecated(deprecated) A structure that specifies an Amazon SNS notification configuration for theNotificationConfigurationsproperty 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. -
setNotificationConfiguration
@Stability(Deprecated) @Deprecated public void setNotificationConfiguration(@Nullable CfnAutoScalingGroup.NotificationConfigurationProperty value) Deprecated.this property has been deprecated(deprecated) A structure that specifies an Amazon SNS notification configuration for theNotificationConfigurationsproperty 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. -
getNotificationConfigurations
Configures an Auto Scaling group to send notifications when specified events take place.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnAutoScalingGroup.NotificationConfigurationProperty> -
setNotificationConfigurations
Configures an Auto Scaling group to send notifications when specified events take place. -
setNotificationConfigurations
Configures an Auto Scaling group to send notifications when specified events take place. -
getPlacementGroup
The name of the placement group into which to launch your instances. -
setPlacementGroup
The name of the placement group into which to launch your instances. -
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. -
setServiceLinkedRoleArn
The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. -
getSkipZonalShiftValidation
Returns union: eitherBooleanorIResolvable -
setSkipZonalShiftValidation
-
setSkipZonalShiftValidation
-
getTagsRaw
One or more tags. -
setTagsRaw
@Stability(Stable) public void setTagsRaw(@Nullable List<CfnAutoScalingGroup.TagPropertyProperty> value) One or more tags. -
getTargetGroupArns
The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. -
setTargetGroupArns
The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. -
getTerminationPolicies
A policy or a list of policies that are used to select the instance to terminate. -
setTerminationPolicies
A policy or a list of policies that are used to select the instance to terminate. -
getTrafficSources
The traffic sources associated with this Auto Scaling group.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnAutoScalingGroup.TrafficSourceIdentifierProperty> -
setTrafficSources
The traffic sources associated with this Auto Scaling group. -
setTrafficSources
The traffic sources associated with this Auto Scaling group. -
getVpcZoneIdentifier
A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created. -
setVpcZoneIdentifier
A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.
-