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

Inherits:

Struct

Object
Struct
Aws::AutoScaling::Types::CreateAutoScalingGroupType

show all

Includes:: Structure

Defined in:: lib/aws-sdk-autoscaling/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#auto_scaling_group_name ⇒ String

The name of the Auto Scaling group.
#availability_zones ⇒ Array<String>

A list of Availability Zones where instances in the Auto Scaling group can be created.
#capacity_rebalance ⇒ Boolean

Indicates whether Capacity Rebalancing is enabled.
#context ⇒ String

Reserved.
#default_cooldown ⇒ Integer

*Only needed if you use simple scaling policies.*.
#default_instance_warmup ⇒ 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.
#desired_capacity ⇒ 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.
#desired_capacity_type ⇒ String

The unit of measurement for the value specified for desired capacity.
#health_check_grace_period ⇒ 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.
#health_check_type ⇒ String

A comma-separated value string of one or more health check types.
#instance_id ⇒ String

The ID of the instance used to base the launch configuration on.
#instance_maintenance_policy ⇒ Types::InstanceMaintenancePolicy

An instance maintenance policy.
#launch_configuration_name ⇒ String

The name of the launch configuration to use to launch instances.
#launch_template ⇒ Types::LaunchTemplateSpecification

Information used to specify the launch template and version to use to launch instances.
#lifecycle_hook_specification_list ⇒ Array<Types::LifecycleHookSpecification>

One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
#load_balancer_names ⇒ Array<String>

A list of Classic Load Balancers associated with this Auto Scaling group.
#max_instance_lifetime ⇒ Integer

The maximum amount of time, in seconds, that an instance can be in service.
#max_size ⇒ Integer

The maximum size of the group.
#min_size ⇒ Integer

The minimum size of the group.
#mixed_instances_policy ⇒ Types::MixedInstancesPolicy

The mixed instances policy.
#new_instances_protected_from_scale_in ⇒ Boolean

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

The name of the placement group into which to launch your instances.
#service_linked_role_arn ⇒ 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.
#tags ⇒ Array<Types::Tag>

One or more tags.
#target_group_arns ⇒ Array<String>

The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group.
#termination_policies ⇒ Array<String>

A policy or a list of policies that are used to select the instance to terminate.
#traffic_sources ⇒ Array<Types::TrafficSourceIdentifier>

The list of traffic sources to attach to this Auto Scaling group.
#vpc_zone_identifier ⇒ String

A comma-separated list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.

Instance Attribute Details

#auto_scaling_group_name ⇒ `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 markdown=“1”> You cannot use a colon (:) in the name.

</note>

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zones ⇒ `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.

Returns:

(Array<String>)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_rebalance ⇒ `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*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html

Returns:

(Boolean)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#context ⇒ `String`

Reserved.

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#default_cooldown ⇒ `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

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-cooldowns.html

Returns:

(Integer)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#default_instance_warmup ⇒ `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

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html

Returns:

(Integer)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#desired_capacity ⇒ `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.

Returns:

(Integer)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#desired_capacity_type ⇒ `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`

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/create-mixed-instances-group-attribute-based-instance-type-selection.html

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_grace_period ⇒ `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

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html

Returns:

(Integer)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_type ⇒ `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.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-health-checks.html

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ `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*.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html [2]: docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#instance_maintenance_policy ⇒ `Types::InstanceMaintenancePolicy`

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

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html

Returns:

(Types::InstanceMaintenancePolicy)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#launch_configuration_name ⇒ `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`).

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#launch_template ⇒ `Types::LaunchTemplateSpecification`

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 markdown=“1”> 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*.

</note>

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html

Returns:

(Types::LaunchTemplateSpecification)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycle_hook_specification_list ⇒ `Array<Types::LifecycleHookSpecification>`

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

Returns:

(Array<Types::LifecycleHookSpecification>)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#load_balancer_names ⇒ `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.

Returns:

(Array<String>)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#max_instance_lifetime ⇒ `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*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html

