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: "XmlStringMaxLen255",
  launch_template: {
    launch_template_id: "XmlStringMaxLen255",
    launch_template_name: "LaunchTemplateName",
    version: "XmlStringMaxLen255",
  },
  mixed_instances_policy: {
    launch_template: {
      launch_template_specification: {
        launch_template_id: "XmlStringMaxLen255",
        launch_template_name: "LaunchTemplateName",
        version: "XmlStringMaxLen255",
      },
      overrides: [
        {
          instance_type: "XmlStringMaxLen255",
          weighted_capacity: "XmlStringMaxLen32",
          launch_template_specification: {
            launch_template_id: "XmlStringMaxLen255",
            launch_template_name: "LaunchTemplateName",
            version: "XmlStringMaxLen255",
          },
          instance_requirements: {
            v_cpu_count: { # required
              min: 1, # required
              max: 1,
            },
            memory_mi_b: { # required
              min: 1, # required
              max: 1,
            },
            cpu_manufacturers: ["intel"], # accepts intel, amd, amazon-web-services
            memory_gi_b_per_v_cpu: {
              min: 1.0,
              max: 1.0,
            },
            excluded_instance_types: ["ExcludedInstance"],
            instance_generations: ["current"], # accepts current, previous
            spot_max_price_percentage_over_lowest_price: 1,
            on_demand_max_price_percentage_over_lowest_price: 1,
            bare_metal: "included", # accepts included, excluded, required
            burstable_performance: "included", # accepts included, excluded, required
            require_hibernate_support: false,
            network_interface_count: {
              min: 1,
              max: 1,
            },
            local_storage: "included", # accepts included, excluded, required
            local_storage_types: ["hdd"], # accepts hdd, ssd
            total_local_storage_gb: {
              min: 1.0,
              max: 1.0,
            },
            baseline_ebs_bandwidth_mbps: {
              min: 1,
              max: 1,
            },
            accelerator_types: ["gpu"], # accepts gpu, fpga, inference
            accelerator_count: {
              min: 1,
              max: 1,
            },
            accelerator_manufacturers: ["nvidia"], # accepts nvidia, amd, amazon-web-services, xilinx
            accelerator_names: ["a100"], # accepts a100, v100, k80, t4, m60, radeon-pro-v520, vu9p
            accelerator_total_memory_mi_b: {
              min: 1,
              max: 1,
            },
          },
        },
      ],
    },
    instances_distribution: {
      on_demand_allocation_strategy: "XmlString",
      on_demand_base_capacity: 1,
      on_demand_percentage_above_base_capacity: 1,
      spot_allocation_strategy: "XmlString",
      spot_instance_pools: 1,
      spot_max_price: "MixedInstanceSpotPrice",
    },
  },
  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,
  capacity_rebalance: 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: "XmlStringMaxLen255",
    },
  ],
  tags: [
    {
      resource_id: "XmlString",
      resource_type: "XmlString",
      key: "TagKey", # required
      value: "TagValue",
      propagate_at_launch: false,
    },
  ],
  service_linked_role_arn: "ResourceName",
  max_instance_lifetime: 1,
  context: "Context",
  desired_capacity_type: "XmlStringMaxLen255",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_nameString

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

Returns:

  • (String)


1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zonesArray<String>

A list of Availability Zones where instances in the Auto Scaling group can be created. 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.

Returns:

  • (Array<String>)


1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_rebalanceBoolean

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

Returns:

  • (Boolean)


1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#contextString

Reserved.

Returns:

  • (String)


1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  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 value is 300. This setting applies when using simple scaling policies, but not when using other scaling policies or scheduled scaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Returns:

  • (Integer)


1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#desired_capacityInteger

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.

Returns:

  • (Integer)


1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#desired_capacity_typeString

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 Creating an Auto Scaling 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

Returns:

  • (String)


1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_grace_periodInteger

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. The default value is 0. For more information, see Health check grace period in the Amazon EC2 Auto Scaling User Guide.

Conditional: Required if you are adding an ELB health check.

Returns:

  • (Integer)


1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_typeString

The service to use for the health checks. The valid values are EC2 (default) and ELB. If you configure an Auto Scaling group to use load balancer (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.

Returns:

  • (String)


1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#instance_idString

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 Creating an Auto Scaling group using an EC2 instance in the Amazon EC2 Auto Scaling User Guide.

Returns:

  • (String)


1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#launch_configuration_nameString

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).

Returns:

  • (String)


1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#launch_templateTypes::LaunchTemplateSpecification

Parameters 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).

The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see Creating a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.



1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycle_hook_specification_listArray<Types::LifecycleHookSpecification>

One or more lifecycle hooks for the group, which specify actions to perform when Amazon EC2 Auto Scaling launches or terminates instances.



1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#load_balancer_namesArray<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.

Returns:

  • (Array<String>)


1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#max_instance_lifetimeInteger

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 Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.

Returns:

  • (Integer)


1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#max_sizeInteger

The maximum size of the group.

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).

Returns:

  • (Integer)


1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#min_sizeInteger

The minimum size of the group.

Returns:

  • (Integer)


1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#mixed_instances_policyTypes::MixedInstancesPolicy

An embedded object that specifies a 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.



1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#new_instances_protected_from_scale_inBoolean

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 Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.

Returns:

  • (Boolean)


1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#placement_groupString

The name of an existing 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.

Returns:

  • (String)


1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#service_linked_role_arnString

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. 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.

Returns:

  • (String)


1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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 Tagging Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.

Returns:



1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#target_group_arnsArray<String>

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 Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Returns:

  • (Array<String>)


1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#termination_policiesArray<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 Controlling which Auto Scaling instances terminate during scale in in the Amazon EC2 Auto Scaling User Guide.

Returns:

  • (Array<String>)


1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_zone_identifierString

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 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.

Returns:

  • (String)


1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1404

class CreateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :capacity_rebalance,
  :lifecycle_hook_specification_list,
  :tags,
  :service_linked_role_arn,
  :max_instance_lifetime,
  :context,
  :desired_capacity_type)
  SENSITIVE = []
  include Aws::Structure
end