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

Class: Aws::AutoScaling::Resource

Inherits:
Resources::Resource show all
Defined in:
(unknown)

Overview

This class provides a resource oriented interface for Auto Scaling. To create a resource object:

resource = Aws::AutoScaling::Resource.new

You can supply a client object with custom configuration that will be used for all resource operations. If you do not pass :client, a default client will be constructed.

client = Aws::AutoScaling::Client.new(region: 'us-west-2')
resource = Aws::AutoScaling::Resource.new(client: client)

Resource Resource Classes

Aws::AutoScaling::Resource has the following resource classes:

Instance Attribute Summary

Attributes inherited from Resources::Resource

#client, #identifiers

Instance Method Summary collapse

Methods inherited from Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

#initialize(options = {}) ⇒ Object #initialize(options = {}) ⇒ Object

Overloads:

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

    • :client (Client)

      When `:client is not given, the options hash is used to construct a new Client object.

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

    • :client (Client)

      When `:client is not given, the options hash is used to construct a new Client object.

Instance Method Details

#activities(options = {}) ⇒ Collection<Activity>

Returns a Collection of Activity resources. No API requests are made until you call an enumerable method on the collection. Client#describe_scaling_activities will be called multiple times until every Activity has been yielded.

Examples:

Request syntax example with placeholder values


autoscaling.activities({
  activity_ids: ["XmlString"],
  auto_scaling_group_name: "ResourceName",
  max_records: 1,
  next_token: "XmlString",
})

Enumerating Activity resources.

autoscaling.activities.each do |activity|
  # yields each activity
end

Enumerating Activity resources with a limit.

autoscaling.activities.limit(10).each do |activity|
  # yields at most 10 activities
end

Options Hash (options):

  • :activity_ids (Array<String>)

    The activity IDs of the desired scaling activities. If you omit this parameter, all activities for the past six weeks are described. If you specify an Auto Scaling group, the results are limited to that group. The list of requested activities cannot contain more than 50 items. If unknown activities are requested, they are ignored with no error.

  • :auto_scaling_group_name (String)

    The name of the Auto Scaling group.

  • :max_records (Integer)

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

  • :next_token (String)

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

Returns:

See Also:

#activity(id) ⇒ Activity

Parameters:

Returns:

See Also:

#create_group(options = {}) ⇒ AutoScalingGroup

Examples:

Request syntax example with placeholder values


autoscaling.create_group({
  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,
    },
  ],
})

Basic usage

autoscalinggroup = autoscaling.create_group(options)
autoscalinggroup.name
#=> "autoscalinggroup-name"

