Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AutoScaling.Types.Filter

Description

Synopsis

data Filter = Filter' {
- values :: Maybe [Text]
- name :: Text
}
newFilter :: Text -> Filter
filter_values :: Lens' Filter (Maybe [Text])
filter_name :: Lens' Filter Text

Documentation

data Filter Source #

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.

See: newFilter smart constructor.

Constructors

Filter'

Fields

values :: Maybe [Text]
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".
name :: Text
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.

Instances

Instances details

ToQuery Filter Source #
Instance details Defined in Amazonka.AutoScaling.Types.Filter Methods toQuery :: Filter -> QueryString #
Generic Filter Source #
Instance details Defined in Amazonka.AutoScaling.Types.Filter Associated Types type Rep Filter :: Type -> Type # Methods from :: Filter -> Rep Filter x # to :: Rep Filter x -> Filter #
Read Filter Source #
Instance details Defined in Amazonka.AutoScaling.Types.Filter Methods readsPrec :: Int -> ReadS Filter # readList :: ReadS [Filter] # readPrec :: ReadPrec Filter # readListPrec :: ReadPrec [Filter] #
Show Filter Source #
Instance details Defined in Amazonka.AutoScaling.Types.Filter Methods showsPrec :: Int -> Filter -> ShowS # show :: Filter -> String # showList :: [Filter] -> ShowS #
NFData Filter Source #
Instance details Defined in Amazonka.AutoScaling.Types.Filter Methods rnf :: Filter -> () #
Eq Filter Source #
Instance details Defined in Amazonka.AutoScaling.Types.Filter Methods (==) :: Filter -> Filter -> Bool # (/=) :: Filter -> Filter -> Bool #
Hashable Filter Source #
Instance details Defined in Amazonka.AutoScaling.Types.Filter Methods hashWithSalt :: Int -> Filter -> Int # hash :: Filter -> Int #
type Rep Filter Source #
Instance details Defined in Amazonka.AutoScaling.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.AutoScaling.Types.Filter" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newFilter Source #

Arguments

:: Text	`$sel:name:Filter'`
-> Filter

Create a value of Filter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:values:Filter', filter_values - 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".

$sel:name:Filter', filter_name - 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.

filter_values :: Lens' Filter (Maybe [Text]) Source #

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

filter_name :: Lens' Filter Text Source #

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.