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

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

Overview

Note:

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

{
  name: "XmlString",
  values: ["XmlString"],
}

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 joined with an AND, and the request returns only results that match all of the specified filters.

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#nameString

The name of the filter.

The valid values for Name depend on the API operation that you are including the filter in, DescribeAutoScalingGroups or DescribeTags.

DescribeAutoScalingGroups

Valid values for Name include the following:

  • tag-key - Accepts tag keys. The results will only include information about the Auto Scaling groups associated with these tag keys.

  • tag-value - Accepts tag values. The results will 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 will 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 will only include information about the tags associated with these Auto Scaling groups.

  • key - Accepts tag keys. The results will only include information about the tags associated with these tag keys.

  • value - Accepts tag values. The results will 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 will only include information about the tags associated with the specified boolean value.

Returns:

  • (String)


3324
3325
3326
3327
3328
3329
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3324

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

#valuesArray<String>

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

If you specify multiple values for a filter, the values are 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".

Returns:

  • (Array<String>)


3324
3325
3326
3327
3328
3329
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3324

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