@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Filter extends Object implements Serializable, Cloneable
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.
Constructor and Description |
---|
Filter() |
Modifier and Type | Method and Description |
---|---|
Filter |
clone() |
boolean |
equals(Object obj) |
String |
getName()
The name of the filter.
|
List<String> |
getValues()
One or more filter values.
|
int |
hashCode() |
void |
setName(String name)
The name of the filter.
|
void |
setValues(Collection<String> values)
One or more filter values.
|
String |
toString()
Returns a string representation of this object.
|
Filter |
withName(String name)
The name of the filter.
|
Filter |
withValues(Collection<String> values)
One or more filter values.
|
Filter |
withValues(String... values)
One or more filter values.
|
public void setName(String 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.
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.
public String getName()
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.
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.
public Filter withName(String 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.
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.
public List<String> getValues()
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".
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".
public void setValues(Collection<String> 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".
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".
public Filter withValues(String... 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".
NOTE: This method appends the values to the existing list (if any). Use
setValues(java.util.Collection)
or withValues(java.util.Collection)
if you want to override the
existing values.
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".
public Filter withValues(Collection<String> 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".
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".
public String toString()
toString
in class Object
Object.toString()