Class: Aws::AutoScaling::Types::Filter

Inherits:

Struct

Object
Struct
Aws::AutoScaling::Types::Filter

show all

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

Overview

Describes a filter that is used to return a more specific list of results from a describe operation.

If you specify multiple filters, the filters are automatically logically joined with an AND, and the request returns only the results that match all of the specified filters.

For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#name ⇒ String
The name of the filter.
#values ⇒ Array<String>
One or more filter values.

Instance Attribute Details

#name ⇒ `String`

The name of the filter.

The valid values for Name depend on which API operation you're using with the filter (DescribeAutoScalingGroups or DescribeTags).

DescribeAutoScalingGroups

Valid values for Name include the following:

tag-key - Accepts tag keys. The results only include information about the Auto Scaling groups associated with these tag keys.
tag-value - Accepts tag values. The results only include information about the Auto Scaling groups associated with these tag values.
tag:<key> - Accepts the key/value combination of the tag. Use the tag key in the filter name and the tag value as the filter value. The results only include information about the Auto Scaling groups associated with the specified key/value combination.

DescribeTags

Valid values for Name include the following:

auto-scaling-group - Accepts the names of Auto Scaling groups. The results only include information about the tags associated with these Auto Scaling groups.
key - Accepts tag keys. The results only include information about the tags associated with these tag keys.
value - Accepts tag values. The results only include information about the tags associated with these tag values.
propagate-at-launch - Accepts a Boolean value, which specifies whether tags propagate to instances at launch. The results only include information about the tags associated with the specified Boolean value.

Returns:

(String)

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

class Filter < Struct.new(
  :name,
  :values)
  SENSITIVE = []
  include Aws::Structure
end

#values ⇒ `Array<String>`

One or more filter values. Filter values are case-sensitive.

If you specify multiple values for a filter, the values are automatically logically joined with an OR, and the request returns all results that match any of the specified values. For example, specify "tag:environment" for the filter name and "production,development" for the filter values to find Auto Scaling groups with the tag "environment=production" or "environment=development".