Class: AWS.AutoScaling

/* This example attaches the specified load balancer to the specified Auto Scaling group. */

 var params = {
  AutoScalingGroupName: "my-auto-scaling-group", 
  LoadBalancerNames: [
     "my-load-balancer"
  ]
 };
 autoscaling.attachLoadBalancers(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  AutoScalingGroupName: 'STRING_VALUE', /* required */
  LoadBalancerNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
autoscaling.attachLoadBalancers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AutoScalingGroupName — (String)

    The name of the Auto Scaling group.

  • LoadBalancerNames — (Array<String>)

    The names of the load balancers. You can specify up to 10 load balancers.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example attaches the specified target group to the specified Auto Scaling group. */

 var params = {
  AutoScalingGroupName: "my-auto-scaling-group", 
  TargetGroupARNs: [
     "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
  ]
 };
 autoscaling.attachLoadBalancerTargetGroups(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  AutoScalingGroupName: 'STRING_VALUE', /* required */
  TargetGroupARNs: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
autoscaling.attachLoadBalancerTargetGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AutoScalingGroupName — (String)

    The name of the Auto Scaling group.

  • TargetGroupARNs — (Array<String>)

    The Amazon Resource Names (ARNs) of the target groups. You can specify up to 10 target groups. To get the ARN of a target group, use the Elastic Load Balancing DescribeTargetGroups API operation.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example attaches the specified target group to the specified Auto Scaling group. */

 var params = {
  AutoScalingGroupName: "my-auto-scaling-group", 
  TrafficSources: [
     {
    Identifier: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
   }
  ]
 };
 autoscaling.attachTrafficSources(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  AutoScalingGroupName: 'STRING_VALUE', /* required */
  TrafficSources: [ /* required */
    {
      Identifier: 'STRING_VALUE', /* required */
      Type: 'STRING_VALUE'
    },
    /* more items */
  ]
};
autoscaling.attachTrafficSources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AutoScalingGroupName — (String)

    The name of the Auto Scaling group.

  • TrafficSources — (Array<map>)

    The unique identifiers of one or more traffic sources. You can specify up to 10 traffic sources.

    • Identifier — required — (String)

      Identifies the traffic source.

      For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the Amazon Resource Name (ARN) for a target group in this account and Region. For Classic Load Balancers, this will be the name of the Classic Load Balancer in this account and Region.

      For example:

      • Application Load Balancer ARN: arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456

      • Classic Load Balancer name: my-classic-load-balancer

      • VPC Lattice ARN: arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456

      To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer, or the name of a Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations.

      To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API operation.

    • Type — (String)

      Provides additional context for the value of Identifier.

      The following lists the valid values:

      • elb if Identifier is the name of a Classic Load Balancer.

      • elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load Balancer, or Network Load Balancer target group.

      • vpc-lattice if Identifier is the ARN of a VPC Lattice target group.

      Required if the identifier is the name of a Classic Load Balancer.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AutoScalingGroupName: 'STRING_VALUE', /* required */
  ScheduledActionNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
autoscaling.batchDeleteScheduledAction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AutoScalingGroupName — (String)

    The name of the Auto Scaling group.

  • ScheduledActionNames — (Array<String>)

    The names of the scheduled actions to delete. The maximum number allowed is 50.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • FailedScheduledActions — (Array<map>)

      The names of the scheduled actions that could not be deleted, including an error message.

      • ScheduledActionName — required — (String)

        The name of the scheduled action.

      • ErrorCode — (String)

        The error code.

      • ErrorMessage — (String)

        The error message accompanying the error code.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AutoScalingGroupName: 'STRING_VALUE', /* required */
  ScheduledUpdateGroupActions: [ /* required */
    {
      ScheduledActionName: 'STRING_VALUE', /* required */
      DesiredCapacity: 'NUMBER_VALUE',
      EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
      MaxSize: 'NUMBER_VALUE',
      MinSize: 'NUMBER_VALUE',
      Recurrence: 'STRING_VALUE',
      StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
      TimeZone: 'STRING_VALUE'
    },
    /* more items */
  ]
};
autoscaling.batchPutScheduledUpdateGroupAction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AutoScalingGroupName — (String)

    The name of the Auto Scaling group.

  • ScheduledUpdateGroupActions — (Array<map>)

    One or more scheduled actions. The maximum number allowed is 50.

    • ScheduledActionName — required — (String)

      The name of the scaling action.

    • StartTime — (Date)

      The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z").

      If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

      If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message.

    • EndTime — (Date)

      The date and time for the recurring schedule to end, in UTC.

    • Recurrence — (String)

      The recurring schedule for the action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab.

      When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.

      Cron expressions use Universal Coordinated Time (UTC) by default.

    • MinSize — (Integer)

      The minimum size of the Auto Scaling group.

    • MaxSize — (Integer)

      The maximum size of the Auto Scaling group.

    • DesiredCapacity — (Integer)

      The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.

    • TimeZone — (String)

      Specifies the time zone for a cron expression. If a time zone is not provided, UTC is used by default.

      Valid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • FailedScheduledUpdateGroupActions — (Array<map>)

      The names of the scheduled actions that could not be created or updated, including an error message.

      • ScheduledActionName — required — (String)

        The name of the scheduled action.

      • ErrorCode — (String)

        The error code.

      • ErrorMessage — (String)

        The error message accompanying the error code.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example cancels an instance refresh operation in progress. */

 var params = {
  AutoScalingGroupName: "my-auto-scaling-group"
 };
 autoscaling.cancelInstanceRefresh(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    InstanceRefreshId: "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b"
   }
   */
 });

