Package software.amazon.awssdk.services.autoscaling.model

Class Filter

java.lang.Object
software.amazon.awssdk.services.autoscaling.model.Filter
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Filter.Builder,Filter>
@Generated("software.amazon.awssdk:codegen") public final class Filter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Filter.Builder,Filter>

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 Also:

  • Method Details

    • name

      public final String name()

      The name of the filter.

      The valid values for Name depend on which API operation you're using with the filter.

      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.

      DescribeScalingActivities

      Valid values for Name include the following:

      • StartTimeLowerBound - The earliest scaling activities to return based on the activity start time. Scaling activities with a start time earlier than this value are not included in the results. Only activities started within the last six weeks can be returned regardless of the value specified.

      • StartTimeUpperBound - The latest scaling activities to return based on the activity start time. Scaling activities with a start time later than this value are not included in the results. Only activities started within the last six weeks can be returned regardless of the value specified.

      • Status - The StatusCode value of the scaling activity. This filter can only be used in combination with the AutoScalingGroupName parameter. For valid StatusCode values, see Activity in the Amazon EC2 Auto Scaling API Reference.

      StartTimeLowerBound and StartTimeUpperBound accept ISO 8601 formatted timestamps. Timestamps without a timezone offset are assumed to be UTC.

      • 2000-01-18T08:15:00Z

      • 2000-01-18T16:15:00+08:00

      Returns:
      The name of the filter.

      The valid values for Name depend on which API operation you're using with the filter.

      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.

      DescribeScalingActivities

      Valid values for Name include the following:

      • StartTimeLowerBound - The earliest scaling activities to return based on the activity start time. Scaling activities with a start time earlier than this value are not included in the results. Only activities started within the last six weeks can be returned regardless of the value specified.

      • StartTimeUpperBound - The latest scaling activities to return based on the activity start time. Scaling activities with a start time later than this value are not included in the results. Only activities started within the last six weeks can be returned regardless of the value specified.

      • Status - The StatusCode value of the scaling activity. This filter can only be used in combination with the AutoScalingGroupName parameter. For valid StatusCode values, see Activity in the Amazon EC2 Auto Scaling API Reference.

      StartTimeLowerBound and StartTimeUpperBound accept ISO 8601 formatted timestamps. Timestamps without a timezone offset are assumed to be UTC.

      • 2000-01-18T08:15:00Z

      • 2000-01-18T16:15:00+08:00

    • hasValues

      public final boolean hasValues()
      For responses, this returns true if the service returned a value for the Values property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • values

      public final List<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.

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

      DescribeScalingActivities example: Specify "Status" for the filter name and "Successful,Failed" for the filter values to find scaling activities with a status of either "Successful" or "Failed".

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValues() method.

      Returns:
      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.

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

      DescribeScalingActivities example: Specify "Status" for the filter name and "Successful,Failed" for the filter values to find scaling activities with a status of either "Successful" or "Failed".

    • toBuilder

      public Filter.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<Filter.Builder,Filter>

    • builder

      public static Filter.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Filter.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo