Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

CreateAutoScalingGroupCommand

We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.

Creates an Auto Scaling group with the specified name and attributes.

If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

If you're new to Amazon EC2 Auto Scaling, see the introductory tutorials in Get started with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Every Auto Scaling group has three size properties (DesiredCapacity, MaxSize, and MinSize). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AutoScalingClient, CreateAutoScalingGroupCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import
// const { AutoScalingClient, CreateAutoScalingGroupCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import
const client = new AutoScalingClient(config);
const input = { // CreateAutoScalingGroupType
  AutoScalingGroupName: "STRING_VALUE", // required
  LaunchConfigurationName: "STRING_VALUE",
  LaunchTemplate: { // LaunchTemplateSpecification
    LaunchTemplateId: "STRING_VALUE",
    LaunchTemplateName: "STRING_VALUE",
    Version: "STRING_VALUE",
  },
  MixedInstancesPolicy: { // MixedInstancesPolicy
    LaunchTemplate: { // LaunchTemplate
      LaunchTemplateSpecification: {
        LaunchTemplateId: "STRING_VALUE",
        LaunchTemplateName: "STRING_VALUE",
        Version: "STRING_VALUE",
      },
      Overrides: [ // Overrides
        { // LaunchTemplateOverrides
          InstanceType: "STRING_VALUE",
          WeightedCapacity: "STRING_VALUE",
          LaunchTemplateSpecification: "<LaunchTemplateSpecification>",
          InstanceRequirements: { // InstanceRequirements
            VCpuCount: { // VCpuCountRequest
              Min: Number("int"), // required
              Max: Number("int"),
            },
            MemoryMiB: { // MemoryMiBRequest
              Min: Number("int"), // required
              Max: Number("int"),
            },
            CpuManufacturers: [ // CpuManufacturers
              "intel" || "amd" || "amazon-web-services",
            ],
            MemoryGiBPerVCpu: { // MemoryGiBPerVCpuRequest
              Min: Number("double"),
              Max: Number("double"),
            },
            ExcludedInstanceTypes: [ // ExcludedInstanceTypes
              "STRING_VALUE",
            ],
            InstanceGenerations: [ // InstanceGenerations
              "current" || "previous",
            ],
            SpotMaxPricePercentageOverLowestPrice: Number("int"),
            MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: Number("int"),
            OnDemandMaxPricePercentageOverLowestPrice: Number("int"),
            BareMetal: "included" || "excluded" || "required",
            BurstablePerformance: "included" || "excluded" || "required",
            RequireHibernateSupport: true || false,
            NetworkInterfaceCount: { // NetworkInterfaceCountRequest
              Min: Number("int"),
              Max: Number("int"),
            },
            LocalStorage: "included" || "excluded" || "required",
            LocalStorageTypes: [ // LocalStorageTypes
              "hdd" || "ssd",
            ],
            TotalLocalStorageGB: { // TotalLocalStorageGBRequest
              Min: Number("double"),
              Max: Number("double"),
            },
            BaselineEbsBandwidthMbps: { // BaselineEbsBandwidthMbpsRequest
              Min: Number("int"),
              Max: Number("int"),
            },
            AcceleratorTypes: [ // AcceleratorTypes
              "gpu" || "fpga" || "inference",
            ],
            AcceleratorCount: { // AcceleratorCountRequest
              Min: Number("int"),
              Max: Number("int"),
            },
            AcceleratorManufacturers: [ // AcceleratorManufacturers
              "nvidia" || "amd" || "amazon-web-services" || "xilinx",
            ],
            AcceleratorNames: [ // AcceleratorNames
              "a100" || "v100" || "k80" || "t4" || "m60" || "radeon-pro-v520" || "vu9p",
            ],
            AcceleratorTotalMemoryMiB: { // AcceleratorTotalMemoryMiBRequest
              Min: Number("int"),
              Max: Number("int"),
            },
            NetworkBandwidthGbps: { // NetworkBandwidthGbpsRequest
              Min: Number("double"),
              Max: Number("double"),
            },
            AllowedInstanceTypes: [ // AllowedInstanceTypes
              "STRING_VALUE",
            ],
            BaselinePerformanceFactors: { // BaselinePerformanceFactorsRequest
              Cpu: { // CpuPerformanceFactorRequest
                References: [ // PerformanceFactorReferenceSetRequest
                  { // PerformanceFactorReferenceRequest
                    InstanceFamily: "STRING_VALUE",
                  },
                ],
              },
            },
          },
        },
      ],
    },
    InstancesDistribution: { // InstancesDistribution
      OnDemandAllocationStrategy: "STRING_VALUE",
      OnDemandBaseCapacity: Number("int"),
      OnDemandPercentageAboveBaseCapacity: Number("int"),
      SpotAllocationStrategy: "STRING_VALUE",
      SpotInstancePools: Number("int"),
      SpotMaxPrice: "STRING_VALUE",
    },
  },
  InstanceId: "STRING_VALUE",
  MinSize: Number("int"), // required
  MaxSize: Number("int"), // required
  DesiredCapacity: Number("int"),
  DefaultCooldown: Number("int"),
  AvailabilityZones: [ // AvailabilityZones
    "STRING_VALUE",
  ],
  LoadBalancerNames: [ // LoadBalancerNames
    "STRING_VALUE",
  ],
  TargetGroupARNs: [ // TargetGroupARNs
    "STRING_VALUE",
  ],
  HealthCheckType: "STRING_VALUE",
  HealthCheckGracePeriod: Number("int"),
  PlacementGroup: "STRING_VALUE",
  VPCZoneIdentifier: "STRING_VALUE",
  TerminationPolicies: [ // TerminationPolicies
    "STRING_VALUE",
  ],
  NewInstancesProtectedFromScaleIn: true || false,
  CapacityRebalance: true || false,
  LifecycleHookSpecificationList: [ // LifecycleHookSpecifications
    { // LifecycleHookSpecification
      LifecycleHookName: "STRING_VALUE", // required
      LifecycleTransition: "STRING_VALUE", // required
      NotificationMetadata: "STRING_VALUE",
      HeartbeatTimeout: Number("int"),
      DefaultResult: "STRING_VALUE",
      NotificationTargetARN: "STRING_VALUE",
      RoleARN: "STRING_VALUE",
    },
  ],
  Tags: [ // Tags
    { // Tag
      ResourceId: "STRING_VALUE",
      ResourceType: "STRING_VALUE",
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE",
      PropagateAtLaunch: true || false,
    },
  ],
  ServiceLinkedRoleARN: "STRING_VALUE",
  MaxInstanceLifetime: Number("int"),
  Context: "STRING_VALUE",
  DesiredCapacityType: "STRING_VALUE",
  DefaultInstanceWarmup: Number("int"),
  TrafficSources: [ // TrafficSources
    { // TrafficSourceIdentifier
      Identifier: "STRING_VALUE", // required
      Type: "STRING_VALUE",
    },
  ],
  InstanceMaintenancePolicy: { // InstanceMaintenancePolicy
    MinHealthyPercentage: Number("int"),
    MaxHealthyPercentage: Number("int"),
  },
  AvailabilityZoneDistribution: { // AvailabilityZoneDistribution
    CapacityDistributionStrategy: "balanced-only" || "balanced-best-effort",
  },
  AvailabilityZoneImpairmentPolicy: { // AvailabilityZoneImpairmentPolicy
    ZonalShiftEnabled: true || false,
    ImpairedZoneHealthCheckBehavior: "ReplaceUnhealthy" || "IgnoreUnhealthy",
  },
  SkipZonalShiftValidation: true || false,
  CapacityReservationSpecification: { // CapacityReservationSpecification
    CapacityReservationPreference: "capacity-reservations-only" || "capacity-reservations-first" || "none" || "default",
    CapacityReservationTarget: { // CapacityReservationTarget
      CapacityReservationIds: [ // CapacityReservationIds
        "STRING_VALUE",
      ],
      CapacityReservationResourceGroupArns: [ // CapacityReservationResourceGroupArns
        "STRING_VALUE",
      ],
    },
  },
};
const command = new CreateAutoScalingGroupCommand(input);
const response = await client.send(command);
// {};

Example Usage

Loading code editor