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

Class: Aws::AutoScaling::Resource

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

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Resource

Returns a new instance of Resource

Parameters:

  • options ({}) (defaults to: {})

Options Hash (options):



13
14
15
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/resource.rb', line 13

def initialize(options = {})
  @client = options[:client] || Client.new(options)
end

Instance Method Details

#activities(options = {}) ⇒ Activity::Collection

Examples:

Request syntax with placeholder values


activities = auto_scaling.activities({
  activity_ids: ["XmlString"],
  auto_scaling_group_name: "ResourceName",
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :activity_ids (Array<String>)

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

  • :auto_scaling_group_name (String)

    The name of the Auto Scaling group.

Returns:



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/resource.rb', line 466

def activities(options = {})
  batches = Enumerator.new do |y|
    resp = @client.describe_scaling_activities(options)
    resp.each_page do |page|
      batch = []
      page.data.activities.each do |a|
        batch << Activity.new(
          id: a.activity_id,
          data: a,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Activity::Collection.new(batches)
end

#activity(id) ⇒ Activity

Parameters:

  • id (String)

Returns:



486
487
488
489
490
491
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/resource.rb', line 486

def activity(id)
  Activity.new(
    id: id,
    client: @client
  )
end

#clientClient

Returns:



18
19
20
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/resource.rb', line 18

def client
  @client
end

#create_group(options = {}) ⇒ AutoScalingGroup

Examples:

Request syntax with placeholder values


autoscalinggroup = auto_scaling.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,
    },
  ],
  service_linked_role_arn: "ResourceName",
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

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, Amazon EC2 Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.

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

  • :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 Scaling Cooldowns in the Amazon EC2 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 Amazon EC2 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 Amazon EC2 Auto Scaling User Guide.

  • :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. 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 Amazon EC2 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 Amazon EC2 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 Amazon EC2 Auto Scaling User Guide.

  • :service_linked_role_arn (String)

    The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist.

Returns:



211
212
213
214
215
216
217
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/resource.rb', line 211

def create_group(options = {})
  resp = @client.create_auto_scaling_group(options)
  AutoScalingGroup.new(
    name: options[:auto_scaling_group_name],
    client: @client
  )
end

#create_launch_configuration(options = {}) ⇒ LaunchConfiguration

Examples:

Request syntax with placeholder values


launchconfiguration = auto_scaling.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",
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

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 Amazon EC2 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 Amazon EC2 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 Amazon EC2 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 Amazon EC2 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 Amazon EC2 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 to assign a public IP address. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address.

  • :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 Amazon EC2 Auto Scaling User Guide.

    Valid values: default | dedicated

Returns:



440
441
442
443
444
445
446
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/resource.rb', line 440

def create_launch_configuration(options = {})
  resp = @client.create_launch_configuration(options)
  LaunchConfiguration.new(
    name: options[:launch_configuration_name],
    client: @client
  )
end

#group(name) ⇒ AutoScalingGroup

Parameters:

  • name (String)

Returns:



495
496
497
498
499
500
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/resource.rb', line 495

def group(name)
  AutoScalingGroup.new(
    name: name,
    client: @client
  )
end

#groups(options = {}) ⇒ AutoScalingGroup::Collection

Examples:

Request syntax with placeholder values


groups = auto_scaling.groups({
  auto_scaling_group_names: ["ResourceName"],
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :auto_scaling_group_names (Array<String>)

    The names of the Auto Scaling groups. You can specify up to MaxRecords names. If you omit this parameter, all Auto Scaling groups are described.

Returns:



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/resource.rb', line 513

def groups(options = {})
  batches = Enumerator.new do |y|
    resp = @client.describe_auto_scaling_groups(options)
    resp.each_page do |page|
      batch = []
      page.data.auto_scaling_groups.each do |a|
        batch << AutoScalingGroup.new(
          name: a.auto_scaling_group_name,
          data: a,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  AutoScalingGroup::Collection.new(batches)
end

#instances(options = {}) ⇒ Instance::Collection

Examples:

Request syntax with placeholder values


instances = auto_scaling.instances({
  instance_ids: ["XmlStringMaxLen19"],
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :instance_ids (Array<String>)

    The IDs of the instances. You can specify up to MaxRecords 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.

Returns:



542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/resource.rb', line 542

def instances(options = {})
  batches = Enumerator.new do |y|
    resp = @client.describe_auto_scaling_instances(options)
    resp.each_page do |page|
      batch = []
      page.data.auto_scaling_instances.each do |a|
        batch << Instance.new(
          group_name: a.auto_scaling_group_name,
          id: a.instance_id,
          data: a,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Instance::Collection.new(batches)
end

#launch_configuration(name) ⇒ LaunchConfiguration

Parameters:

  • name (String)

Returns:



563
564
565
566
567
568
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/resource.rb', line 563

def launch_configuration(name)
  LaunchConfiguration.new(
    name: name,
    client: @client
  )
end

#launch_configurations(options = {}) ⇒ LaunchConfiguration::Collection

Examples:

Request syntax with placeholder values


launch_configurations = auto_scaling.launch_configurations({
  launch_configuration_names: ["ResourceName"],
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :launch_configuration_names (Array<String>)

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

Returns:



580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/resource.rb', line 580

def launch_configurations(options = {})
  batches = Enumerator.new do |y|
    resp = @client.describe_launch_configurations(options)
    resp.each_page do |page|
      batch = []
      page.data.launch_configurations.each do |l|
        batch << LaunchConfiguration.new(
          name: l.launch_configuration_name,
          data: l,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  LaunchConfiguration::Collection.new(batches)
end

#policies(options = {}) ⇒ ScalingPolicy::Collection

Examples:

Request syntax with placeholder values


policies = auto_scaling.policies({
  auto_scaling_group_name: "ResourceName",
  policy_names: ["ResourceName"],
  policy_types: ["XmlStringMaxLen64"],
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

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.

Returns:



617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/resource.rb', line 617

def policies(options = {})
  batches = Enumerator.new do |y|
    resp = @client.describe_policies(options)
    resp.each_page do |page|
      batch = []
      page.data.scaling_policies.each do |s|
        batch << ScalingPolicy.new(
          name: s.policy_name,
          data: s,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  ScalingPolicy::Collection.new(batches)
end

#policy(name) ⇒ ScalingPolicy

Parameters:

  • name (String)

Returns:



637
638
639
640
641
642
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/resource.rb', line 637

def policy(name)
  ScalingPolicy.new(
    name: name,
    client: @client
  )
end

#scheduled_action(name) ⇒ ScheduledAction

Parameters:

  • name (String)

Returns:



646
647
648
649
650
651
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/resource.rb', line 646

def scheduled_action(name)
  ScheduledAction.new(
    name: name,
    client: @client
  )
end

#scheduled_actions(options = {}) ⇒ ScheduledAction::Collection

Examples:

Request syntax with placeholder values


scheduled_actions = auto_scaling.scheduled_actions({
  auto_scaling_group_name: "ResourceName",
  scheduled_action_names: ["ResourceName"],
  start_time: Time.now,
  end_time: Time.now,
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :auto_scaling_group_name (String)

    The name of the Auto Scaling group.

  • :scheduled_action_names (Array<String>)

    The names of one or more scheduled actions. You can specify up to 50 actions. If you omit this parameter, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.

  • :start_time (Time, DateTime, Date, Integer, String)

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

  • :end_time (Time, DateTime, Date, Integer, String)

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

Returns:



676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/resource.rb', line 676

def scheduled_actions(options = {})
  batches = Enumerator.new do |y|
    resp = @client.describe_scheduled_actions(options)
    resp.each_page do |page|
      batch = []
      page.data.scheduled_update_group_actions.each do |s|
        batch << ScheduledAction.new(
          name: s.scheduled_action_name,
          data: s,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  ScheduledAction::Collection.new(batches)
end

#tags(options = {}) ⇒ Tag::Collection

Examples:

Request syntax with placeholder values


tags = auto_scaling.tags({
  filters: [
    {
      name: "XmlString",
      values: ["XmlString"],
    },
  ],
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

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

    A filter used to scope the tags to return.

Returns:



708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/resource.rb', line 708

def tags(options = {})
  batches = Enumerator.new do |y|
    resp = @client.describe_tags(options)
    resp.each_page do |page|
      batch = []
      page.data.tags.each do |t|
        batch << Tag.new(
          key: t.key,
          resource_id: t.resource_id,
          resource_type: t.resource_type,
          data: t,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Tag::Collection.new(batches)
end