var params = {
  AutoScalingGroupName: 'STRING_VALUE' /* required */
};
autoscaling.cancelInstanceRefresh(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AutoScalingGroupName — (String)

    The name of the Auto Scaling group.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • InstanceRefreshId — (String)

      The instance refresh ID associated with the request. This is the unique ID assigned to the instance refresh when it was started.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example notifies Auto Scaling that the specified lifecycle action is complete so that it can finish launching or terminating the instance. */

 var params = {
  AutoScalingGroupName: "my-auto-scaling-group", 
  LifecycleActionResult: "CONTINUE", 
  LifecycleActionToken: "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635", 
  LifecycleHookName: "my-lifecycle-hook"
 };
 autoscaling.completeLifecycleAction(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  AutoScalingGroupName: 'STRING_VALUE', /* required */
  LifecycleActionResult: 'STRING_VALUE', /* required */
  LifecycleHookName: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE',
  LifecycleActionToken: 'STRING_VALUE'
};
autoscaling.completeLifecycleAction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LifecycleHookName — (String)

    The name of the lifecycle hook.

  • AutoScalingGroupName — (String)

    The name of the Auto Scaling group.

  • LifecycleActionToken — (String)

    A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

  • LifecycleActionResult — (String)

    The action for the group to take. You can specify either CONTINUE or ABANDON.

  • InstanceId — (String)

    The ID of the instance.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example creates an Auto Scaling group. */

 var params = {
  AutoScalingGroupName: "my-auto-scaling-group", 
  DefaultInstanceWarmup: 120, 
  LaunchTemplate: {
   LaunchTemplateName: "my-template-for-auto-scaling", 
   Version: "$Default"
  }, 
  MaxInstanceLifetime: 2592000, 
  MaxSize: 3, 
  MinSize: 1, 
  VPCZoneIdentifier: "subnet-057fa0918fEXAMPLE"
 };
 autoscaling.createAutoScalingGroup(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

/* This example creates an Auto Scaling group and attaches the specified target group. */

 var params = {
  AutoScalingGroupName: "my-auto-scaling-group", 
  HealthCheckGracePeriod: 300, 
  HealthCheckType: "ELB", 
  LaunchTemplate: {
   LaunchTemplateName: "my-template-for-auto-scaling", 
   Version: "$Default"
  }, 
  MaxSize: 3, 
  MinSize: 1, 
  TargetGroupARNs: [
     "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
  ], 
  VPCZoneIdentifier: "subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE"
 };
 autoscaling.createAutoScalingGroup(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

/* This example creates an Auto Scaling group with a mixed instances policy. It specifies the c5.large, c5a.large, and c6g.large instance types and defines a different launch template for the c6g.large instance type. */

 var params = {
  AutoScalingGroupName: "my-asg", 
  DesiredCapacity: 3, 
  MaxSize: 5, 
  MinSize: 1, 
  MixedInstancesPolicy: {
   InstancesDistribution: {
    OnDemandBaseCapacity: 1, 
    OnDemandPercentageAboveBaseCapacity: 50, 
    SpotAllocationStrategy: "price-capacity-optimized"
   }, 
   LaunchTemplate: {
    LaunchTemplateSpecification: {
     LaunchTemplateName: "my-launch-template-for-x86", 
     Version: "$Default"
    }, 
    Overrides: [
       {
      InstanceType: "c6g.large", 
      LaunchTemplateSpecification: {
       LaunchTemplateName: "my-launch-template-for-arm", 
       Version: "$Default"
      }
     }, 
       {
      InstanceType: "c5.large"
     }, 
       {
      InstanceType: "c5a.large"
     }
    ]
   }
  }, 
  VPCZoneIdentifier: "subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE"
 };
 autoscaling.createAutoScalingGroup(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

/* This example creates an Auto Scaling group using attribute-based instance type selection. It requires the instance types to have a minimum of four vCPUs and a maximum of eight vCPUs, a minimum of 16,384 MiB of memory, and an Intel manufactured CPU. */

 var params = {
  AutoScalingGroupName: "my-asg", 
  DesiredCapacity: 4, 
  DesiredCapacityType: "units", 
  MaxSize: 100, 
  MinSize: 0, 
  MixedInstancesPolicy: {
   InstancesDistribution: {
    OnDemandPercentageAboveBaseCapacity: 50, 
    SpotAllocationStrategy: "price-capacity-optimized"
   }, 
   LaunchTemplate: {
    LaunchTemplateSpecification: {
     LaunchTemplateName: "my-template-for-auto-scaling", 
     Version: "$Default"
    }, 
    Overrides: [
       {
      InstanceRequirements: {
       CpuManufacturers: [
          "intel"
       ], 
       MemoryMiB: {
        Min: 16384
       }, 
       VCpuCount: {
        Max: 8, 
        Min: 4
       }
      }
     }
    ]
   }
  }, 
  VPCZoneIdentifier: "subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE"
 };
 autoscaling.createAutoScalingGroup(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

var params = {
  AutoScalingGroupName: 'STRING_VALUE', /* required */
  MaxSize: 'NUMBER_VALUE', /* required */
  MinSize: 'NUMBER_VALUE', /* required */
  AvailabilityZones: [
    'STRING_VALUE',
    /* more items */
  ],
  CapacityRebalance: true || false,
  Context: 'STRING_VALUE',
  DefaultCooldown: 'NUMBER_VALUE',
  DefaultInstanceWarmup: 'NUMBER_VALUE',
  DesiredCapacity: 'NUMBER_VALUE',
  DesiredCapacityType: 'STRING_VALUE',
  HealthCheckGracePeriod: 'NUMBER_VALUE',
  HealthCheckType: 'STRING_VALUE',
  InstanceId: 'STRING_VALUE',
  InstanceMaintenancePolicy: {
    MaxHealthyPercentage: 'NUMBER_VALUE',
    MinHealthyPercentage: 'NUMBER_VALUE'
  },
  LaunchConfigurationName: 'STRING_VALUE',
  LaunchTemplate: {
    LaunchTemplateId: 'STRING_VALUE',
    LaunchTemplateName: 'STRING_VALUE',
    Version: 'STRING_VALUE'
  },
  LifecycleHookSpecificationList: [
    {
      LifecycleHookName: 'STRING_VALUE', /* required */
      LifecycleTransition: 'STRING_VALUE', /* required */
      DefaultResult: 'STRING_VALUE',
      HeartbeatTimeout: 'NUMBER_VALUE',
      NotificationMetadata: 'STRING_VALUE',
      NotificationTargetARN: 'STRING_VALUE',
      RoleARN: 'STRING_VALUE'
    },
    /* more items */
  ],
  LoadBalancerNames: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxInstanceLifetime: 'NUMBER_VALUE',
  MixedInstancesPolicy: {
    InstancesDistribution: {
      OnDemandAllocationStrategy: 'STRING_VALUE',
      OnDemandBaseCapacity: 'NUMBER_VALUE',
      OnDemandPercentageAboveBaseCapacity: 'NUMBER_VALUE',
      SpotAllocationStrategy: 'STRING_VALUE',
      SpotInstancePools: 'NUMBER_VALUE',
      SpotMaxPrice: 'STRING_VALUE'
    },
    LaunchTemplate: {
      LaunchTemplateSpecification: {
        LaunchTemplateId: 'STRING_VALUE',
        LaunchTemplateName: 'STRING_VALUE',
        Version: 'STRING_VALUE'
      },
      Overrides: [
        {
          InstanceRequirements: {
            MemoryMiB: { /* required */
              Min: 'NUMBER_VALUE', /* required */
              Max: 'NUMBER_VALUE'
            },
            VCpuCount: { /* required */
              Min: 'NUMBER_VALUE', /* required */
              Max: 'NUMBER_VALUE'
            },
            AcceleratorCount: {
              Max: 'NUMBER_VALUE',
              Min: 'NUMBER_VALUE'
            },
            AcceleratorManufacturers: [
              nvidia | amd | amazon-web-services | xilinx,
              /* more items */
            ],
            AcceleratorNames: [
              a100 | v100 | k80 | t4 | m60 | radeon-pro-v520 | vu9p,
              /* more items */
            ],
            AcceleratorTotalMemoryMiB: {
              Max: 'NUMBER_VALUE',
              Min: 'NUMBER_VALUE'
            },
            AcceleratorTypes: [
              gpu | fpga | inference,
              /* more items */
            ],
            AllowedInstanceTypes: [
              'STRING_VALUE',
              /* more items */
            ],
            BareMetal: included | excluded | required,
            BaselineEbsBandwidthMbps: {
              Max: 'NUMBER_VALUE',
              Min: 'NUMBER_VALUE'
            },
            BurstablePerformance: included | excluded | required,
            CpuManufacturers: [
              intel | amd | amazon-web-services,
              /* more items */
            ],
            ExcludedInstanceTypes: [
              'STRING_VALUE',
              /* more items */
            ],
            InstanceGenerations: [
              current | previous,
              /* more items */
            ],
            LocalStorage: included | excluded | required,
            LocalStorageTypes: [
              hdd | ssd,
              /* more items */
            ],
            MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: 'NUMBER_VALUE',
            MemoryGiBPerVCpu: {
              Max: 'NUMBER_VALUE',
              Min: 'NUMBER_VALUE'
            },
            NetworkBandwidthGbps: {
              Max: 'NUMBER_VALUE',
              Min: 'NUMBER_VALUE'
            },
            NetworkInterfaceCount: {
              Max: 'NUMBER_VALUE',
              Min: 'NUMBER_VALUE'
            },
            OnDemandMaxPricePercentageOverLowestPrice: 'NUMBER_VALUE',
            RequireHibernateSupport: true || false,
            SpotMaxPricePercentageOverLowestPrice: 'NUMBER_VALUE',
            TotalLocalStorageGB: {
              Max: 'NUMBER_VALUE',
              Min: 'NUMBER_VALUE'
            }
          },
          InstanceType: 'STRING_VALUE',
          LaunchTemplateSpecification: {
            LaunchTemplateId: 'STRING_VALUE',
            LaunchTemplateName: 'STRING_VALUE',
            Version: 'STRING_VALUE'
          },
          WeightedCapacity: 'STRING_VALUE'
        },
        /* more items */
      ]
    }
  },
  NewInstancesProtectedFromScaleIn: true || false,
  PlacementGroup: 'STRING_VALUE',
  ServiceLinkedRoleARN: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      PropagateAtLaunch: true || false,
      ResourceId: 'STRING_VALUE',
      ResourceType: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TargetGroupARNs: [
    'STRING_VALUE',
    /* more items */
  ],
  TerminationPolicies: [
    'STRING_VALUE',
    /* more items */
  ],
  TrafficSources: [
    {
      Identifier: 'STRING_VALUE', /* required */
      Type: 'STRING_VALUE'
    },
    /* more items */
  ],
  VPCZoneIdentifier: 'STRING_VALUE'
};
autoscaling.createAutoScalingGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AutoScalingGroupName — (String)

    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.

    Note: You cannot use a colon (:) in the name.
  • LaunchConfigurationName — (String)

    The name of the launch configuration to use to launch instances.

    Conditional: You must specify either a launch template (LaunchTemplate or MixedInstancesPolicy) or a launch configuration (LaunchConfigurationName or InstanceId).

  • LaunchTemplate — (map)

    Information used to specify the launch template and version to use to launch instances.

    Conditional: You must specify either a launch template (LaunchTemplate or MixedInstancesPolicy) or a launch configuration (LaunchConfigurationName or InstanceId).

    Note: The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see Create a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
    • LaunchTemplateId — (String)

      The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

      Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

    • LaunchTemplateName — (String)

      The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

      Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

    • Version — (String)

      The version number, $Latest, or $Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.

  • MixedInstancesPolicy — (map)

    The mixed instances policy. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.

    • LaunchTemplate — (map)

      One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities.

      • LaunchTemplateSpecification — (map)

        The launch template.

        • LaunchTemplateId — (String)

          The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

          Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

        • LaunchTemplateName — (String)

          The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

          Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

        • Version — (String)

          The version number, $Latest, or $Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.

      • Overrides — (Array<map>)

        Any properties that you specify override the same properties in the launch template.

        • InstanceType — (String)

          The instance type, such as m3.xlarge. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see Instance types in the Amazon EC2 User Guide for Linux Instances.

          You can specify up to 40 instance types per Auto Scaling group.

        • WeightedCapacity — (String)

          If you provide a list of instance types to use, you can specify the number of capacity units provided by each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a WeightedCapacity of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see Configure an Auto Scaling group to use instance weights in the Amazon EC2 Auto Scaling User Guide. Value must be in the range of 1–999.

          If you specify a value for WeightedCapacity for one instance type, you must specify a value for WeightedCapacity for all of them.

          Every Auto Scaling group has three size parameters (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.

        • LaunchTemplateSpecification — (map)

          Provides a launch template for the specified instance type or set of instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in the LaunchTemplate definition. For more information, see Specifying a different launch template for an instance type in the Amazon EC2 Auto Scaling User Guide.

          You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the LaunchTemplate definition count towards this limit.

          • LaunchTemplateId — (String)

            The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

            Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

          • LaunchTemplateName — (String)

            The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

            Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

          • Version — (String)

            The version number, $Latest, or $Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.

        • InstanceRequirements — (map)

          The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.

          You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template.

          Note: If you specify InstanceRequirements, you can't specify InstanceType.
          • VCpuCount — required — (map)

            The minimum and maximum number of vCPUs for an instance type.

            • Min — required — (Integer)

              The minimum number of vCPUs.

            • Max — (Integer)

              The maximum number of vCPUs.

          • MemoryMiB — required — (map)

            The minimum and maximum instance memory size for an instance type, in MiB.

            • Min — required — (Integer)

              The memory minimum in MiB.

            • Max — (Integer)

              The memory maximum in MiB.

          • CpuManufacturers — (Array<String>)

            Lists which specific CPU manufacturers to include.

            • For instance types with Intel CPUs, specify intel.

            • For instance types with AMD CPUs, specify amd.

            • For instance types with Amazon Web Services CPUs, specify amazon-web-services.

            Note: Don't confuse the CPU hardware manufacturer with the CPU hardware architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.

            Default: Any manufacturer

          • MemoryGiBPerVCpu — (map)

            The minimum and maximum amount of memory per vCPU for an instance type, in GiB.

            Default: No minimum or maximum limits

            • Min — (Float)

              The memory minimum in GiB.

            • Max — (Float)

              The memory maximum in GiB.

          • ExcludedInstanceTypes — (Array<String>)

            The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (*), to exclude an instance family, type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.

            For example, if you specify c5*, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types.

            Note: If you specify ExcludedInstanceTypes, you can't specify AllowedInstanceTypes.

            Default: No excluded instance types

          • InstanceGenerations — (Array<String>)

            Indicates whether current or previous generation instance types are included.

            • For current generation instance types, specify current. The current generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide for Linux Instances.

            • For previous generation instance types, specify previous.

            Default: Any current or previous generation

          • SpotMaxPricePercentageOverLowestPrice — (Integer)

            [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.

            The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

            If you set DesiredCapacityType to vcpu or memory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price.

            Note: Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
          • MaxSpotPriceAsPercentageOfOptimalOnDemandPrice — (Integer)

            [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.

            The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

            If you set DesiredCapacityType to vcpu or memory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price.

            Note: Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
          • OnDemandMaxPricePercentageOverLowestPrice — (Integer)

            [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.

            The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

            To turn off price protection, specify a high value, such as 999999.

            If you set DesiredCapacityType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price.

            Default: 20

          • BareMetal — (String)

            Indicates whether bare metal instance types are included, excluded, or required.

            Default: excluded

            Possible values include:
            • "included"
            • "excluded"
            • "required"
          • BurstablePerformance — (String)

            Indicates whether burstable performance instance types are included, excluded, or required. For more information, see Burstable performance instances in the Amazon EC2 User Guide for Linux Instances.

            Default: excluded

            Possible values include:
            • "included"
            • "excluded"
            • "required"
          • RequireHibernateSupport — (Boolean)

            Indicates whether instance types must provide On-Demand Instance hibernation support.

            Default: false

          • NetworkInterfaceCount — (map)

            The minimum and maximum number of network interfaces for an instance type.

            Default: No minimum or maximum limits

            • Min — (Integer)

              The minimum number of network interfaces.

            • Max — (Integer)

              The maximum number of network interfaces.

          • LocalStorage — (String)

            Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide for Linux Instances.

            Default: included

            Possible values include:
            • "included"
            • "excluded"
            • "required"
          • LocalStorageTypes — (Array<String>)

            Indicates the type of local storage that is required.

            • For instance types with hard disk drive (HDD) storage, specify hdd.

            • For instance types with solid state drive (SSD) storage, specify ssd.

            Default: Any local storage type

          • TotalLocalStorageGB — (map)

            The minimum and maximum total local storage size for an instance type, in GB.

            Default: No minimum or maximum limits

            • Min — (Float)

              The storage minimum in GB.

            • Max — (Float)

              The storage maximum in GB.

          • BaselineEbsBandwidthMbps — (map)

            The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide for Linux Instances.

            Default: No minimum or maximum limits

            • Min — (Integer)

              The minimum value in Mbps.

            • Max — (Integer)

              The maximum value in Mbps.

          • AcceleratorTypes — (Array<String>)

            Lists the accelerator types that must be on an instance type.

            • For instance types with GPU accelerators, specify gpu.

            • For instance types with FPGA accelerators, specify fpga.

            • For instance types with inference accelerators, specify inference.

            Default: Any accelerator type

          • AcceleratorCount — (map)

            The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) for an instance type.

            To exclude accelerator-enabled instance types, set Max to 0.

            Default: No minimum or maximum limits

            • Min — (Integer)

              The minimum value.

            • Max — (Integer)

              The maximum value.

          • AcceleratorManufacturers — (Array<String>)

            Indicates whether instance types must have accelerators by specific manufacturers.

            • For instance types with NVIDIA devices, specify nvidia.

            • For instance types with AMD devices, specify amd.

            • For instance types with Amazon Web Services devices, specify amazon-web-services.

            • For instance types with Xilinx devices, specify xilinx.

            Default: Any manufacturer

          • AcceleratorNames — (Array<String>)

            Lists the accelerators that must be on an instance type.

            • For instance types with NVIDIA A100 GPUs, specify a100.

            • For instance types with NVIDIA V100 GPUs, specify v100.

            • For instance types with NVIDIA K80 GPUs, specify k80.

            • For instance types with NVIDIA T4 GPUs, specify t4.

            • For instance types with NVIDIA M60 GPUs, specify m60.

            • For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.

            • For instance types with Xilinx VU9P FPGAs, specify vu9p.

            Default: Any accelerator

          • AcceleratorTotalMemoryMiB — (map)

            The minimum and maximum total memory size for the accelerators on an instance type, in MiB.

            Default: No minimum or maximum limits

            • Min — (Integer)

              The memory minimum in MiB.

            • Max — (Integer)

              The memory maximum in MiB.

          • NetworkBandwidthGbps — (map)

            The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).

            Default: No minimum or maximum limits

            • Min — (Float)

              The minimum amount of network bandwidth, in gigabits per second (Gbps).

            • Max — (Float)

              The maximum amount of network bandwidth, in gigabits per second (Gbps).

          • AllowedInstanceTypes — (Array<String>)

            The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.

            You can use strings with one or more wild cards, represented by an asterisk (*), to allow an instance type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.

            For example, if you specify c5*, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types.

            Note: If you specify AllowedInstanceTypes, you can't specify ExcludedInstanceTypes.

            Default: All instance types

    • InstancesDistribution — (map)

      The instances distribution.

      • OnDemandAllocationStrategy — (String)

        The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.

        The following lists the valid values:

        lowest-price

        Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements.

        prioritized

        You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do.

      • OnDemandBaseCapacity — (Integer)

        The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales.

        This number has the same unit of measurement as the group's desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement.

        Default: 0

      • OnDemandPercentageAboveBaseCapacity — (Integer)

        Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used.

        Default: 100

      • SpotAllocationStrategy — (String)

        The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.

        The following lists the valid values:

        capacity-optimized

        Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized.

        capacity-optimized-prioritized

        You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements.

        lowest-price

        Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the SpotInstancePools property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity.

        price-capacity-optimized (recommended)

        The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price.

      • SpotInstancePools — (Integer)

        The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the SpotAllocationStrategy is lowest-price. Value must be in the range of 1–20.

        Default: 2

      • SpotMaxPrice — (String)

        The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string ("") for the value.

        If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one.

        Valid Range: Minimum value of 0.001

  • InstanceId — (String)

    The ID of the instance used to base the launch configuration on. If specified, Amazon EC2 Auto Scaling uses the configuration values from the specified instance to create a new launch configuration. To get the instance ID, use the Amazon EC2 DescribeInstances API operation. For more information, see Create an Auto Scaling group using parameters from an existing instance in the Amazon EC2 Auto Scaling User Guide.

  • MinSize — (Integer)

    The minimum size of the group.

  • MaxSize — (Integer)

    The maximum size of the group.

    Note: 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 above MaxSize by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).
  • DesiredCapacity — (Integer)

    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 auto scaling. This 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, the default is the minimum size of the group.

  • DefaultCooldown — (Integer)

    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

  • AvailabilityZones — (Array<String>)

    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.

  • LoadBalancerNames — (Array<String>)

    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.

  • TargetGroupARNs — (Array<String>)

    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.

  • HealthCheckType — (String)

    A comma-separated value string of one or more health check types.

    The valid values are EC2, EBS, ELB, and VPC_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.

  • HealthCheckGracePeriod — (Integer)

    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

  • PlacementGroup — (String)

    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.

    Note: 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.
  • VPCZoneIdentifier — (String)

    A comma-separated list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created. If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify must reside in those Availability Zones.

  • TerminationPolicies — (Array<String>)

    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

  • NewInstancesProtectedFromScaleIn — (Boolean)

    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.

  • CapacityRebalance — (Boolean)

    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.

  • LifecycleHookSpecificationList — (Array<map>)

    One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.

    • LifecycleHookName — required — (String)

      The name of the lifecycle hook.

    • LifecycleTransition — required — (String)

      The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.

      • To create a lifecycle hook for scale-out events, specify autoscaling:EC2_INSTANCE_LAUNCHING.

      • To create a lifecycle hook for scale-in events, specify autoscaling:EC2_INSTANCE_TERMINATING.

    • NotificationMetadata — (String)

      Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

    • HeartbeatTimeout — (Integer)

      The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

    • DefaultResult — (String)

      The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ABANDON.

      Valid values: CONTINUE | ABANDON

    • NotificationTargetARN — (String)

      The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.

    • RoleARN — (String)

      The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see Prepare to add a lifecycle hook to your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

      Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.

  • Tags — (Array<map>)

    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.

    • ResourceId — (String)

      The name of the Auto Scaling group.

    • ResourceType — (String)

      The type of resource. The only supported value is auto-scaling-group.

    • Key — required — (String)

      The tag key.

    • Value — (String)

      The tag value.

    • PropagateAtLaunch — (Boolean)

      Determines whether the tag is added to new instances as they are launched in the group.

  • ServiceLinkedRoleARN — (String)

    The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services 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.

  • MaxInstanceLifetime — (Integer)

    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.

  • Context — (String)

    Reserved.

  • DesiredCapacityType — (String)

    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

  • DefaultInstanceWarmup — (Integer)

    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 the InService 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 of 0 or other nominal value.

    Default: None

  • TrafficSources — (Array<map>)

    The list of traffic sources to attach to this Auto Scaling group. You can use any of the following as traffic sources for an Auto Scaling group: Classic Load Balancer, Application Load Balancer, Gateway Load Balancer, Network Load Balancer, and VPC Lattice.

    • Identifier — required — (String)

      Identifies the traffic source.

      For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the Amazon Resource Name (ARN) for a target group in this account and Region. For Classic Load Balancers, this will be the name of the Classic Load Balancer in this account and Region.

      For example:

      • Application Load Balancer ARN: arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456

      • Classic Load Balancer name: my-classic-load-balancer

      • VPC Lattice ARN: arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456

      To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer, or the name of a Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations.

      To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API operation.

    • Type — (String)

      Provides additional context for the value of Identifier.

      The following lists the valid values:

      • elb if Identifier is the name of a Classic Load Balancer.

      • elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load Balancer, or Network Load Balancer target group.

      • vpc-lattice if Identifier is the ARN of a VPC Lattice target group.

      Required if the identifier is the name of a Classic Load Balancer.

  • InstanceMaintenancePolicy — (map)

    An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.

    • MinHealthyPercentage — (Integer)

      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. To clear a previously set value, specify a value of -1.

    • MaxHealthyPercentage — (Integer)

      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 100 to 200. To clear a previously set value, specify a value of -1.

      Both MinHealthyPercentage and MaxHealthyPercentage 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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example creates a launch configuration. */

 var params = {
  IamInstanceProfile: "my-iam-role", 
  ImageId: "ami-12345678", 
  InstanceType: "m3.medium", 
  LaunchConfigurationName: "my-launch-config", 
  SecurityGroups: [
     "sg-eb2af88e"
  ]
 };
 autoscaling.createLaunchConfiguration(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

var params = {
  LaunchConfigurationName: 'STRING_VALUE', /* required */
  AssociatePublicIpAddress: true || false,
  BlockDeviceMappings: [
    {
      DeviceName: 'STRING_VALUE', /* required */
      Ebs: {
        DeleteOnTermination: true || false,
        Encrypted: true || false,
        Iops: 'NUMBER_VALUE',
        SnapshotId: 'STRING_VALUE',
        Throughput: 'NUMBER_VALUE',
        VolumeSize: 'NUMBER_VALUE',
        VolumeType: 'STRING_VALUE'
      },
      NoDevice: true || false,
      VirtualName: 'STRING_VALUE'
    },
    /* more items */
  ],
  ClassicLinkVPCId: 'STRING_VALUE',
  ClassicLinkVPCSecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  EbsOptimized: true || false,
  IamInstanceProfile: 'STRING_VALUE',
  ImageId: 'STRING_VALUE',
  InstanceId: 'STRING_VALUE',
  InstanceMonitoring: {
    Enabled: true || false
  },
  InstanceType: 'STRING_VALUE',
  KernelId: 'STRING_VALUE',
  KeyName: 'STRING_VALUE',
  MetadataOptions: {
    HttpEndpoint: disabled | enabled,
    HttpPutResponseHopLimit: 'NUMBER_VALUE',
    HttpTokens: optional | required
  },
  PlacementTenancy: 'STRING_VALUE',
  RamdiskId: 'STRING_VALUE',
  SecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  SpotPrice: 'STRING_VALUE',
  UserData: 'STRING_VALUE'
};
autoscaling.createLaunchConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LaunchConfigurationName — (String)

    The name of the launch configuration. This name must be unique per Region per account.

  • ImageId — (String)

    The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see Find a Linux AMI in the Amazon EC2 User Guide for Linux Instances.

    If you specify InstanceId, an ImageId is not required.

  • KeyName — (String)

    The name of the key pair. For more information, see Amazon EC2 key pairs and Amazon EC2 instances in the Amazon EC2 User Guide for Linux Instances.

  • SecurityGroups — (Array<String>)

    A list that contains the security group IDs to assign to the instances in the Auto Scaling group. For more information, see Control traffic to your Amazon Web Services resources using security groups in the Amazon Virtual Private Cloud User Guide.

  • ClassicLinkVPCId — (String)

    Available for backward compatibility.

  • ClassicLinkVPCSecurityGroups — (Array<String>)

    Available for backward compatibility.

  • UserData — (String)

    The user data to make available to the launched EC2 instances. For more information, see Instance metadata and user data (Linux) and Instance metadata and user data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.

  • InstanceId — (String)

    The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for the block device mapping.

    To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.

    For more information, see Create a launch configuration in the Amazon EC2 Auto Scaling User Guide.

  • InstanceType — (String)

    Specifies the instance type of the EC2 instance. For information about available instance types, see Available instance types in the Amazon EC2 User Guide for Linux Instances.

    If you specify InstanceId, an InstanceType is not required.

  • KernelId — (String)

    The ID of the kernel associated with the AMI.

    Note: We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances.
  • RamdiskId — (String)

    The ID of the RAM disk to select.

    Note: We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances.
  • BlockDeviceMappings — (Array<map>)

    The block device mapping entries that define the block devices to attach to the instances at launch. By default, the block devices specified in the block device mapping for the AMI are used. For more information, see Block device mappings in the Amazon EC2 User Guide for Linux Instances.

    • VirtualName — (String)

      The name of the instance store volume (virtual device) to attach to an instance at launch. The name must be in the form ephemeralX where X is a number starting from zero (0), for example, ephemeral0.

    • DeviceName — required — (String)

      The device name assigned to the volume (for example, /dev/sdh or xvdh). For more information, see Device naming on Linux instances in the Amazon EC2 User Guide for Linux Instances.

      Note: To define a block device mapping, set the device name and exactly one of the following properties: Ebs, NoDevice, or VirtualName.
    • Ebs — (map)

      Information to attach an EBS volume to an instance at launch.

      • SnapshotId — (String)

        The snapshot ID of the volume to use.

        You must specify either a VolumeSize or a SnapshotId.

      • VolumeSize — (Integer)

        The volume size, in GiBs. The following are the supported volumes sizes for each volume type:

        • gp2 and gp3: 1-16,384

        • io1: 4-16,384

        • st1 and sc1: 125-16,384

        • standard: 1-1,024

        You must specify either a SnapshotId or a VolumeSize. If you specify both SnapshotId and VolumeSize, the volume size must be equal or greater than the size of the snapshot.

      • VolumeType — (String)

        The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.

        Valid values: standard | io1 | gp2 | st1 | sc1 | gp3

      • DeleteOnTermination — (Boolean)

        Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

      • Iops — (Integer)

        The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For gp3 and io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

        The following are the supported values for each volume type:

        • gp3: 3,000-16,000 IOPS

        • io1: 100-64,000 IOPS

        For io1 volumes, we guarantee 64,000 IOPS only for Instances built on the Amazon Web Services Nitro System. Other instance families guarantee performance up to 32,000 IOPS.

        Iops is supported when the volume type is gp3 or io1 and required only when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)

      • Encrypted — (Boolean)

        Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Requirements for Amazon EBS encryption in the Amazon EBS User Guide. If your AMI uses encrypted volumes, you can also only launch it on supported instance types.

        Note: If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using a launch configuration. If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was encrypted. For more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User Guide.
      • Throughput — (Integer)

        The throughput (MiBps) to provision for a gp3 volume.

    • NoDevice — (Boolean)

      Setting this value to true prevents a volume that is included in the block device mapping of the AMI from being mapped to the specified device name at launch.

      If NoDevice is true for the root device, instances might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.

  • InstanceMonitoring — (map)

    Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring.

    The default value is true (enabled).

    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. For more information, see Configure monitoring for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.

    • Enabled — (Boolean)

      If true, detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

  • SpotPrice — (String)

    The maximum hourly price 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 price. For more information, see Request Spot Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide.

    Valid Range: Minimum value of 0.001

    Note: When you change your maximum price by creating a new launch configuration, running instances will continue to run as long as the maximum price for those running instances is higher than the current Spot price.
  • IamInstanceProfile — (String)

    The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. For more information, see IAM role for applications that run on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.

  • EbsOptimized — (Boolean)

    Specifies whether the launch configuration is optimized for EBS I/O (true) or not (false). The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional fees are incurred when you enable EBS optimization for an instance type that is not EBS-optimized by default. For more information, see Amazon EBS-optimized instances in the Amazon EC2 User Guide for Linux Instances.

    The default value is false.

  • AssociatePublicIpAddress — (Boolean)

    Specifies whether to assign a public IPv4 address to the group's instances. If the instance is launched into a default subnet, the default is to assign a public IPv4 address, unless you disabled the option to assign a public IPv4 address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IPv4 address, unless you enabled the option to assign a public IPv4 address on the subnet.

    If you specify true, each instance in the Auto Scaling group receives a unique public IPv4 address. For more information, see Provide network connectivity for your Auto Scaling instances using Amazon VPC in the Amazon EC2 Auto Scaling User Guide.

    If you specify this property, you must specify at least one subnet for VPCZoneIdentifier when you create your group.

  • PlacementTenancy — (String)

    The tenancy of the instance, either default or dedicated. An instance with dedicated tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC. To launch dedicated instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to default), you must set the value of this property to dedicated.

    If you specify PlacementTenancy, you must specify at least one subnet for VPCZoneIdentifier when you create your group.

    Valid values: default | dedicated

  • MetadataOptions — (map)

    The metadata options for the instances. For more information, see Configure the instance metadata options in the Amazon EC2 Auto Scaling User Guide.

    • HttpTokens — (String)

      The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

      If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

      If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

      Possible values include:
      • "optional"
      • "required"
    • HttpPutResponseHopLimit — (Integer)

      The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

      Default: 1

    • HttpEndpoint — (String)

      This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.

      Note: If you specify a value of disabled, you will not be able to access your instance metadata.
      Possible values include:
      • "disabled"
      • "enabled"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example adds two tags to the specified Auto Scaling group. */

 var params = {
  Tags: [
     {
    Key: "Role", 
    PropagateAtLaunch: true, 
    ResourceId: "my-auto-scaling-group", 
    ResourceType: "auto-scaling-group", 
    Value: "WebServer"
   }, 
     {
    Key: "Dept", 
    PropagateAtLaunch: true, 
    ResourceId: "my-auto-scaling-group", 
    ResourceType: "auto-scaling-group", 
    Value: "Research"
   }
  ]
 };
 autoscaling.createOrUpdateTags(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

var params = {
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      PropagateAtLaunch: true || false,
      ResourceId: 'STRING_VALUE',
      ResourceType: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
autoscaling.createOrUpdateTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Tags — (Array<map>)

    One or more tags.

    • ResourceId — (String)

      The name of the Auto Scaling group.

    • ResourceType — (String)

      The type of resource. The only supported value is auto-scaling-group.

    • Key — required — (String)

      The tag key.

    • Value — (String)

      The tag value.

    • PropagateAtLaunch — (Boolean)

      Determines whether the tag is added to new instances as they are launched in the group.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example deletes the specified Auto Scaling group. */

 var params = {
  AutoScalingGroupName: "my-auto-scaling-group"
 };
 autoscaling.deleteAutoScalingGroup(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

/* This example deletes the specified Auto Scaling group and all its instances. */

 var params = {
  AutoScalingGroupName: "my-auto-scaling-group", 
  ForceDelete: true
 };
 autoscaling.deleteAutoScalingGroup(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

var params = {
  AutoScalingGroupName: 'STRING_VALUE', /* required */
  ForceDelete: true || false
};
autoscaling.deleteAutoScalingGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AutoScalingGroupName — (String)

    The name of the Auto Scaling group.

  • ForceDelete — (Boolean)

    Specifies that the group is to be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This action also deletes any outstanding lifecycle actions associated with the group.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example deletes the specified launch configuration. */

 var params = {
  LaunchConfigurationName: "my-launch-config"
 };
 autoscaling.deleteLaunchConfiguration(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

var params = {
  LaunchConfigurationName: 'STRING_VALUE' /* required */
};
autoscaling.deleteLaunchConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LaunchConfigurationName — (String)

    The name of the launch configuration.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example deletes the specified lifecycle hook. */

 var params = {
  AutoScalingGroupName: "my-auto-scaling-group", 
  LifecycleHookName: "my-lifecycle-hook"
 };
 autoscaling.deleteLifecycleHook(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  AutoScalingGroupName: 'STRING_VALUE', /* required */
  LifecycleHookName: 'STRING_VALUE' /* required */
};
autoscaling.deleteLifecycleHook(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LifecycleHookName — (String)

    The name of the lifecycle hook.

  • AutoScalingGroupName — (String)

    The name of the Auto Scaling group.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example deletes the specified notification from the specified Auto Scaling group. */

 var params = {
  AutoScalingGroupName: "my-auto-scaling-group", 
  TopicARN: "arn:aws:sns:us-west-2:123456789012:my-sns-topic"
 };
 autoscaling.deleteNotificationConfiguration(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

var params = {
  AutoScalingGroupName: 'STRING_VALUE', /* required */
  TopicARN: 'STRING_VALUE' /* required */
};
autoscaling.deleteNotificationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AutoScalingGroupName — (String)

    The name of the Auto Scaling group.

  • TopicARN — (String)

    The Amazon Resource Name (ARN) of the Amazon SNS topic.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example deletes the specified Auto Scaling policy. */

 var params = {
  AutoScalingGroupName: "my-auto-scaling-group", 
  PolicyName: "my-step-scale-out-policy"
 };
 autoscaling.deletePolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

var params = {
  PolicyName: 'STRING_VALUE', /* required */
  AutoScalingGroupName: 'STRING_VALUE'
};
autoscaling.deletePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AutoScalingGroupName — (String)

    The name of the Auto Scaling group.

  • PolicyName — (String)

    The name or Amazon Resource Name (ARN) of the policy.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example deletes the specified scheduled action from the specified Auto Scaling group. */

 var params = {
  AutoScalingGroupName: "my-auto-scaling-group", 
  ScheduledActionName: "my-scheduled-action"
 };
 autoscaling.deleteScheduledAction(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

var params = {
  AutoScalingGroupName: 'STRING_VALUE', /* required */
  ScheduledActionName: 'STRING_VALUE' /* required */
};
autoscaling.deleteScheduledAction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AutoScalingGroupName — (String)

    The name of the Auto Scaling group.

  • ScheduledActionName — (String)

    The name of the action to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example deletes the specified tag from the specified Auto Scaling group. */

 var params = {
  Tags: [
     {
    Key: "Dept", 
    ResourceId: "my-auto-scaling-group", 
    ResourceType: "auto-scaling-group", 
    Value: "Research"
   }
  ]
 };
 autoscaling.deleteTags(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

var params = {
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      PropagateAtLaunch: true || false,
      ResourceId: 'STRING_VALUE',
      ResourceType: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
autoscaling.deleteTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Tags — (Array<map>)

    One or more tags.

    • ResourceId — (String)

      The name of the Auto Scaling group.

    • ResourceType — (String)

      The type of resource. The only supported value is auto-scaling-group.

    • Key — required — (String)

      The tag key.

    • Value — (String)

      The tag value.

    • PropagateAtLaunch — (Boolean)

      Determines whether the tag is added to new instances as they are launched in the group.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AutoScalingGroupName: 'STRING_VALUE', /* required */
  ForceDelete: true || false
};
autoscaling.deleteWarmPool(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AutoScalingGroupName — (String)

    The name of the Auto Scaling group.

  • ForceDelete — (Boolean)

    Specifies that the warm pool is to be deleted along with all of its associated instances, without waiting for all instances to be terminated. This parameter also deletes any outstanding lifecycle actions associated with the warm pool instances.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example describes the Amazon EC2 Auto Scaling service quotas for your account. */

 var params = {};
 autoscaling.describeAccountLimits(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    MaxNumberOfAutoScalingGroups: 20, 
    MaxNumberOfLaunchConfigurations: 100, 
    NumberOfAutoScalingGroups: 3, 
    NumberOfLaunchConfigurations: 5
   }
   */
 });

autoscaling.describeAccountLimits(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {})

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • MaxNumberOfAutoScalingGroups — (Integer)

      The maximum number of groups allowed for your account. The default is 200 groups per Region.

    • MaxNumberOfLaunchConfigurations — (Integer)

      The maximum number of launch configurations allowed for your account. The default is 200 launch configurations per Region.

    • NumberOfAutoScalingGroups — (Integer)

      The current number of groups for your account.

    • NumberOfLaunchConfigurations — (Integer)

      The current number of launch configurations for your account.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example describes the available adjustment types. */

 var params = {};
 autoscaling.describeAdjustmentTypes(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AdjustmentTypes: [
       {
      AdjustmentType: "ChangeInCapacity"
     }, 
       {
      AdjustmentType: "ExactCapcity"
     }, 
       {
      AdjustmentType: "PercentChangeInCapacity"
     }
    ]
   }
   */
 });

autoscaling.describeAdjustmentTypes(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {})

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AdjustmentTypes — (Array<map>)

      The policy adjustment types.

      • AdjustmentType — (String)

        The policy adjustment type. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example describes the specified Auto Scaling group. */

 var params = {
  AutoScalingGroupNames: [
     "my-auto-scaling-group"
  ]
 };
 autoscaling.describeAutoScalingGroups(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AutoScalingGroups: [
       {
      AutoScalingGroupARN: "arn:aws:autoscaling:us-west-1:123456789012:autoScalingGroup:12345678-1234-1234-1234-123456789012:autoScalingGroupName/my-auto-scaling-group", 
      AutoScalingGroupName: "my-auto-scaling-group", 
      AvailabilityZones: [
         "us-west-2a", 
         "us-west-2b", 
         "us-west-2c"
      ], 
      CreatedTime: <Date Representation>, 
      DefaultCooldown: 300, 
      DesiredCapacity: 2, 
      EnabledMetrics: [
      ], 
      HealthCheckGracePeriod: 300, 
      HealthCheckType: "EC2", 
      Instances: [
         {
        AvailabilityZone: "us-west-2c", 
        HealthStatus: "Healthy", 
        InstanceId: "i-05b4f7d5be44822a6", 
        InstanceType: "t3.micro", 
        LaunchConfigurationName: "my-launch-config", 
        LifecycleState: "InService", 
        ProtectedFromScaleIn: false
       }, 
         {
        AvailabilityZone: "us-west-2b", 
        HealthStatus: "Healthy", 
        InstanceId: "i-0c20ac468fa3049e8", 
        InstanceType: "t3.micro", 
        LaunchConfigurationName: "my-launch-config", 
        LifecycleState: "InService", 
        ProtectedFromScaleIn: false
       }
      ], 
      LaunchConfigurationName: "my-launch-config", 
      LoadBalancerNames: [
      ], 
      MaxSize: 5, 
      MinSize: 1, 
      NewInstancesProtectedFromScaleIn: false, 
      ServiceLinkedRoleARN: "arn:aws:iam::123456789012:role/aws-service-role/autoscaling.amazonaws.com/AWSServiceRoleForAutoScaling", 
      SuspendedProcesses: [
      ], 
      Tags: [
      ], 
      TargetGroupARNs: [
      ], 
      TerminationPolicies: [
         "Default"
      ], 
      TrafficSources: [
      ], 
      VPCZoneIdentifier: "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782"
     }
    ]
   }
   */
 });

var params = {
  AutoScalingGroupNames: [
    'STRING_VALUE',
    /* more items */
  ],
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxRecords: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
autoscaling.describeAutoScalingGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AutoScalingGroupNames — (Array<String>)

    The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords property.

    If you omit this property, all Auto Scaling groups are described.

  • NextToken — (String)

    The token for the next set of items to return. (You received this token from a previous call.)

  • MaxRecords — (Integer)

    The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

  • Filters — (Array<map>)

    One or more filters to limit the results based on specific tags.

    • Name — (String)

      The name of the filter.

      The valid values for Name depend on which API operation you're using with the filter (DescribeAutoScalingGroups or DescribeTags).

      DescribeAutoScalingGroups

      Valid values for Name include the following:

      • tag-key - Accepts tag keys. The results only include information about the Auto Scaling groups associated with these tag keys.

      • tag-value - Accepts tag values. The results only include information about the Auto Scaling groups associated with these tag values.

      • tag:<key> - Accepts the key/value combination of the tag. Use the tag key in the filter name and the tag value as the filter value. The results only include information about the Auto Scaling groups associated with the specified key/value combination.

      DescribeTags

      Valid values for Name include the following:

      • auto-scaling-group - Accepts the names of Auto Scaling groups. The results only include information about the tags associated with these Auto Scaling groups.

      • key - Accepts tag keys. The results only include information about the tags associated with these tag keys.

      • value - Accepts tag values. The results only include information about the tags associated with these tag values.

      • propagate-at-launch - Accepts a Boolean value, which specifies whether tags propagate to instances at launch. The results only include information about the tags associated with the specified Boolean value.

    • Values — (Array<String>)

      One or more filter values. Filter values are case-sensitive.

      If you specify multiple values for a filter, the values are automatically logically joined with an OR, and the request returns all results that match any of the specified values. For example, specify "tag:environment" for the filter name and "production,development" for the filter values to find Auto Scaling groups with the tag "environment=production" or "environment=development".

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AutoScalingGroups — (Array<map>)

      The groups.

      • AutoScalingGroupName — required — (String)

        The name of the Auto Scaling group.

      • AutoScalingGroupARN — (String)

        The Amazon Resource Name (ARN) of the Auto Scaling group.

      • LaunchConfigurationName — (String)

        The name of the associated launch configuration.

      • LaunchTemplate — (map)

        The launch template for the group.

        • LaunchTemplateId — (String)

          The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

          Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

        • LaunchTemplateName — (String)

          The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

          Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

        • Version — (String)

          The version number, $Latest, or $Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.

      • MixedInstancesPolicy — (map)

        The mixed instances policy for the group.

        • LaunchTemplate — (map)

          One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities.

          • LaunchTemplateSpecification — (map)

            The launch template.

            • LaunchTemplateId — (String)

              The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

              Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

            • LaunchTemplateName — (String)

              The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

              Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

            • Version — (String)

              The version number, $Latest, or $Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.

          • Overrides — (Array<map>)

            Any properties that you specify override the same properties in the launch template.

            • InstanceType — (String)

              The instance type, such as m3.xlarge. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see Instance types in the Amazon EC2 User Guide for Linux Instances.

              You can specify up to 40 instance types per Auto Scaling group.

            • WeightedCapacity — (String)

              If you provide a list of instance types to use, you can specify the number of capacity units provided by each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a WeightedCapacity of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see Configure an Auto Scaling group to use instance weights in the Amazon EC2 Auto Scaling User Guide. Value must be in the range of 1–999.

              If you specify a value for WeightedCapacity for one instance type, you must specify a value for WeightedCapacity for all of them.

              Every Auto Scaling group has three size parameters (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.

            • LaunchTemplateSpecification — (map)

              Provides a launch template for the specified instance type or set of instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in the LaunchTemplate definition. For more information, see Specifying a different launch template for an instance type in the Amazon EC2 Auto Scaling User Guide.

              You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the LaunchTemplate definition count towards this limit.

              • LaunchTemplateId — (String)

                The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

                Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

              • LaunchTemplateName — (String)

                The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

                Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

              • Version — (String)

                The version number, $Latest, or $Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.

            • InstanceRequirements — (map)

              The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.

              You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template.

              Note: If you specify InstanceRequirements, you can't specify InstanceType.
              • VCpuCount — required — (map)

                The minimum and maximum number of vCPUs for an instance type.

                • Min — required — (Integer)

                  The minimum number of vCPUs.

                • Max — (Integer)

                  The maximum number of vCPUs.

              • MemoryMiB — required — (map)

                The minimum and maximum instance memory size for an instance type, in MiB.

                • Min — required — (Integer)

                  The memory minimum in MiB.

                • Max — (Integer)

                  The memory maximum in MiB.

              • CpuManufacturers — (Array<String>)

                Lists which specific CPU manufacturers to include.

                • For instance types with Intel CPUs, specify intel.

                • For instance types with AMD CPUs, specify amd.

                • For instance types with Amazon Web Services CPUs, specify amazon-web-services.

                Note: Don't confuse the CPU hardware manufacturer with the CPU hardware architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.

                Default: Any manufacturer

              • MemoryGiBPerVCpu — (map)

                The minimum and maximum amount of memory per vCPU for an instance type, in GiB.

                Default: No minimum or maximum limits

                • Min — (Float)

                  The memory minimum in GiB.

                • Max — (Float)

                  The memory maximum in GiB.

              • ExcludedInstanceTypes — (Array<String>)

                The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (*), to exclude an instance family, type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.

                For example, if you specify c5*, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types.

                Note: If you specify ExcludedInstanceTypes, you can't specify AllowedInstanceTypes.

                Default: No excluded instance types

              • InstanceGenerations — (Array<String>)

                Indicates whether current or previous generation instance types are included.

                • For current generation instance types, specify current. The current generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide for Linux Instances.

                • For previous generation instance types, specify previous.

                Default: Any current or previous generation

              • SpotMaxPricePercentageOverLowestPrice — (Integer)

                [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.

                The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

                If you set DesiredCapacityType to vcpu or memory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price.

                Note: Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
              • MaxSpotPriceAsPercentageOfOptimalOnDemandPrice — (Integer)

                [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.

                The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

                If you set DesiredCapacityType to vcpu or memory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price.

                Note: Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
              • OnDemandMaxPricePercentageOverLowestPrice — (Integer)

                [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.

                The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

                To turn off price protection, specify a high value, such as 999999.

                If you set DesiredCapacityType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price.

                Default: 20

              • BareMetal — (String)

                Indicates whether bare metal instance types are included, excluded, or required.

                Default: excluded

                Possible values include:
                • "included"
                • "excluded"
                • "required"
              • BurstablePerformance — (String)

                Indicates whether burstable performance instance types are included, excluded, or required. For more information, see Burstable performance instances in the Amazon EC2 User Guide for Linux Instances.

                Default: excluded

                Possible values include:
                • "included"
                • "excluded"
                • "required"
              • RequireHibernateSupport — (Boolean)

                Indicates whether instance types must provide On-Demand Instance hibernation support.

                Default: false

              • NetworkInterfaceCount — (map)

                The minimum and maximum number of network interfaces for an instance type.

                Default: No minimum or maximum limits

                • Min — (Integer)

                  The minimum number of network interfaces.

                • Max — (Integer)

                  The maximum number of network interfaces.

              • LocalStorage — (String)

                Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide for Linux Instances.

                Default: included

                Possible values include:
                • "included"
                • "excluded"
                • "required"
              • LocalStorageTypes — (Array<String>)

                Indicates the type of local storage that is required.

                • For instance types with hard disk drive (HDD) storage, specify hdd.

                • For instance types with solid state drive (SSD) storage, specify ssd.

                Default: Any local storage type

              • TotalLocalStorageGB — (map)

                The minimum and maximum total local storage size for an instance type, in GB.

                Default: No minimum or maximum limits

                • Min — (Float)

                  The storage minimum in GB.

                • Max — (Float)

                  The storage maximum in GB.

              • BaselineEbsBandwidthMbps — (map)

                The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide for Linux Instances.

                Default: No minimum or maximum limits

                • Min — (Integer)

                  The minimum value in Mbps.

                • Max — (Integer)

                  The maximum value in Mbps.

              • AcceleratorTypes — (Array<String>)

                Lists the accelerator types that must be on an instance type.

                • For instance types with GPU accelerators, specify gpu.

                • For instance types with FPGA accelerators, specify fpga.

                • For instance types with inference accelerators, specify inference.

                Default: Any accelerator type

              • AcceleratorCount — (map)

                The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) for an instance type.

                To exclude accelerator-enabled instance types, set Max to 0.

                Default: No minimum or maximum limits

                • Min — (Integer)

                  The minimum value.

                • Max — (Integer)

                  The maximum value.

              • AcceleratorManufacturers — (Array<String>)

                Indicates whether instance types must have accelerators by specific manufacturers.

                • For instance types with NVIDIA devices, specify nvidia.

                • For instance types with AMD devices, specify amd.

                • For instance types with Amazon Web Services devices, specify amazon-web-services.

                • For instance types with Xilinx devices, specify xilinx.

                Default: Any manufacturer

              • AcceleratorNames — (Array<String>)

                Lists the accelerators that must be on an instance type.

                • For instance types with NVIDIA A100 GPUs, specify a100.

                • For instance types with NVIDIA V100 GPUs, specify v100.

                • For instance types with NVIDIA K80 GPUs, specify k80.

                • For instance types with NVIDIA T4 GPUs, specify t4.

                • For instance types with NVIDIA M60 GPUs, specify m60.

                • For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.

                • For instance types with Xilinx VU9P FPGAs, specify vu9p.

                Default: Any accelerator

              • AcceleratorTotalMemoryMiB — (map)

                The minimum and maximum total memory size for the accelerators on an instance type, in MiB.

                Default: No minimum or maximum limits

                • Min — (Integer)

                  The memory minimum in MiB.

                • Max — (Integer)

                  The memory maximum in MiB.

              • NetworkBandwidthGbps — (map)

                The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).

                Default: No minimum or maximum limits

                • Min — (Float)

                  The minimum amount of network bandwidth, in gigabits per second (Gbps).

                • Max — (Float)

                  The maximum amount of network bandwidth, in gigabits per second (Gbps).

              • AllowedInstanceTypes — (Array<String>)

                The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.

                You can use strings with one or more wild cards, represented by an asterisk (*), to allow an instance type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.

                For example, if you specify c5*, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types.

                Note: If you specify AllowedInstanceTypes, you can't specify ExcludedInstanceTypes.

                Default: All instance types

        • InstancesDistribution — (map)

          The instances distribution.

          • OnDemandAllocationStrategy — (String)

            The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.

            The following lists the valid values:

            lowest-price

            Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements.

            prioritized

            You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do.

          • OnDemandBaseCapacity — (Integer)

            The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales.

            This number has the same unit of measurement as the group's desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement.

            Default: 0

          • OnDemandPercentageAboveBaseCapacity — (Integer)

            Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used.

            Default: 100

          • SpotAllocationStrategy — (String)

            The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.

            The following lists the valid values:

            capacity-optimized

            Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized.

            capacity-optimized-prioritized

            You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements.

            lowest-price

            Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the SpotInstancePools property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity.

            price-capacity-optimized (recommended)

            The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price.

          • SpotInstancePools — (Integer)

            The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the SpotAllocationStrategy is lowest-price. Value must be in the range of 1–20.

            Default: 2

          • SpotMaxPrice — (String)

            The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string ("") for the value.

            If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one.

            Valid Range: Minimum value of 0.001

      • MinSize — required — (Integer)

        The minimum size of the group.

      • MaxSize — required — (Integer)

        The maximum size of the group.

      • DesiredCapacity — required — (Integer)

        The desired size of the group.

      • PredictedCapacity — (Integer)

        The predicted capacity of the group when it has a predictive scaling policy.

      • DefaultCooldown — required — (Integer)

        The duration of the default cooldown period, in seconds.

      • AvailabilityZones — required — (Array<String>)

        One or more Availability Zones for the group.

      • LoadBalancerNames — (Array<String>)

        One or more load balancers associated with the group.

      • TargetGroupARNs — (Array<String>)

        The Amazon Resource Names (ARN) of the target groups for your load balancer.

      • HealthCheckType — required — (String)

        A comma-separated value string of one or more health check types.

      • HealthCheckGracePeriod — (Integer)

        The duration of the health check grace period, in seconds.

      • Instances — (Array<map>)

        The EC2 instances associated with the group.

        • InstanceId — required — (String)

          The ID of the instance.

        • InstanceType — (String)

          The instance type of the EC2 instance.

        • AvailabilityZone — required — (String)

          The Availability Zone in which the instance is running.

        • LifecycleState — required — (String)

          A description of the current lifecycle state. The Quarantined state is not used. For more information, see Amazon EC2 Auto Scaling instance lifecycle in the Amazon EC2 Auto Scaling User Guide.

          Possible values include:
          • "Pending"
          • "Pending:Wait"
          • "Pending:Proceed"
          • "Quarantined"
          • "InService"
          • "Terminating"
          • "Terminating:Wait"
          • "Terminating:Proceed"
          • "Terminated"
          • "Detaching"
          • "Detached"
          • "EnteringStandby"
          • "Standby"
          • "Warmed:Pending"
          • "Warmed:Pending:Wait"
          • "Warmed:Pending:Proceed"
          • "Warmed:Terminating"
          • "Warmed:Terminating:Wait"
          • "Warmed:Terminating:Proceed"
          • "Warmed:Terminated"
          • "Warmed:Stopped"
          • "Warmed:Running"
          • "Warmed:Hibernated"
        • HealthStatus — required — (String)

          The last reported health status of the instance. Healthy means that the instance is healthy and should remain in service. Unhealthy means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.

        • LaunchConfigurationName — (String)

          The launch configuration associated with the instance.

        • LaunchTemplate — (map)

          The launch template for the instance.

          • LaunchTemplateId — (String)

            The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

            Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

          • LaunchTemplateName — (String)

            The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

            Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

          • Version — (String)

            The version number, $Latest, or $Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.

        • ProtectedFromScaleIn — required — (Boolean)

          Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

        • WeightedCapacity — (String)

          The number of capacity units contributed by the instance based on its instance type.

          Valid Range: Minimum value of 1. Maximum value of 999.

      • CreatedTime — required — (Date)

        The date and time the group was created.

      • SuspendedProcesses — (Array<map>)

        The suspended processes associated with the group.

        • ProcessName — (String)

          The name of the suspended process.

        • SuspensionReason — (String)

          The reason that the process was suspended.

      • PlacementGroup — (String)

        The name of the placement group into which to launch your instances, if any.

      • VPCZoneIdentifier — (String)

        One or more subnet IDs, if applicable, separated by commas.

      • EnabledMetrics — (Array<map>)

        The metrics enabled for the group.

        • Metric — (String)

          One of the following metrics:

          • GroupMinSize

          • GroupMaxSize

          • GroupDesiredCapacity

          • GroupInServiceInstances

          • GroupPendingInstances

          • GroupStandbyInstances

          • GroupTerminatingInstances

          • GroupTotalInstances

          • GroupInServiceCapacity

          • GroupPendingCapacity

          • GroupStandbyCapacity

          • GroupTerminatingCapacity

          • GroupTotalCapacity

          • WarmPoolDesiredCapacity

          • WarmPoolWarmedCapacity

          • WarmPoolPendingCapacity

          • WarmPoolTerminatingCapacity

          • WarmPoolTotalCapacity

          • GroupAndWarmPoolDesiredCapacity

          • GroupAndWarmPoolTotalCapacity

          For more information, see Amazon CloudWatch metrics for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

        • Granularity — (String)

          The granularity of the metric. The only valid value is 1Minute.

      • Status — (String)

        The current state of the group when the DeleteAutoScalingGroup operation is in progress.

      • Tags — (Array<map>)

        The tags for the group.

        • ResourceId — (String)

          The name of the group.

        • ResourceType — (String)

          The type of resource. The only supported value is auto-scaling-group.

        • Key — (String)

          The tag key.

        • Value — (String)

          The tag value.

        • PropagateAtLaunch — (Boolean)

          Determines whether the tag is added to new instances as they are launched in the group.

      • TerminationPolicies — (Array<String>)

        The termination policies for the group.

      • NewInstancesProtectedFromScaleIn — (Boolean)

        Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

      • ServiceLinkedRoleARN — (String)

        The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf.

      • MaxInstanceLifetime — (Integer)

        The maximum amount of time, in seconds, that an instance can be in service.

        Valid Range: Minimum value of 0.

      • CapacityRebalance — (Boolean)

        Indicates whether Capacity Rebalancing is enabled.

      • WarmPoolConfiguration — (map)

        The warm pool for the group.

        • MaxGroupPreparedCapacity — (Integer)

          The maximum number of instances that are allowed to be in the warm pool or in any state except Terminated for the Auto Scaling group.

        • MinSize — (Integer)

          The minimum number of instances to maintain in the warm pool.

        • PoolState — (String)

          The instance state to transition to after the lifecycle actions are complete.

          Possible values include:
          • "Stopped"
          • "Running"
          • "Hibernated"
        • Status — (String)

          The status of a warm pool that is marked for deletion.

          Possible values include:
          • "PendingDelete"
        • InstanceReusePolicy — (map)

          The instance reuse policy.

          • ReuseOnScaleIn — (Boolean)

            Specifies whether instances in the Auto Scaling group can be returned to the warm pool on scale in.

      • WarmPoolSize — (Integer)

        The current size of the warm pool.

      • Context — (String)

        Reserved.

      • DesiredCapacityType — (String)

        The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only.

      • DefaultInstanceWarmup — (Integer)

        The duration of the default instance warmup, in seconds.

      • TrafficSources — (Array<map>)

        The traffic sources associated with this Auto Scaling group.

        • Identifier — required — (String)

          Identifies the traffic source.

          For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the Amazon Resource Name (ARN) for a target group in this account and Region. For Classic Load Balancers, this will be the name of the Classic Load Balancer in this account and Region.

          For example:

          • Application Load Balancer ARN: arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456

          • Classic Load Balancer name: my-classic-load-balancer

          • VPC Lattice ARN: arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456

          To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer, or the name of a Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations.

          To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API operation.

        • Type — (String)

          Provides additional context for the value of Identifier.

          The following lists the valid values:

          • elb if Identifier is the name of a Classic Load Balancer.

          • elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load Balancer, or Network Load Balancer target group.

          • vpc-lattice if Identifier is the ARN of a VPC Lattice target group.

          Required if the identifier is the name of a Classic Load Balancer.

      • InstanceMaintenancePolicy — (map)

        An instance maintenance policy.

        • MinHealthyPercentage — (Integer)

          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. To clear a previously set value, specify a value of -1.

        • MaxHealthyPercentage — (Integer)

          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 100 to 200. To clear a previously set value, specify a value of -1.

          Both MinHealthyPercentage and MaxHealthyPercentage 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.

    • NextToken — (String)

      A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example describes the specified Auto Scaling instance. */

 var params = {
  InstanceIds: [
     "i-05b4f7d5be44822a6"
  ]
 };
 autoscaling.describeAutoScalingInstances(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AutoScalingInstances: [
       {
      AutoScalingGroupName: "my-auto-scaling-group", 
      AvailabilityZone: "us-west-2c", 
      HealthStatus: "HEALTHY", 
      InstanceId: "i-05b4f7d5be44822a6", 
      InstanceType: "t3.micro", 
      LaunchConfigurationName: "my-launch-config", 
      LifecycleState: "InService", 
      ProtectedFromScaleIn: false
     }
    ]
   }
   */
 });

var params = {
  InstanceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxRecords: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
autoscaling.describeAutoScalingInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceIds — (Array<String>)

    The IDs of the instances. If you omit this property, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.

    Array Members: Maximum number of 50 items.

  • MaxRecords — (Integer)

    The maximum number of items to return with this call. The default value is 50 and the maximum value is 50.

  • NextToken — (String)

    The token for the next set of items to return. (You received this token from a previous call.)

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AutoScalingInstances — (Array<map>)

      The instances.

      • InstanceId — required — (String)

        The ID of the instance.

      • InstanceType — (String)

        The instance type of the EC2 instance.

      • AutoScalingGroupName — required — (String)

        The name of the Auto Scaling group for the instance.

      • AvailabilityZone — required — (String)

        The Availability Zone for the instance.

      • LifecycleState — required — (String)

        The lifecycle state for the instance. The Quarantined state is not used. For more information, see Amazon EC2 Auto Scaling instance lifecycle in the Amazon EC2 Auto Scaling User Guide.

        Valid values: Pending | Pending:Wait | Pending:Proceed | Quarantined | InService | Terminating | Terminating:Wait | Terminating:Proceed | Terminated | Detaching | Detached | EnteringStandby | Standby | Warmed:Pending | Warmed:Pending:Wait | Warmed:Pending:Proceed | Warmed:Terminating | Warmed:Terminating:Wait | Warmed:Terminating:Proceed | Warmed:Terminated | Warmed:Stopped | Warmed:Running

      • HealthStatus — required — (String)

        The last reported health status of this instance. Healthy means that the instance is healthy and should remain in service. Unhealthy means that the instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.

      • LaunchConfigurationName — (String)

        The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.

      • LaunchTemplate — (map)

        The launch template for the instance.

        • LaunchTemplateId — (String)

          The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

          Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

        • LaunchTemplateName — (String)

          The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

          Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

        • Version — (String)

          The version number, $Latest, or $Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.

      • ProtectedFromScaleIn — required — (Boolean)

        Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

      • WeightedCapacity — (String)

        The number of capacity units contributed by the instance based on its instance type.

        Valid Range: Minimum value of 1. Maximum value of 999.

    • NextToken — (String)

      A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example describes the available notification types. */

 var params = {};
 autoscaling.describeAutoScalingNotificationTypes(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AutoScalingNotificationTypes: [
       "autoscaling:EC2_INSTANCE_LAUNCH", 
       "autoscaling:EC2_INSTANCE_LAUNCH_ERROR", 
       "autoscaling:EC2_INSTANCE_TERMINATE", 
       "autoscaling:EC2_INSTANCE_TERMINATE_ERROR", 
       "autoscaling:TEST_NOTIFICATION"
    ]
   }
   */
 });

autoscaling.describeAutoScalingNotificationTypes(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {})

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AutoScalingNotificationTypes — (Array<String>)

      The notification types.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example describes the instance refreshes for the specified Auto Scaling group. */

 var params = {
  AutoScalingGroupName: "my-auto-scaling-group"
 };
 autoscaling.describeInstanceRefreshes(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    InstanceRefreshes: [
       {
      AutoScalingGroupName: "my-auto-scaling-group", 
      InstanceRefreshId: "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b", 
      InstancesToUpdate: 0, 
      PercentageComplete: 50, 
      Preferences: {
       AlarmSpecification: {
        Alarms: [
           "my-alarm"
        ]
       }, 
       AutoRollback: true, 
       InstanceWarmup: 200, 
       MaxHealthyPercentage: 120, 
       MinHealthyPercentage: 90, 
       ScaleInProtectedInstances: "Ignore", 
       SkipMatching: false, 
       StandbyInstances: "Ignore"
      }, 
      StartTime: <Date Representation>, 
      Status: "InProgress", 
      StatusReason: "Waiting for instances to warm up before continuing. For example: i-0645704820a8e83ff is warming up."
     }, 
       {
      AutoScalingGroupName: "my-auto-scaling-group", 
      EndTime: <Date Representation>, 
      InstanceRefreshId: "0e151305-1e57-4a32-a256-1fd14157c5ec", 
      InstancesToUpdate: 0, 
      PercentageComplete: 100, 
      Preferences: {
       AlarmSpecification: {
        Alarms: [
           "my-alarm"
        ]
       }, 
       AutoRollback: true, 
       InstanceWarmup: 200, 
       MaxHealthyPercentage: 120, 
       MinHealthyPercentage: 90, 
       ScaleInProtectedInstances: "Ignore", 
       SkipMatching: false, 
       StandbyInstances: "Ignore"
      }, 
      StartTime: <Date Representation>, 
      Status: "Successful"
     }
    ]
   }
   */
 });

var params = {
  AutoScalingGroupName: 'STRING_VALUE', /* required */
  InstanceRefreshIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxRecords: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
autoscaling.describeInstanceRefreshes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AutoScalingGroupName — (String)

    The name of the Auto Scaling group.

  • InstanceRefreshIds — (Array<String>)

    One or more instance refresh IDs.

  • NextToken — (String)

    The token for the next set of items to return. (You received this token from a previous call.)

  • MaxRecords — (Integer)

    The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • InstanceRefreshes — (Array<map>)

      The instance refreshes for the specified group, sorted by creation timestamp in descending order.

      • InstanceRefreshId — (String)

        The instance refresh ID.

      • AutoScalingGroupName — (String)

        The name of the Auto Scaling group.

      • Status — (String)

        The current status for the instance refresh operation:

        • Pending - The request was created, but the instance refresh has not started.

        • InProgress - An instance refresh is in progress.

        • Successful - An instance refresh completed successfully.

        • Failed - An instance refresh failed to complete. You can troubleshoot using the status reason and the scaling activities.

        • Cancelling - An ongoing instance refresh is being cancelled.

        • Cancelled - The instance refresh is cancelled.

        • RollbackInProgress - An instance refresh is being rolled back.

        • RollbackFailed - The rollback failed to complete. You can troubleshoot using the status reason and the scaling activities.

        • RollbackSuccessful - The rollback completed successfully.

        Possible values include:
        • "Pending"
        • "InProgress"
        • "Successful"
        • "Failed"
        • "Cancelling"
        • "Cancelled"
        • "RollbackInProgress"
        • "RollbackFailed"
        • "RollbackSuccessful"
      • StatusReason — (String)

        The explanation for the specific status assigned to this operation.

      • StartTime — (Date)

        The date and time at which the instance refresh began.

      • EndTime — (Date)

        The date and time at which the instance refresh ended.

      • PercentageComplete — (Integer)

        The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.

        Note: PercentageComplete does not include instances that are replaced during a rollback. This value gradually goes back down to zero during a rollback.
      • InstancesToUpdate — (Integer)

        The number of instances remaining to update before the instance refresh is complete.

        Note: If you roll back the instance refresh, InstancesToUpdate shows you the number of instances that were not yet updated by the instance refresh. Therefore, these instances don't need to be replaced as part of the rollback.
      • ProgressDetails — (map)

        Additional progress details for an Auto Scaling group that has a warm pool.

        • LivePoolProgress — (map)

          Reports progress on replacing instances that are in the Auto Scaling group.

          • PercentageComplete — (Integer)

            The percentage of instances in the Auto Scaling group that have been replaced. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.

          • InstancesToUpdate — (Integer)

            The number of instances remaining to update.

        • WarmPoolProgress — (map)

          Reports progress on replacing instances that are in the warm pool.

          • PercentageComplete — (Integer)

            The percentage of instances in the warm pool that have been replaced. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.

          • InstancesToUpdate — (Integer)

            The number of instances remaining to update.

      • Preferences — (map)

        The preferences for an instance refresh.

        • MinHealthyPercentage — (Integer)

          Specifies the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload to allow the operation to continue. The value is expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 0 to 100.

          If you do not specify this property, the default is 90 percent, or the percentage set in the instance maintenance policy for the Auto Scaling group, if defined.

        • InstanceWarmup — (Integer)

          A time period, in seconds, during which an instance refresh waits before moving on to replacing the next instance after a new instance enters the InService state.

          This property is not required for normal usage. Instead, use the DefaultInstanceWarmup property of the Auto Scaling group. The InstanceWarmup and DefaultInstanceWarmup properties work the same way. Only specify this property if you must override the DefaultInstanceWarmup property.

          If you do not specify this property, the instance warmup by default is the value of the DefaultInstanceWarmup property, if defined (which is recommended in all cases), or the HealthCheckGracePeriod property otherwise.

        • CheckpointPercentages — (Array<Integer>)

          (Optional) Threshold values for each checkpoint in ascending order. Each number must be unique. To replace all instances in the Auto Scaling group, the last number in the array must be 100.

          For usage examples, see Add checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.

        • CheckpointDelay — (Integer)

          (Optional) The amount of time, in seconds, to wait after a checkpoint before continuing. This property is optional, but if you specify a value for it, you must also specify a value for CheckpointPercentages. If you specify a value for CheckpointPercentages and not for CheckpointDelay, the CheckpointDelay defaults to 3600 (1 hour).

        • SkipMatching — (Boolean)

          (Optional) Indicates whether skip matching is enabled. If enabled (true), then Amazon EC2 Auto Scaling skips replacing instances that match the desired configuration. If no desired configuration is specified, then it skips replacing instances that have the same launch template and instance types that the Auto Scaling group was using before the start of the instance refresh. The default is false.

          For more information, see Use an instance refresh with skip matching in the Amazon EC2 Auto Scaling User Guide.

        • AutoRollback — (Boolean)

          (Optional) Indicates whether to roll back the Auto Scaling group to its previous configuration if the instance refresh fails or a CloudWatch alarm threshold is met. The default is false.

          A rollback is not supported in the following situations:

          • There is no desired configuration specified for the instance refresh.

          • The Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager parameter instead of an AMI ID for the ImageId property.

          • The Auto Scaling group uses the launch template's $Latest or $Default version.

          For more information, see Undo changes with a rollback in the Amazon EC2 Auto Scaling User Guide.

        • ScaleInProtectedInstances — (String)

          Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances protected from scale in are found.

          The following lists the valid values:

          Refresh

          Amazon EC2 Auto Scaling replaces instances that are protected from scale in.

          Ignore

          Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues to replace instances that are not protected.

          Wait (default)

          Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise, the instance refresh will fail.

          Possible values include:
          • "Refresh"
          • "Ignore"
          • "Wait"
        • StandbyInstances — (String)

          Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances in Standby state are found.

          The following lists the valid values:

          Terminate

          Amazon EC2 Auto Scaling terminates instances that are in Standby.

          Ignore

          Amazon EC2 Auto Scaling ignores instances that are in Standby and continues to replace instances that are in the InService state.

          Wait (default)

          Amazon EC2 Auto Scaling waits one hour for you to return the instances to service. Otherwise, the instance refresh will fail.

          Possible values include:
          • "Terminate"
          • "Ignore"
          • "Wait"
        • AlarmSpecification — (map)

          (Optional) The CloudWatch alarm specification. CloudWatch alarms can be used to identify any issues and fail the operation if an alarm threshold is met.

          • Alarms — (Array<String>)

            The names of one or more CloudWatch alarms to monitor for the instance refresh. You can specify up to 10 alarms.

        • MaxHealthyPercentage — (Integer)

          Specifies the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. The value is expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 100 to 200.

          If you specify MaxHealthyPercentage, you must also specify MinHealthyPercentage, and the difference between them cannot be greater than 100. A larger range increases the number of instances that can be replaced at the same time.

          If you do not specify this property, the default is 100 percent, or the percentage set in the instance maintenance policy for the Auto Scaling group, if defined.

      • DesiredConfiguration — (map)

        Describes the desired configuration for the instance refresh.

        • LaunchTemplate — (map)

          Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling uses to launch Amazon EC2 instances. For more information about launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.

          • LaunchTemplateId — (String)

            The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

            Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

          • LaunchTemplateName — (String)

            The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

            Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

          • Version — (String)

            The version number, $Latest, or $Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.

        • MixedInstancesPolicy — (map)

          Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group.

          A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.

          • LaunchTemplate — (map)

            One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities.

            • LaunchTemplateSpecification — (map)

              The launch template.

              • LaunchTemplateId — (String)

                The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

                Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

              • LaunchTemplateName — (String)

                The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

                Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

              • Version — (String)

                The version number, $Latest, or $Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.

            • Overrides — (Array<map>)

              Any properties that you specify override the same properties in the launch template.

              • InstanceType — (String)

                The instance type, such as m3.xlarge. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see Instance types in the Amazon EC2 User Guide for Linux Instances.

                You can specify up to 40 instance types per Auto Scaling group.

              • WeightedCapacity — (String)

                If you provide a list of instance types to use, you can specify the number of capacity units provided by each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a WeightedCapacity of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see Configure an Auto Scaling group to use instance weights in the Amazon EC2 Auto Scaling User Guide. Value must be in the range of 1–999.

                If you specify a value for WeightedCapacity for one instance type, you must specify a value for WeightedCapacity for all of them.

                Every Auto Scaling group has three size parameters (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.

              • LaunchTemplateSpecification — (map)

                Provides a launch template for the specified instance type or set of instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in the LaunchTemplate definition. For more information, see Specifying a different launch template for an instance type in the Amazon EC2 Auto Scaling User Guide.

                You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the LaunchTemplate definition count towards this limit.

                • LaunchTemplateId — (String)

                  The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

                  Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

                • LaunchTemplateName — (String)

                  The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.

                  Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.

                • Version — (String)

                  The version number, $Latest, or $Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.

              • InstanceRequirements — (map)

                The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.

                You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template.

                Note: If you specify InstanceRequirements, you can't specify InstanceType.
                • VCpuCount — required — (map)

                  The minimum and maximum number of vCPUs for an instance type.

                  • Min — required — (Integer)

                    The minimum number of vCPUs.

                  • Max — (Integer)

                    The maximum number of vCPUs.

                • MemoryMiB — required — (map)

                  The minimum and maximum instance memory size for an instance type, in MiB.

                  • Min — required — (Integer)

                    The memory minimum in MiB.

                  • Max — (Integer)

                    The memory maximum in MiB.

                • CpuManufacturers — (Array<String>)

                  Lists which specific CPU manufacturers to include.

                  • For instance types with Intel CPUs, specify intel.

                  • For instance types with AMD CPUs, specify amd.

                  • For instance types with Amazon Web Services CPUs, specify amazon-web-services.

                  Note: Don't confuse the CPU hardware manufacturer with the CPU hardware architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.

                  Default: Any manufacturer

                • MemoryGiBPerVCpu — (map)

                  The minimum and maximum amount of memory per vCPU for an instance type, in GiB.

                  Default: No minimum or maximum limits

                  • Min — (Float)

                    The memory minimum in GiB.

                  • Max — (Float)

                    The memory maximum in GiB.

                • ExcludedInstanceTypes — (Array<String>)

                  The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (*), to exclude an instance family, type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.

                  For example, if you specify c5*, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types.

                  Note: If you specify ExcludedInstanceTypes, you can't specify AllowedInstanceTypes.

                  Default: No excluded instance types

                • InstanceGenerations — (Array<String>)

                  Indicates whether current or previous generation instance types are included.

                  • For current generation instance types, specify current. The current generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide for Linux Instances.

                  • For previous generation instance types, specify previous.

                  Default: Any current or previous generation

                • SpotMaxPricePercentageOverLowestPrice — (Integer)

                  [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.

                  The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

                  If you set DesiredCapacityType to vcpu or memory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price.

                  Note: Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
                • MaxSpotPriceAsPercentageOfOptimalOnDemandPrice — (Integer)

                  [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.

                  The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

                  If you set DesiredCapacityType to vcpu or memory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price.

                  Note: Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
                • OnDemandMaxPricePercentageOverLowestPrice — (Integer)

                  [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.

                  The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

                  To turn off price protection, specify a high value, such as 999999.

                  If you set DesiredCapacityType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price.

                  Default: 20

                • BareMetal — (String)

                  Indicates whether bare metal instance types are included, excluded, or required.

                  Default: excluded

                  Possible values include:
                  • "included"
                  • "excluded"
                  • "required"
                • BurstablePerformance — (String)

                  Indicates whether burstable performance instance types are included, excluded, or required. For more information, see Burstable performance instances in the Amazon EC2 User Guide for Linux Instances.

                  Default: excluded

                  Possible values include:
                  • "included"
                  • "excluded"
                  • "required"
                • RequireHibernateSupport — (Boolean)

                  Indicates whether instance types must provide On-Demand Instance hibernation support.

                  Default: false

                • NetworkInterfaceCount — (map)

                  The minimum and maximum number of network interfaces for an instance type.

                  Default: No minimum or maximum limits

                  • Min — (Integer)

                    The minimum number of network interfaces.

                  • Max — (Integer)

                    The maximum number of network interfaces.

                • LocalStorage — (String)

                  Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide for Linux Instances.

                  Default: included

                  Possible values include:
                  • "included"
                  • "excluded"
                  • "required"
                • LocalStorageTypes — (Array<String>)

                  Indicates the type of local storage that is required.

                  • For instance types with hard disk drive (HDD) storage, specify hdd.

                  • For instance types with solid state drive (SSD) storage, specify ssd.

                  Default: Any local storage type

                • TotalLocalStorageGB — (map)

                  The minimum and maximum total local storage size for an instance type, in GB.

                  Default: No minimum or maximum limits

                  • Min — (Float)

                    The storage minimum in GB.

                  • Max — (Float)

                    The storage maximum in GB.

                • BaselineEbsBandwidthMbps — (map)

                  The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide for Linux Instances.

                  Default: No minimum or maximum limits

                  • Min — (Integer)

                    The minimum value in Mbps.

                  • Max — (Integer)

                    The maximum value in Mbps.

                • AcceleratorTypes — (Array<String>)

                  Lists the accelerator types that must be on an instance type.

                  • For instance types with GPU accelerators, specify gpu.

                  • For instance types with FPGA accelerators, specify fpga.

                  • For instance types with inference accelerators, specify inference.

                  Default: Any accelerator type

                • AcceleratorCount — (map)

                  The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) for an instance type.

                  To exclude accelerator-enabled instance types, set Max to 0.

                  Default: No minimum or maximum limits

                  • Min — (Integer)

                    The minimum value.

                  • Max — (Integer)

                    The maximum value.

                • AcceleratorManufacturers — (Array<String>)

                  Indicates whether instance types must have accelerators by specific manufacturers.

                  • For instance types with NVIDIA devices, specify nvidia.

                  • For instance types with AMD devices, specify amd.

                  • For instance types with Amazon Web Services devices, specify amazon-web-services.

                  • For instance types with Xilinx devices, specify xilinx.

                  Default: Any manufacturer

                • AcceleratorNames — (Array<String>)

                  Lists the accelerators that must be on an instance type.

                  • For instance types with NVIDIA A100 GPUs, specify a100.

                  • For instance types with NVIDIA V100 GPUs, specify v100.

                  • For instance types with NVIDIA K80 GPUs, specify k80.

                  • For instance types with NVIDIA T4 GPUs, specify t4.

                  • For instance types with NVIDIA M60 GPUs, specify m60.

                  • For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.

                  • For instance types with Xilinx VU9P FPGAs, specify vu9p.

                  Default: Any accelerator

                • AcceleratorTotalMemoryMiB — (map)

                  The minimum and maximum total memory size for the accelerators on an instance type, in MiB.

                  Default: No minimum or maximum limits

                  • Min — (Integer)

                    The memory minimum in MiB.

                  • Max — (Integer)

                    The memory maximum in MiB.

                • NetworkBandwidthGbps — (map)

                  The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).

                  Default: No minimum or maximum limits

                  • Min — (Float)

                    The minimum amount of network bandwidth, in gigabits per second (Gbps).

                  • Max — (Float)

                    The maximum amount of network bandwidth, in gigabits per second (Gbps).

                • AllowedInstanceTypes — (Array<String>)

                  The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.

                  You can use strings with one or more wild cards, represented by an asterisk (*), to allow an instance type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.

                  For example, if you specify c5*, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types.

                  Note: If you specify AllowedInstanceTypes, you can't specify ExcludedInstanceTypes.

                  Default: All instance types

          • InstancesDistribution — (map)

            The instances distribution.

            • OnDemandAllocationStrategy — (String)

              The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.

              The following lists the valid values:

              lowest-price

              Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements.

              prioritized

              You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do.

            • OnDemandBaseCapacity — (Integer)

              The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales.

              This number has the same unit of measurement as the group's desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement.

              Default: 0

            • OnDemandPercentageAboveBaseCapacity — (Integer)

              Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used.

              Default: 100

            • SpotAllocationStrategy — (String)

              The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.

              The following lists the valid values:

              capacity-optimized

              Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized.

              capacity-optimized-prioritized

              You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements.

              lowest-price

              Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the SpotInstancePools property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity.

              price-capacity-optimized (recommended)

              The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price.

            • SpotInstancePools — (Integer)

              The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the SpotAllocationStrategy is lowest-price. Value must be in the range of 1–20.

              Default: 2

            • SpotMaxPrice — (String)

              The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string ("") for the value.

              If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one.

              Valid Range: Minimum value of 0.001

      • RollbackDetails — (map)

        The rollback details.

        • RollbackReason — (String)

          The reason for this instance refresh rollback (for example, whether a manual or automatic rollback was initiated).

        • RollbackStartTime — (Date)

          The date and time at which the rollback began.

        • PercentageCompleteOnRollback — (Integer)

          Indicates the value of PercentageComplete at the time the rollback started.

        • InstancesToUpdateOnRollback — (Integer)

          Indicates the value of InstancesToUpdate at the time the rollback started.

        • ProgressDetailsOnRollback — (map)

          Reports progress on replacing instances in an Auto Scaling group that has a warm pool. This includes separate details for instances in the warm pool and instances in the Auto Scaling group (the live pool).

          • LivePoolProgress — (map)

            Reports progress on replacing instances that are in the Auto Scaling group.

            • PercentageComplete — (Integer)

              The percentage of instances in the Auto Scaling group that have been replaced. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.

            • InstancesToUpdate — (Integer)

              The number of instances remaining to update.

          • WarmPoolProgress — (map)

            Reports progress on replacing instances that are in the warm pool.

            • PercentageComplete — (Integer)

              The percentage of instances in the warm pool that have been replaced. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.

            • InstancesToUpdate — (Integer)

              The number of instances remaining to update.

    • NextToken — (String)

      A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example describes the specified launch configuration. */

 var params = {
  LaunchConfigurationNames: [
     "my-launch-config"
  ]
 };
 autoscaling.describeLaunchConfigurations(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    LaunchConfigurations: [
       {
      AssociatePublicIpAddress: true, 
      BlockDeviceMappings: [
      ], 
      CreatedTime: <Date Representation>, 
      EbsOptimized: false, 
      ImageId: "ami-043a5034", 
      InstanceMonitoring: {
       Enabled: true
      }, 
      InstanceType: "t1.micro", 
      LaunchConfigurationARN: "arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config", 
      LaunchConfigurationName: "my-launch-config", 
      SecurityGroups: [
         "sg-67ef0308"
      ]
     }
    ]
   }
   */
 });

var params = {
  LaunchConfigurationNames: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxRecords: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
autoscaling.describeLaunchConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LaunchConfigurationNames — (Array<String>)

    The launch configuration names. If you omit this property, all launch configurations are described.

    Array Members: Maximum number of 50 items.

  • NextToken — (String)

    The token for the next set of items to return. (You received this token from a previous call.)

  • MaxRecords — (Integer)

    The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LaunchConfigurations — (Array<map>)

      The launch configurations.

      • LaunchConfigurationName — required — (String)

        The name of the launch configuration.

      • LaunchConfigurationARN — (String)

        The Amazon Resource Name (ARN) of the launch configuration.

      • ImageId — required — (String)

        The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see Find a Linux AMI in the Amazon EC2 User Guide for Linux Instances.

      • KeyName — (String)

        The name of the key pair.

        For more information, see Amazon EC2 key pairs and Amazon EC2 instances in the Amazon EC2 User Guide for Linux Instances.

      • SecurityGroups — (Array<String>)

        A list that contains the security groups to assign to the instances in the Auto Scaling group. For more information, see Control traffic to your Amazon Web Services resources using security groups in the Amazon Virtual Private Cloud User Guide.

      • ClassicLinkVPCId — (String)

        Available for backward compatibility.

      • ClassicLinkVPCSecurityGroups — (Array<String>)

        Available for backward compatibility.

      • UserData — (String)

        The user data to make available to the launched EC2 instances. For more information, see Instance metadata and user data (Linux) and Instance metadata and user data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.

      • InstanceType — required — (String)

        The instance type for the instances. For information about available instance types, see Available instance types in the Amazon EC2 User Guide for Linux Instances.

      • KernelId — (String)

        The ID of the kernel associated with the AMI.

      • RamdiskId — (String)

        The ID of the RAM disk associated with the AMI.

      • BlockDeviceMappings — (Array<map>)

        The block device mapping entries that define the block devices to attach to the instances at launch. By default, the block devices specified in the block device mapping for the AMI are used. For more information, see Block device mappings in the Amazon EC2 User Guide for Linux Instances.

        • VirtualName — (String)

          The name of the instance store volume (virtual device) to attach to an instance at launch. The name must be in the form ephemeralX where X is a number starting from zero (0), for example, ephemeral0.

        • DeviceName — required — (String)

          The device name assigned to the volume (for example, /dev/sdh or xvdh). For more information, see Device naming on Linux instances in the Amazon EC2 User Guide for Linux Instances.

          Note: To define a block device mapping, set the device name and exactly one of the following properties: Ebs, NoDevice, or VirtualName.
        • Ebs — (map)

          Information to attach an EBS volume to an instance at launch.

          • SnapshotId — (String)

            The snapshot ID of the volume to use.

            You must specify either a VolumeSize or a SnapshotId.

          • VolumeSize — (Integer)

            The volume size, in GiBs. The following are the supported volumes sizes for each volume type:

            • gp2 and gp3: 1-16,384

            • io1: 4-16,384

            • st1 and sc1: 125-16,384

            • standard: 1-1,024

            You must specify either a SnapshotId or a VolumeSize. If you specify both SnapshotId and VolumeSize, the volume size must be equal or greater than the size of the snapshot.

          • VolumeType — (String)

            The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.

            Valid values: standard | io1 | gp2 | st1 | sc1 | gp3

          • DeleteOnTermination — (Boolean)

            Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

          • Iops — (Integer)

            The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For gp3 and io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

            The following are the supported values for each volume type:

            • gp3: 3,000-16,000 IOPS

            • io1: 100-64,000 IOPS

            For io1 volumes, we guarantee 64,000 IOPS only for Instances built on the Amazon Web Services Nitro System. Other instance families guarantee performance up to 32,000 IOPS.

            Iops is supported when the volume type is gp3 or io1 and required only when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)

          • Encrypted — (Boolean)

            Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Requirements for Amazon EBS encryption in the Amazon EBS User Guide. If your AMI uses encrypted volumes, you can also only launch it on supported instance types.

            Note: If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using a launch configuration. If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was encrypted. For more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User Guide.
          • Throughput — (Integer)

            The throughput (MiBps) to provision for a gp3 volume.

        • NoDevice — (Boolean)

          Setting this value to true prevents a volume that is included in the block device mapping of the AMI from being mapped to the specified device name at launch.

          If NoDevice is true for the root device, instances might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.

      • InstanceMonitoring — (map)

        Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring.

        For more information, see Configure monitoring for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.

        • Enabled — (Boolean)

          If true, detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

      • SpotPrice — (String)

        The maximum hourly price 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 price. For more information, see Requesting Spot Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide.

      • IamInstanceProfile — (String)

        The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. For more information, see IAM role for applications that run on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.

      • CreatedTime — required — (Date)

        The creation date and time for the launch configuration.

      • EbsOptimized — (Boolean)

        Specifies whether the launch configuration is optimized for EBS I/O (true) or not (false). For more information, see Amazon EBS-optimized instances in the Amazon EC2 User Guide for Linux Instances.

      • AssociatePublicIpAddress — (Boolean)

        Specifies whether to assign a public IPv4 address to the group's instances. If the instance is launched into a default subnet, the default is to assign a public IPv4 address, unless you disabled the option to assign a public IPv4 address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IPv4 address, unless you enabled the option to assign a public IPv4 address on the subnet. For more information, see Provide network connectivity for your Auto Scaling instances using Amazon VPC in the Amazon EC2 Auto Scaling User Guide.

      • PlacementTenancy — (String)

        The tenancy of the instance, either default or dedicated. An instance with dedicated tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC.

      • MetadataOptions — (map)

        The metadata options for the instances. For more information, see Configure the instance metadata options in the Amazon EC2 Auto Scaling User Guide.

        • HttpTokens — (String)

          The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

          If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

          If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

          Possible values include:
          • "optional"
          • "required"
        • HttpPutResponseHopLimit — (Integer)

          The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

          Default: 1

        • HttpEndpoint — (String)

          This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.

          Note: If you specify a value of disabled, you will not be able to access your instance metadata.
          Possible values include:
          • "disabled"
          • "enabled"
    • NextToken — (String)

      A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example describes the lifecycle hooks for the specified Auto Scaling group. */

 var params = {
  AutoScalingGroupName: "my-auto-scaling-group"
 };
 autoscaling.describeLifecycleHooks(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    LifecycleHooks: [
       {
      AutoScalingGroupName: "my-auto-scaling-group", 
      DefaultResult: "ABANDON", 
      GlobalTimeout: 172800, 
      HeartbeatTimeout: 3600, 
      LifecycleHookName: "my-lifecycle-hook", 
      LifecycleTransition: "autoscaling:EC2_INSTANCE_LAUNCHING", 
      NotificationTargetARN: "arn:aws:sns:us-west-2:123456789012:my-sns-topic", 
      RoleARN: "arn:aws:iam::123456789012:role/my-auto-scaling-role"
     }
    ]
   }
   */
 });

var params = {
  AutoScalingGroupName: 'STRING_VALUE', /* required */
  LifecycleHookNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
autoscaling.describeLifecycleHooks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AutoScalingGroupName — (String)

    The name of the Auto Scaling group.

  • LifecycleHookNames — (Array<String>)

    The names of one or more lifecycle hooks. If you omit this property, all lifecycle hooks are described.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LifecycleHooks — (Array<map>)

      The lifecycle hooks for the specified group.

      • LifecycleHookName — (String)

        The name of the lifecycle hook.

      • AutoScalingGroupName — (String)

        The name of the Auto Scaling group for the lifecycle hook.

      • LifecycleTransition — (String)

        The lifecycle transition.

        Valid values: autoscaling:EC2_INSTANCE_LAUNCHING | autoscaling:EC2_INSTANCE_TERMINATING

      • NotificationTargetARN — (String)

        The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook.

      • RoleARN — (String)

        The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target (an Amazon SNS topic or an Amazon SQS queue).

      • NotificationMetadata — (String)

        Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.

      • HeartbeatTimeout — (Integer)

        The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.

      • GlobalTimeout — (Integer)

        The maximum time, in seconds, that an instance can remain in a wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.

      • DefaultResult — (String)

        The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.

        Valid values: CONTINUE | ABANDON

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.