Class: Aws::AutoScaling::Resource

Inherits:

Object

Object
Aws::AutoScaling::Resource

show all

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

Actions collapse

Associations collapse

Instance Method Summary collapse

#client ⇒ Client
#initialize(options = {}) ⇒ Resource constructor

A new instance of Resource.

Constructor Details

#initialize(options = {}) ⇒ `Resource`

Returns a new instance of Resource.

Parameters:

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

Options Hash (options):

:client (Client)



13
14
15

# File '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:

(Activity::Collection)

# File 'lib/aws-sdk-autoscaling/resource.rb', line 492

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:

(Activity)

# File 'lib/aws-sdk-autoscaling/resource.rb', line 512

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

#client ⇒ `Client`

Returns:

(Client)



18
19
20

# File '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",
  },
  mixed_instances_policy: {
    launch_template: {
      launch_template_specification: {
        launch_template_id: "XmlStringMaxLen255",
        launch_template_name: "LaunchTemplateName",
        version: "XmlStringMaxLen255",
      },
      overrides: [
        {
          instance_type: "XmlStringMaxLen255",
        },
      ],
    },
    instances_distribution: {
      on_demand_allocation_strategy: "XmlString",
      on_demand_base_capacity: 1,
      on_demand_percentage_above_base_capacity: 1,
      spot_allocation_strategy: "XmlString",
      spot_instance_pools: 1,
      spot_max_price: "SpotPrice",
    },
  },
  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. This parameter, a launch template, a mixed instances policy, or an EC2 instance must be specified.
:launch_template (Types::LaunchTemplateSpecification) —

The launch template to use to launch instances. This parameter, a launch configuration, a mixed instances policy, or an EC2 instance must be specified.
:mixed_instances_policy (Types::MixedInstancesPolicy) —

The mixed instances policy to use to launch instances. This parameter, a launch template, a launch configuration, or an EC2 instance must be specified.
:instance_id (String) —

The ID of the instance used to create a launch configuration for the group. This parameter, a launch configuration, a launch template, or a mixed instances policy must be specified.

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, except for 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*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html
: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*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html
: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*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html
: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*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
: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*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
:placement_group (String) —

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html
: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*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html
: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*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html
: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*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html
: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:

(AutoScalingGroup)

# File 'lib/aws-sdk-autoscaling/resource.rb', line 237

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html
: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*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html
: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, 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*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html [2]: docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html
: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*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html
: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*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html
: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*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html
:instance_id (String) —

The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for 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*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/create-lc-with-instanceID.html
: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.*

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes
: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*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
: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*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html
: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 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*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html
: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*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html
: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.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html
: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.

To launch Dedicated Instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to ‘default`), you must set the value of this parameter to `dedicated`.

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`

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html

Returns:

(LaunchConfiguration)

# File 'lib/aws-sdk-autoscaling/resource.rb', line 466

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:

(AutoScalingGroup)

# File 'lib/aws-sdk-autoscaling/resource.rb', line 521

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:

(AutoScalingGroup::Collection)

# File 'lib/aws-sdk-autoscaling/resource.rb', line 539

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:

(Instance::Collection)

# File 'lib/aws-sdk-autoscaling/resource.rb', line 568

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:

(LaunchConfiguration)

# File 'lib/aws-sdk-autoscaling/resource.rb', line 589

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:

(LaunchConfiguration::Collection)

# File 'lib/aws-sdk-autoscaling/resource.rb', line 606

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 a 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:

(ScalingPolicy::Collection)

# File 'lib/aws-sdk-autoscaling/resource.rb', line 643

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:

(ScalingPolicy)

# File 'lib/aws-sdk-autoscaling/resource.rb', line 663

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

#scheduled_action(name) ⇒ `ScheduledAction`

Parameters:

name (String)

Returns:

(ScheduledAction)

# File 'lib/aws-sdk-autoscaling/resource.rb', line 672

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:

(ScheduledAction::Collection)

# File 'lib/aws-sdk-autoscaling/resource.rb', line 702

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

One or more filters to scope the tags to return. The maximum number of filters per filter type (for example, ‘auto-scaling-group`) is 1000.

Returns:

(Tag::Collection)

# File 'lib/aws-sdk-autoscaling/resource.rb', line 735

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

Class: Aws::AutoScaling::Resource

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Resource

Instance Method Details

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

#activity(id) ⇒ Activity

#client ⇒ Client

#create_group(options = {}) ⇒ AutoScalingGroup

#create_launch_configuration(options = {}) ⇒ LaunchConfiguration

#group(name) ⇒ AutoScalingGroup

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

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

#launch_configuration(name) ⇒ LaunchConfiguration

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

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

#policy(name) ⇒ ScalingPolicy

#scheduled_action(name) ⇒ ScheduledAction

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

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

#initialize(options = {}) ⇒ `Resource`

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

#activity(id) ⇒ `Activity`

#client ⇒ `Client`

#create_group(options = {}) ⇒ `AutoScalingGroup`

#create_launch_configuration(options = {}) ⇒ `LaunchConfiguration`

#group(name) ⇒ `AutoScalingGroup`

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

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

#launch_configuration(name) ⇒ `LaunchConfiguration`

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

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

#policy(name) ⇒ `ScalingPolicy`

#scheduled_action(name) ⇒ `ScheduledAction`

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

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