Options Hash (options):

  • :auto_scaling_group_name (required, String)

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

  • :launch_configuration_name (String)

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

  • :launch_template (Types::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.

  • :instance_id (String)

    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.

  • :min_size (required, Integer)

    The minimum size of the group.

  • :max_size (required, Integer)

    The maximum size of the group.

  • :desired_capacity (Integer)

    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.

  • :default_cooldown (Integer)

    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.

  • :availability_zones (Array<String>)

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

  • :load_balancer_names (Array<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.

  • :target_group_arns (Array<String>)

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

  • :health_check_type (String)

    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.

  • :health_check_grace_period (Integer)

    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.

  • :placement_group (String)

    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.

  • :vpc_zone_identifier (String)

    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.

  • :termination_policies (Array<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.

  • :new_instances_protected_from_scale_in (Boolean)

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

  • :lifecycle_hook_specification_list (Array<Types::LifecycleHookSpecification>)

    One or more lifecycle hooks.

  • :tags (Array<Types::Tag>)

    One or more tags.

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

Returns:

See Also:

#create_launch_configuration(options = {}) ⇒ LaunchConfiguration

Examples:

Request syntax example with placeholder values


autoscaling.create_launch_configuration({
  launch_configuration_name: "XmlStringMaxLen255", # required
  image_id: "XmlStringMaxLen255",
  key_name: "XmlStringMaxLen255",
  security_groups: ["XmlString"],
  classic_link_vpc_id: "XmlStringMaxLen255",
  classic_link_vpc_security_groups: ["XmlStringMaxLen255"],
  user_data: "XmlStringUserData",
  instance_id: "XmlStringMaxLen19",
  instance_type: "XmlStringMaxLen255",
  kernel_id: "XmlStringMaxLen255",
  ramdisk_id: "XmlStringMaxLen255",
  block_device_mappings: [
    {
      virtual_name: "XmlStringMaxLen255",
      device_name: "XmlStringMaxLen255", # required
      ebs: {
        snapshot_id: "XmlStringMaxLen255",
        volume_size: 1,
        volume_type: "BlockDeviceEbsVolumeType",
        delete_on_termination: false,
        iops: 1,
        encrypted: false,
      },
      no_device: false,
    },
  ],
  instance_monitoring: {
    enabled: false,
  },
  spot_price: "SpotPrice",
  iam_instance_profile: "XmlStringMaxLen1600",
  ebs_optimized: false,
  associate_public_ip_address: false,
  placement_tenancy: "XmlStringMaxLen64",
})

Basic usage

launchconfiguration = autoscaling.create_launch_configuration(options)
launchconfiguration.name
#=> "launchconfiguration-name"

Options Hash (options):

  • :launch_configuration_name (required, String)

    The name of the launch configuration. This name must be unique within the scope of your AWS account.

  • :image_id (String)

    The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.

    If you do not specify InstanceId, you must specify ImageId.

    For more information, see Finding an AMI in the Amazon Elastic Compute Cloud User Guide.

  • :key_name (String)

    The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon Elastic Compute Cloud User Guide.

  • :security_groups (Array<String>)

    One or more security groups with which to associate the instances.

    If your instances are launched in EC2-Classic, you can either specify security group names or the security group IDs. For more information about security groups for EC2-Classic, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide.

    If your instances are launched into a VPC, specify security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

  • :classic_link_vpc_id (String)

    The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter is supported only if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

  • :classic_link_vpc_security_groups (Array<String>)

    The IDs of one or more security groups for the specified ClassicLink-enabled VPC. This parameter is required if you specify a ClassicLink-enabled VPC, and is not supported otherwise. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

  • :user_data (String)

    The user data to make available to the launched EC2 instances. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide.

  • :instance_id (String)

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

    If you do not specify InstanceId, you must specify both ImageId and InstanceType.

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

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

  • :instance_type (String)

    The instance type of the EC2 instance.

    If you do not specify InstanceId, you must specify InstanceType.

    For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.

  • :kernel_id (String)

    The ID of the kernel associated with the AMI.

  • :ramdisk_id (String)

    The ID of the RAM disk associated with the AMI.

  • :block_device_mappings (Array<Types::BlockDeviceMapping>)

    One or more mappings that specify how block devices are exposed to the instance. For more information, see Block Device Mapping in the Amazon Elastic Compute Cloud User Guide.

  • :instance_monitoring (Types::InstanceMonitoring)

    Enables detailed monitoring (true) or basic monitoring (false) for the Auto Scaling instances. The default is true.

  • :spot_price (String)

    The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. For more information, see Launching Spot Instances in Your Auto Scaling Group in the Auto Scaling User Guide.

  • :iam_instance_profile (String)

    The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.

    EC2 instances launched with an IAM role will automatically have AWS security credentials available. You can use IAM roles with Auto Scaling to automatically enable applications running on your EC2 instances to securely access other AWS resources. For more information, see Launch Auto Scaling Instances with an IAM Role in the Auto Scaling User Guide.

  • :ebs_optimized (Boolean)

    Indicates whether the instance is optimized for Amazon EBS I/O. By default, the instance is not optimized for EBS I/O. The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional usage charges apply. For more information, see Amazon EBS-Optimized Instances in the Amazon Elastic Compute Cloud User Guide.

  • :associate_public_ip_address (Boolean)

    Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling User Guide.

    If you specify this parameter, be sure to specify at least one subnet when you create your group.

    Default: If the instance is launched into a default subnet, the default is true. If the instance is launched into a nondefault subnet, the default is false. For more information, see Supported Platforms in the Amazon Elastic Compute Cloud User Guide.

  • :placement_tenancy (String)

    The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware and can only be launched into a VPC.

    You must set the value of this parameter to dedicated if want to launch Dedicated Instances into a shared tenancy VPC (VPC with instance placement tenancy attribute set to default).

    If you specify this parameter, be sure to specify at least one subnet when you create your group.

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

    Valid values: default | dedicated

Returns:

See Also:

#group(name) ⇒ AutoScalingGroup

Parameters:

Returns:

See Also:

#groups(options = {}) ⇒ Collection<AutoScalingGroup>

Returns a Collection of AutoScalingGroup resources. No API requests are made until you call an enumerable method on the collection. Client#describe_auto_scaling_groups will be called multiple times until every AutoScalingGroup has been yielded.

Examples:

Request syntax example with placeholder values


autoscaling.groups({
  auto_scaling_group_names: ["ResourceName"],
  next_token: "XmlString",
  max_records: 1,
})

Enumerating AutoScalingGroup resources.

autoscaling.groups.each do |autoscalinggroup|
  # yields each autoscalinggroup
end

Enumerating AutoScalingGroup resources with a limit.

autoscaling.groups.limit(10).each do |autoscalinggroup|
  # yields at most 10 groups
end

Options Hash (options):

  • :auto_scaling_group_names (Array<String>)

    The names of the Auto Scaling groups. If you omit this parameter, all Auto Scaling groups are described.

  • :next_token (String)

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

  • :max_records (Integer)

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

Returns:

See Also:

#instances(options = {}) ⇒ Collection<Instance>

Returns a Collection of Instance resources. No API requests are made until you call an enumerable method on the collection. Client#describe_auto_scaling_instances will be called multiple times until every Instance has been yielded.

Examples:

Request syntax example with placeholder values


autoscaling.instances({
  instance_ids: ["XmlStringMaxLen19"],
  max_records: 1,
  next_token: "XmlString",
})

Enumerating Instance resources.

autoscaling.instances.each do |instance|
  # yields each instance
end

Enumerating Instance resources with a limit.

autoscaling.instances.limit(10).each do |instance|
  # yields at most 10 instances
end

Batch operations callable on the returned collection


# calls Client#attach_instances on each batch
autoscaling.instances.batch_attach

# calls Client#detach_instances on each batch
autoscaling.instances.batch_detach

# calls Client#enter_standby on each batch
autoscaling.instances.batch_enter_standby

# calls Client#exit_standby on each batch
autoscaling.instances.batch_exit_standby

Options Hash (options):

  • :instance_ids (Array<String>)

    The instances to describe; up to 50 instance IDs. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.

  • :max_records (Integer)

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

  • :next_token (String)

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

Returns:

See Also:

#launch_configuration(name) ⇒ LaunchConfiguration

Parameters:

Returns:

See Also:

#launch_configurations(options = {}) ⇒ Collection<LaunchConfiguration>

Returns a Collection of LaunchConfiguration resources. No API requests are made until you call an enumerable method on the collection. Client#describe_launch_configurations will be called multiple times until every LaunchConfiguration has been yielded.

Examples:

Request syntax example with placeholder values


autoscaling.launch_configurations({
  launch_configuration_names: ["ResourceName"],
  next_token: "XmlString",
  max_records: 1,
})

Enumerating LaunchConfiguration resources.

autoscaling.launch_configurations.each do |launchconfiguration|
  # yields each launchconfiguration
end

Enumerating LaunchConfiguration resources with a limit.

autoscaling.launch_configurations.limit(10).each do |launchconfiguration|
  # yields at most 10 launch_configurations
end

Options Hash (options):

  • :launch_configuration_names (Array<String>)

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

  • :next_token (String)

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

  • :max_records (Integer)

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

Returns:

See Also:

#policies(options = {}) ⇒ Collection<ScalingPolicy>

Returns a Collection of ScalingPolicy resources. No API requests are made until you call an enumerable method on the collection. Client#describe_policies will be called multiple times until every ScalingPolicy has been yielded.

Examples:

Request syntax example with placeholder values


autoscaling.policies({
  auto_scaling_group_name: "ResourceName",
  policy_names: ["ResourceName"],
  policy_types: ["XmlStringMaxLen64"],
  next_token: "XmlString",
  max_records: 1,
})

Enumerating ScalingPolicy resources.

autoscaling.policies.each do |scalingpolicy|
  # yields each scalingpolicy
end

Enumerating ScalingPolicy resources with a limit.

autoscaling.policies.limit(10).each do |scalingpolicy|
  # yields at most 10 policies
end

Options Hash (options):

  • :auto_scaling_group_name (String)

    The name of the Auto Scaling group.

  • :policy_names (Array<String>)

    The names of one or more policies. If you omit this parameter, all policies are described. If an group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.

  • :policy_types (Array<String>)

    One or more policy types. Valid values are SimpleScaling and StepScaling.

  • :next_token (String)

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

  • :max_records (Integer)

    The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.

Returns:

See Also:

#policy(name) ⇒ ScalingPolicy

Parameters:

Returns:

See Also:

#scheduled_action(name) ⇒ ScheduledAction

Parameters:

Returns:

See Also:

#scheduled_actions(options = {}) ⇒ Collection<ScheduledAction>

Returns a Collection of ScheduledAction resources. No API requests are made until you call an enumerable method on the collection. Client#describe_scheduled_actions will be called multiple times until every ScheduledAction has been yielded.

Examples:

Request syntax example with placeholder values


autoscaling.scheduled_actions({
  auto_scaling_group_name: "ResourceName",
  scheduled_action_names: ["ResourceName"],
  start_time: Time.now,
  end_time: Time.now,
  next_token: "XmlString",
  max_records: 1,
})

Enumerating ScheduledAction resources.

autoscaling.scheduled_actions.each do |scheduledaction|
  # yields each scheduledaction
end

Enumerating ScheduledAction resources with a limit.

autoscaling.scheduled_actions.limit(10).each do |scheduledaction|
  # yields at most 10 scheduled_actions
end

Options Hash (options):

  • :auto_scaling_group_name (String)

    The name of the Auto Scaling group.

  • :scheduled_action_names (Array<String>)

    Describes one or more scheduled actions. If you omit this parameter, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.

    You can describe up to a maximum of 50 instances with a single call. If there are more items to return, the call returns a token. To get the next set of items, repeat the call with the returned token.

  • :start_time (Time)

    The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.

  • :end_time (Time)

    The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.

  • :next_token (String)

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

  • :max_records (Integer)

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

Returns:

See Also:

#tags(options = {}) ⇒ Collection<Tag>

Returns a Collection of Tag resources. No API requests are made until you call an enumerable method on the collection. Client#describe_tags will be called multiple times until every Tag has been yielded.

Examples:

Request syntax example with placeholder values


autoscaling.tags({
  filters: [
    {
      name: "XmlString",
      values: ["XmlString"],
    },
  ],
  next_token: "XmlString",
  max_records: 1,
})

Enumerating Tag resources.

autoscaling.tags.each do |tag|
  # yields each tag
end

Enumerating Tag resources with a limit.

autoscaling.tags.limit(10).each do |tag|
  # yields at most 10 tags
end

Batch operations callable on the returned collection


# calls Client#create_or_update_tags on each batch
autoscaling.tags.batch_create

# calls Client#delete_tags on each batch
autoscaling.tags.batch_delete!

Options Hash (options):

  • :filters (Array<Types::Filter>)

    A filter used to scope the tags to return.

  • :next_token (String)

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

  • :max_records (Integer)

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

Returns:

  • (Collection<Tag>)

See Also: