Class ResourceQuery
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ResourceQuery.Builder,
ResourceQuery>
The query you can use to define a resource group or a search for resources. A ResourceQuery
specifies
both a query Type
and a Query
string as JSON string objects. See the examples section for
example JSON strings. For more information about creating a resource group with a resource query, see Build queries and groups in
Resource Groups in the Resource Groups User Guide
When you combine all of the elements together into a single string, any double quotes that are embedded inside
another double quote pair must be escaped by preceding the embedded double quote with a backslash character (\). For
example, a complete ResourceQuery
parameter must be formatted like the following CLI parameter example:
--resource-query '{"Type":"TAG_FILTERS_1_0","Query":"{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"TagFilters\":[{\"Key\":\"Stage\",\"Values\":[\"Test\"]}]}"}'
In the preceding example, all of the double quote characters in the value part of the Query
element must
be escaped because the value itself is surrounded by double quotes. For more information, see Quoting strings
in the Command Line Interface User Guide.
For the complete list of resource types that you can use in the array value for ResourceTypeFilters
, see
Resources you can use with
Resource Groups and Tag Editor in the Resource Groups User Guide. For example:
"ResourceTypeFilters":["AWS::S3::Bucket", "AWS::EC2::Instance"]
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ResourceQuery.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
query()
The query that defines a group or a search.static Class
<? extends ResourceQuery.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final QueryType
type()
The type of the query to perform.final String
The type of the query to perform.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
type
The type of the query to perform. This can have one of two values:
-
CLOUDFORMATION_STACK_1_0:
Specifies that you want the group to contain the members of an CloudFormation stack. TheQuery
contains aStackIdentifier
element with an ARN for a CloudFormation stack. -
TAG_FILTERS_1_0:
Specifies that you want the group to include resource that have tags that match the query.
If the service returns an enum value that is not available in the current SDK version,
type
will returnQueryType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the query to perform. This can have one of two values:
-
CLOUDFORMATION_STACK_1_0:
Specifies that you want the group to contain the members of an CloudFormation stack. TheQuery
contains aStackIdentifier
element with an ARN for a CloudFormation stack. -
TAG_FILTERS_1_0:
Specifies that you want the group to include resource that have tags that match the query.
-
- See Also:
-
-
typeAsString
The type of the query to perform. This can have one of two values:
-
CLOUDFORMATION_STACK_1_0:
Specifies that you want the group to contain the members of an CloudFormation stack. TheQuery
contains aStackIdentifier
element with an ARN for a CloudFormation stack. -
TAG_FILTERS_1_0:
Specifies that you want the group to include resource that have tags that match the query.
If the service returns an enum value that is not available in the current SDK version,
type
will returnQueryType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the query to perform. This can have one of two values:
-
CLOUDFORMATION_STACK_1_0:
Specifies that you want the group to contain the members of an CloudFormation stack. TheQuery
contains aStackIdentifier
element with an ARN for a CloudFormation stack. -
TAG_FILTERS_1_0:
Specifies that you want the group to include resource that have tags that match the query.
-
- See Also:
-
-
query
The query that defines a group or a search. The contents depends on the value of the
Type
element.-
ResourceTypeFilters
– Applies to allResourceQuery
objects of eitherType
. This element contains one of the following two items:-
The value
AWS::AllSupported
. This causes the ResourceQuery to match resources of any resource type that also match the query. -
A list (a JSON array) of resource type identifiers that limit the query to only resources of the specified types. For the complete list of resource types that you can use in the array value for
ResourceTypeFilters
, see Resources you can use with Resource Groups and Tag Editor in the Resource Groups User Guide.
Example:
"ResourceTypeFilters": ["AWS::AllSupported"]
or"ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]
-
-
TagFilters
– applicable only ifType
=TAG_FILTERS_1_0
. TheQuery
contains a JSON string that represents a collection of simple tag filters. The JSON string uses a syntax similar to theGetResources
operation, but uses only theResourceTypeFilters
andTagFilters
fields. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values.For example, consider the following sample query for resources that have two tags,
Stage
andVersion
, with two values each:[{"Stage":["Test","Deploy"]},{"Version":["1","2"]}]
The results of this resource query could include the following.
-
An Amazon EC2 instance that has the following two tags:
{"Stage":"Deploy"}
, and{"Version":"2"}
-
An S3 bucket that has the following two tags:
{"Stage":"Test"}
, and{"Version":"1"}
The resource query results would not include the following items in the results, however.
-
An Amazon EC2 instance that has only the following tag:
{"Stage":"Deploy"}
.The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.
-
An RDS database that has the following two tags:
{"Stage":"Archived"}
and{"Version":"4"}
The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.
Example:
"TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }
-
-
StackIdentifier
– applicable only ifType
=CLOUDFORMATION_STACK_1_0
. The value of this parameter is the Amazon Resource Name (ARN) of the CloudFormation stack whose resources you want included in the group.
- Returns:
- The query that defines a group or a search. The contents depends on the value of the
Type
element.-
ResourceTypeFilters
– Applies to allResourceQuery
objects of eitherType
. This element contains one of the following two items:-
The value
AWS::AllSupported
. This causes the ResourceQuery to match resources of any resource type that also match the query. -
A list (a JSON array) of resource type identifiers that limit the query to only resources of the specified types. For the complete list of resource types that you can use in the array value for
ResourceTypeFilters
, see Resources you can use with Resource Groups and Tag Editor in the Resource Groups User Guide.
Example:
"ResourceTypeFilters": ["AWS::AllSupported"]
or"ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]
-
-
TagFilters
– applicable only ifType
=TAG_FILTERS_1_0
. TheQuery
contains a JSON string that represents a collection of simple tag filters. The JSON string uses a syntax similar to theGetResources
operation, but uses only theResourceTypeFilters
andTagFilters
fields. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values.For example, consider the following sample query for resources that have two tags,
Stage
andVersion
, with two values each:[{"Stage":["Test","Deploy"]},{"Version":["1","2"]}]
The results of this resource query could include the following.
-
An Amazon EC2 instance that has the following two tags:
{"Stage":"Deploy"}
, and{"Version":"2"}
-
An S3 bucket that has the following two tags:
{"Stage":"Test"}
, and{"Version":"1"}
The resource query results would not include the following items in the results, however.
-
An Amazon EC2 instance that has only the following tag:
{"Stage":"Deploy"}
.The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.
-
An RDS database that has the following two tags:
{"Stage":"Archived"}
and{"Version":"4"}
The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.
Example:
"TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }
-
-
StackIdentifier
– applicable only ifType
=CLOUDFORMATION_STACK_1_0
. The value of this parameter is the Amazon Resource Name (ARN) of the CloudFormation stack whose resources you want included in the group.
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ResourceQuery.Builder,
ResourceQuery> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-