Returns:

(Integer)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#max_size ⇒ `Integer`

The maximum size of the group.

<note markdown=“1”> 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).

</note>

Returns:

(Integer)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#min_size ⇒ `Integer`

The minimum size of the group.

Returns:

(Integer)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#mixed_instances_policy ⇒ `Types::MixedInstancesPolicy`

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

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html

Returns:

(Types::MixedInstancesPolicy)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#new_instances_protected_from_scale_in ⇒ `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*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html

Returns:

(Boolean)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#placement_group ⇒ `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 markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#service_linked_role_arn ⇒ `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][1: in the *Amazon EC2 Auto Scaling User

Guide*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<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 [Tag Auto Scaling groups and instances] in the *Amazon EC2 Auto Scaling User Guide*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#target_group_arns ⇒ `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*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html

Returns:

(Array<String>)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#termination_policies ⇒ `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*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html

Returns:

(Array<String>)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#traffic_sources ⇒ `Array<Types::TrafficSourceIdentifier>`

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.

Returns:

(Array<Types::TrafficSourceIdentifier>)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_zone_identifier ⇒ `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.

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1252

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,
  :default_instance_warmup,
  :traffic_sources,
  :instance_maintenance_policy)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_name ⇒ String

#availability_zones ⇒ Array<String>

#capacity_rebalance ⇒ Boolean

#context ⇒ String

#default_cooldown ⇒ Integer

#default_instance_warmup ⇒ Integer

#desired_capacity ⇒ Integer

#desired_capacity_type ⇒ String

#health_check_grace_period ⇒ Integer

#health_check_type ⇒ String

#instance_id ⇒ String

#instance_maintenance_policy ⇒ Types::InstanceMaintenancePolicy

#launch_configuration_name ⇒ String

#launch_template ⇒ Types::LaunchTemplateSpecification

#lifecycle_hook_specification_list ⇒ Array<Types::LifecycleHookSpecification>

#load_balancer_names ⇒ Array<String>

#max_instance_lifetime ⇒ Integer

#max_size ⇒ Integer

#min_size ⇒ Integer

#mixed_instances_policy ⇒ Types::MixedInstancesPolicy

#new_instances_protected_from_scale_in ⇒ Boolean

#placement_group ⇒ String

#service_linked_role_arn ⇒ String

#tags ⇒ Array<Types::Tag>

#target_group_arns ⇒ Array<String>

#termination_policies ⇒ Array<String>

#traffic_sources ⇒ Array<Types::TrafficSourceIdentifier>

#vpc_zone_identifier ⇒ String

#auto_scaling_group_name ⇒ `String`

#availability_zones ⇒ `Array<String>`

#capacity_rebalance ⇒ `Boolean`

#context ⇒ `String`

#default_cooldown ⇒ `Integer`

#default_instance_warmup ⇒ `Integer`

#desired_capacity ⇒ `Integer`

#desired_capacity_type ⇒ `String`

#health_check_grace_period ⇒ `Integer`

#health_check_type ⇒ `String`

#instance_id ⇒ `String`

#instance_maintenance_policy ⇒ `Types::InstanceMaintenancePolicy`

#launch_configuration_name ⇒ `String`

#launch_template ⇒ `Types::LaunchTemplateSpecification`

#lifecycle_hook_specification_list ⇒ `Array<Types::LifecycleHookSpecification>`

#load_balancer_names ⇒ `Array<String>`

#max_instance_lifetime ⇒ `Integer`

#max_size ⇒ `Integer`

#min_size ⇒ `Integer`

#mixed_instances_policy ⇒ `Types::MixedInstancesPolicy`

#new_instances_protected_from_scale_in ⇒ `Boolean`

#placement_group ⇒ `String`

#service_linked_role_arn ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#target_group_arns ⇒ `Array<String>`

#termination_policies ⇒ `Array<String>`

#traffic_sources ⇒ `Array<Types::TrafficSourceIdentifier>`

#vpc_zone_identifier ⇒ `String`