software.amazon.awssdk.services.resourcegroups.model

Interface ResourceQuery.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ResourceQuery.Builder,ResourceQuery>, SdkBuilder<ResourceQuery.Builder,ResourceQuery>, SdkPojo

Enclosing class:

ResourceQuery

public static interface ResourceQuery.Builder
extends SdkPojo, CopyableBuilder<ResourceQuery.Builder,ResourceQuery>

Method Summary

Modifier and Type	Method and Description
ResourceQuery.Builder	query(String query) The query that defines a group or a search.
ResourceQuery.Builder	type(QueryType type) The type of the query.
ResourceQuery.Builder	type(String type) The type of the query.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

type

ResourceQuery.Builder type(String type)

The type of the query. You can use the following values:

• CLOUDFORMATION_STACK_1_0: A JSON syntax that lets you specify a CloudFormation stack ARN.

• TAG_FILTERS_1_0: A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API ResourceTypeFilters parameter of the tagging:GetResources operation. 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 and Version, with two values each:

  [{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}]

  The results of this query could include the following.

  • An EC2 instance that has the following two tags: {"Key":"Stage","Value":"Deploy"}, and {"Key":"Version","Value":"2"}

  • An S3 bucket that has the following two tags: {"Key":"Stage","Value":"Test"}, and {"Key":"Version","Value":"1"}

  The query would not include the following items in the results, however.

  • An EC2 instance that has only the following tag: {"Key":"Stage","Value":"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: {"Key":"Stage","Value":"Archived"}, and {"Key":"Version","Value":"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.

Parameters:

type - The type of the query. You can use the following values:

• CLOUDFORMATION_STACK_1_0: A JSON syntax that lets you specify a CloudFormation stack ARN.

• TAG_FILTERS_1_0: A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API ResourceTypeFilters parameter of the tagging:GetResources operation. 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 and Version, with two values each:

  [{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}]

  The results of this query could include the following.

  • An EC2 instance that has the following two tags: {"Key":"Stage","Value":"Deploy"}, and {"Key":"Version","Value":"2"}

  • An S3 bucket that has the following two tags: {"Key":"Stage","Value":"Test"}, and {"Key":"Version","Value":"1"}

  The query would not include the following items in the results, however.

  • An EC2 instance that has only the following tag: {"Key":"Stage","Value":"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: {"Key":"Stage","Value":"Archived"}, and {"Key":"Version","Value":"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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

QueryType, QueryType

type

ResourceQuery.Builder type(QueryType type)

The type of the query. You can use the following values:

• CLOUDFORMATION_STACK_1_0: A JSON syntax that lets you specify a CloudFormation stack ARN.

• TAG_FILTERS_1_0: A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API ResourceTypeFilters parameter of the tagging:GetResources operation. 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 and Version, with two values each:

  [{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}]

  The results of this query could include the following.

  • An EC2 instance that has the following two tags: {"Key":"Stage","Value":"Deploy"}, and {"Key":"Version","Value":"2"}

  • An S3 bucket that has the following two tags: {"Key":"Stage","Value":"Test"}, and {"Key":"Version","Value":"1"}

  The query would not include the following items in the results, however.

  • An EC2 instance that has only the following tag: {"Key":"Stage","Value":"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: {"Key":"Stage","Value":"Archived"}, and {"Key":"Version","Value":"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.

Parameters:

type - The type of the query. You can use the following values:

• CLOUDFORMATION_STACK_1_0: A JSON syntax that lets you specify a CloudFormation stack ARN.

• TAG_FILTERS_1_0: A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API ResourceTypeFilters parameter of the tagging:GetResources operation. 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 and Version, with two values each:

  [{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}]

  The results of this query could include the following.

  • An EC2 instance that has the following two tags: {"Key":"Stage","Value":"Deploy"}, and {"Key":"Version","Value":"2"}

  • An S3 bucket that has the following two tags: {"Key":"Stage","Value":"Test"}, and {"Key":"Version","Value":"1"}

  The query would not include the following items in the results, however.

  • An EC2 instance that has only the following tag: {"Key":"Stage","Value":"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: {"Key":"Stage","Value":"Archived"}, and {"Key":"Version","Value":"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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

QueryType, QueryType

query

ResourceQuery.Builder query(String query)

The query that defines a group or a search.

Parameters:

query - The query that defines a group or a search.

Returns:

Returns a reference to this object so that method calls can be chained together.