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

Class: Aws::AutoScalingPlans::Types::DescribeScalingPlansRequest

Inherits:

Struct

• Object
• Struct
• Aws::AutoScalingPlans::Types::DescribeScalingPlansRequest

Defined in:

gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb

Overview

Note:

When making an API call, you may pass DescribeScalingPlansRequest data as a hash:

{
  scaling_plan_names: ["ScalingPlanName"],
  scaling_plan_version: 1,
  application_sources: [
    {
      cloud_formation_stack_arn: "XmlString",
      tag_filters: [
        {
          key: "XmlStringMaxLen128",
          values: ["XmlStringMaxLen256"],
        },
      ],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #application_sources ⇒ Array<Types::ApplicationSource>

  The sources for the applications (up to 10).

• #max_results ⇒ Integer

  The maximum number of scalable resources to return.

• #next_token ⇒ String

  The token for the next set of results.

• #scaling_plan_names ⇒ Array<String>

  The names of the scaling plans (up to 10).

• #scaling_plan_version ⇒ Integer

  The version of the scaling plan.

Instance Attribute Details

#application_sources ⇒ Array<Types::ApplicationSource>

The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources.

Returns:

• (Array<Types::ApplicationSource>)

# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 304

class DescribeScalingPlansRequest < Struct.new(
  :scaling_plan_names,
  :scaling_plan_version,
  :application_sources,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50.

Returns:

• (Integer)

# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 304

class DescribeScalingPlansRequest < Struct.new(
  :scaling_plan_names,
  :scaling_plan_version,
  :application_sources,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_token ⇒ String

The token for the next set of results.

Returns:

• (String)

# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 304

class DescribeScalingPlansRequest < Struct.new(
  :scaling_plan_names,
  :scaling_plan_version,
  :application_sources,
  :max_results,
  :next_token)
  include Aws::Structure
end

#scaling_plan_names ⇒ Array<String>

The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 304

class DescribeScalingPlansRequest < Struct.new(
  :scaling_plan_names,
  :scaling_plan_version,
  :application_sources,
  :max_results,
  :next_token)
  include Aws::Structure
end

#scaling_plan_version ⇒ Integer

The version of the scaling plan. If you specify a scaling plan version, you must also specify a scaling plan name.

Returns:

• (Integer)

# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/types.rb', line 304

class DescribeScalingPlansRequest < Struct.new(
  :scaling_plan_names,
  :scaling_plan_version,
  :application_sources,
  :max_results,
  :next_token)
  include Aws::Structure
end