You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::AutoScaling::Types::CreateAutoScalingGroupType

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb

Overview

Note:

When making an API call, you may pass CreateAutoScalingGroupType data as a hash:

{
  auto_scaling_group_name: "XmlStringMaxLen255", # required
  launch_configuration_name: "ResourceName",
  launch_template: {
    launch_template_id: "XmlStringMaxLen255",
    launch_template_name: "LaunchTemplateName",
    version: "XmlStringMaxLen255",
  },
  instance_id: "XmlStringMaxLen19",
  min_size: 1, # required
  max_size: 1, # required
  desired_capacity: 1,
  default_cooldown: 1,
  availability_zones: ["XmlStringMaxLen255"],
  load_balancer_names: ["XmlStringMaxLen255"],
  target_group_arns: ["XmlStringMaxLen511"],
  health_check_type: "XmlStringMaxLen32",
  health_check_grace_period: 1,
  placement_group: "XmlStringMaxLen255",
  vpc_zone_identifier: "XmlStringMaxLen2047",
  termination_policies: ["XmlStringMaxLen1600"],
  new_instances_protected_from_scale_in: false,
  lifecycle_hook_specification_list: [
    {
      lifecycle_hook_name: "AsciiStringMaxLen255", # required
      lifecycle_transition: "LifecycleTransition", # required
      notification_metadata: "XmlStringMaxLen1023",
      heartbeat_timeout: 1,
      default_result: "LifecycleActionResult",
      notification_target_arn: "NotificationTargetResourceName",
      role_arn: "ResourceName",
    },
  ],
  tags: [
    {
      resource_id: "XmlString",
      resource_type: "XmlString",
      key: "TagKey", # required
      value: "TagValue",
      propagate_at_launch: false,
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_nameString

The name of the Auto Scaling group. This name must be unique within the scope of your AWS account.

Returns:

  • (String)


807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 807

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :instance_id,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in,
  :lifecycle_hook_specification_list,
  :tags)
  include Aws::Structure
end

#availability_zonesArray<String>

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

Returns:

  • (Array<String>)


807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 807

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :instance_id,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in,
  :lifecycle_hook_specification_list,
  :tags)
  include Aws::Structure
end

#default_cooldownInteger

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

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

Returns:

  • (Integer)


807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 807

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :instance_id,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in,
  :lifecycle_hook_specification_list,
  :tags)
  include Aws::Structure
end

#desired_capacityInteger

The number of EC2 instances that should be running in the group. 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.

Returns:

  • (Integer)


807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 807

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :instance_id,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in,
  :lifecycle_hook_specification_list,
  :tags)
  include Aws::Structure
end

#health_check_grace_periodInteger

The amount of time, in seconds, that 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 is 0.

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

For more information, see Health Checks in the Auto Scaling User Guide.

Returns:

  • (Integer)


807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 807

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :instance_id,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in,
  :lifecycle_hook_specification_list,
  :tags)
  include Aws::Structure
end

#health_check_typeString

The service to use for the health checks. The valid values are EC2 and ELB.

By default, health checks use Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Checks in the Auto Scaling User Guide.

Returns:

  • (String)


807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 807

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :instance_id,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in,
  :lifecycle_hook_specification_list,
  :tags)
  include Aws::Structure
end

#instance_idString

The ID of the instance used to create a launch configuration for the group. You must specify one of the following: an EC2 instance, a launch configuration, or a launch template.

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

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

Returns:

  • (String)


807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 807

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :instance_id,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in,
  :lifecycle_hook_specification_list,
  :tags)
  include Aws::Structure
end

#launch_configuration_nameString

The name of the launch configuration. You must specify one of the following: a launch configuration, a launch template, or an EC2 instance.

Returns:

  • (String)


807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 807

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :instance_id,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in,
  :lifecycle_hook_specification_list,
  :tags)
  include Aws::Structure
end

#launch_templateTypes::LaunchTemplateSpecification

The launch template to use to launch instances. You must specify one of the following: a launch template, a launch configuration, or an EC2 instance.



807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 807

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :instance_id,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in,
  :lifecycle_hook_specification_list,
  :tags)
  include Aws::Structure
end

#lifecycle_hook_specification_listArray<Types::LifecycleHookSpecification>

One or more lifecycle hooks.



807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 807

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :instance_id,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in,
  :lifecycle_hook_specification_list,
  :tags)
  include Aws::Structure
end

#load_balancer_namesArray<String>

One or more Classic Load Balancers. To specify an Application Load Balancer, use TargetGroupARNs instead.

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

Returns:

  • (Array<String>)


807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 807

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :instance_id,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in,
  :lifecycle_hook_specification_list,
  :tags)
  include Aws::Structure
end

#max_sizeInteger

The maximum size of the group.

Returns:

  • (Integer)


807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 807

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :instance_id,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in,
  :lifecycle_hook_specification_list,
  :tags)
  include Aws::Structure
end

#min_sizeInteger

The minimum size of the group.

Returns:

  • (Integer)


807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 807

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :instance_id,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in,
  :lifecycle_hook_specification_list,
  :tags)
  include Aws::Structure
end

#new_instances_protected_from_scale_inBoolean

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

Returns:

  • (Boolean)


807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 807

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :instance_id,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in,
  :lifecycle_hook_specification_list,
  :tags)
  include Aws::Structure
end

#placement_groupString

The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (String)


807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 807

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :instance_id,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in,
  :lifecycle_hook_specification_list,
  :tags)
  include Aws::Structure
end

#tagsArray<Types::Tag>

One or more tags.

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

Returns:



807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 807

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :instance_id,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in,
  :lifecycle_hook_specification_list,
  :tags)
  include Aws::Structure
end

#target_group_arnsArray<String>

The Amazon Resource Names (ARN) of the target groups.

Returns:

  • (Array<String>)


807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 807

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :instance_id,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in,
  :lifecycle_hook_specification_list,
  :tags)
  include Aws::Structure
end

#termination_policiesArray<String>

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 Auto Scaling User Guide.

Returns:

  • (Array<String>)


807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 807

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :instance_id,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in,
  :lifecycle_hook_specification_list,
  :tags)
  include Aws::Structure
end

#vpc_zone_identifierString

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

If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.

For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling User Guide.

Returns:

  • (String)


807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 807

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :instance_id,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in,
  :lifecycle_hook_specification_list,
  :tags)
  include Aws::Structure
end