AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateAutoScalingGroup operation. Creates an Auto Scaling group with the specified name and attributes.

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.AutoScaling.AmazonAutoScalingRequest
      Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest

Namespace: Amazon.AutoScaling.Model
Assembly: AWSSDK.AutoScaling.dll
Version: 3.x.y.z

Syntax

C#
public class CreateAutoScalingGroupRequest : AmazonAutoScalingRequest
         IAmazonWebServiceRequest

The CreateAutoScalingGroupRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AutoScalingGroupName System.String

Gets and sets the property AutoScalingGroupName.

The name of the Auto Scaling group. This name must be unique per Region per account.

Public Property AvailabilityZones System.Collections.Generic.List<System.String>

Gets and sets the property AvailabilityZones.

One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets for VPCZoneIdentifier.

Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into EC2-Classic.

Public Property DefaultCooldown System.Int32

Gets and sets the property DefaultCooldown.

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

Public Property DesiredCapacity System.Int32

Gets and sets the property DesiredCapacity.

The number of Amazon EC2 instances that the Auto Scaling group attempts to maintain. 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.

Public Property HealthCheckGracePeriod System.Int32

Gets and sets the property HealthCheckGracePeriod.

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. During this time, any health check failures for the instance are ignored. The default value is 0.

For more information, see Health Check Grace Period in the Amazon EC2 Auto Scaling User Guide.

Conditional: This parameter is required if you are adding an ELB health check.

Public Property HealthCheckType System.String

Gets and sets the property HealthCheckType.

The service to use for the health checks. The valid values are EC2 and ELB. The default value is EC2. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.

For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.

Public Property InstanceId System.String

Gets and sets the property InstanceId.

The ID of the instance used to create a launch configuration for the group.

When you specify an ID of an instance, Amazon EC2 Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, except for the block device mapping.

For more information, see Create an Auto Scaling Group Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide.

You must specify one of the following parameters in your request: LaunchConfigurationName, LaunchTemplate, InstanceId, or MixedInstancesPolicy.

Public Property LaunchConfigurationName System.String

Gets and sets the property LaunchConfigurationName.

The name of the launch configuration.

If you do not specify LaunchConfigurationName, you must specify one of the following parameters: InstanceId, LaunchTemplate, or MixedInstancesPolicy.

Public Property LaunchTemplate Amazon.AutoScaling.Model.LaunchTemplateSpecification

Gets and sets the property LaunchTemplate.

The launch template to use to launch instances.

For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API Reference.

If you do not specify LaunchTemplate, you must specify one of the following parameters: InstanceId, LaunchConfigurationName, or MixedInstancesPolicy.

Public Property LifecycleHookSpecificationList System.Collections.Generic.List<Amazon.AutoScaling.Model.LifecycleHookSpecification>

Gets and sets the property LifecycleHookSpecificationList.

One or more lifecycle hooks.

Public Property LoadBalancerNames System.Collections.Generic.List<System.String>

Gets and sets the property LoadBalancerNames.

A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers and Network Load Balancers, specify a list of target groups using the TargetGroupARNs property instead.

For more information, see Using a Load Balancer with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

Public Property MaxInstanceLifetime System.Int32

Gets and sets the property MaxInstanceLifetime.

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

For more information, see Replacing Auto Scaling Instances Based on Maximum Instance Lifetime in the Amazon EC2 Auto Scaling User Guide.

Valid Range: Minimum value of 604800.

Public Property MaxSize System.Int32

Gets and sets the property MaxSize.

The maximum size of the group.

Public Property MinSize System.Int32

Gets and sets the property MinSize.

The minimum size of the group.

Public Property MixedInstancesPolicy Amazon.AutoScaling.Model.MixedInstancesPolicy

Gets and sets the property MixedInstancesPolicy.

An embedded object that specifies a mixed instances policy. The required parameters must be specified. If optional parameters are unspecified, their default values are used.

The policy includes parameters that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacity, but also the parameters that specify the instance configuration information—the launch template and instance types.

For more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.

You must specify one of the following parameters in your request: LaunchConfigurationName, LaunchTemplate, InstanceId, or MixedInstancesPolicy.

Public Property NewInstancesProtectedFromScaleIn System.Boolean

Gets and sets the property NewInstancesProtectedFromScaleIn.

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 Instance Protection in the Amazon EC2 Auto Scaling User Guide.

Public Property PlacementGroup System.String

Gets and sets the property PlacementGroup.

The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

Public Property ServiceLinkedRoleARN System.String

Gets and sets the property ServiceLinkedRoleARN.

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

Public Property Tags System.Collections.Generic.List<Amazon.AutoScaling.Model.Tag>

Gets and sets the property Tags.

One or more tags.

For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.

Public Property TargetGroupARNs System.Collections.Generic.List<System.String>

Gets and sets the property TargetGroupARNs.

The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling group. Instances are registered as targets in a target group, and traffic is routed to the target group.

For more information, see Using a Load Balancer with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

Public Property TerminationPolicies System.Collections.Generic.List<System.String>

Gets and sets the property TerminationPolicies.

One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.

For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.

Public Property VPCZoneIdentifier System.String

Gets and sets the property VPCZoneIdentifier.

A comma-separated list of subnet IDs for your virtual private cloud (VPC).

If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones.

Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into a VPC.

Examples

This example creates an Auto Scaling group.

To create an Auto Scaling group


var response = client.CreateAutoScalingGroup(new CreateAutoScalingGroupRequest 
{
    AutoScalingGroupName = "my-auto-scaling-group",
    LaunchConfigurationName = "my-launch-config",
    MaxSize = 3,
    MinSize = 1,
    VPCZoneIdentifier = "subnet-4176792c"
});


            

This example creates an Auto Scaling group and attaches the specified Classic Load Balancer.

To create an Auto Scaling group with an attached load balancer


var response = client.CreateAutoScalingGroup(new CreateAutoScalingGroupRequest 
{
    AutoScalingGroupName = "my-auto-scaling-group",
    AvailabilityZones = new List<string> {
        "us-west-2c"
    },
    HealthCheckGracePeriod = 120,
    HealthCheckType = "ELB",
    LaunchConfigurationName = "my-launch-config",
    LoadBalancerNames = new List<string> {
        "my-load-balancer"
    },
    MaxSize = 3,
    MinSize = 1
});


            

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

To create an Auto Scaling group with an attached target group


var response = client.CreateAutoScalingGroup(new CreateAutoScalingGroupRequest 
{
    AutoScalingGroupName = "my-auto-scaling-group",
    HealthCheckGracePeriod = 120,
    HealthCheckType = "ELB",
    LaunchConfigurationName = "my-launch-config",
    MaxSize = 3,
    MinSize = 1,
    TargetGroupARNs = new List<string> {
        "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
    },
    VPCZoneIdentifier = "subnet-4176792c, subnet-65ea5f08"
});


            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms