AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

ResourceQuery

import "github.com/aws/aws-sdk-go/service/resourcegroups"

type ResourceQuery struct { Query *string `type:"string" required:"true"` Type *string `type:"string" required:"true" enum:"QueryType"` }

The query that is used to define a resource group or a search for resources.

Query

Type: *string

The query that defines a group or a search.

Query is a required field

Type

Type: *string

The type of the query. The valid values in this release are TAG_FILTERS_1_0 and CLOUDFORMATION_STACK_1_0.

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 GetResources (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html) 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 might include the following.

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

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

The query would not return the following results, however. The following EC2 instance does not have all tag keys specified in the filter, so it is rejected. The RDS database has all of the tag keys, but no values that match at least one of the specified tag key values in the filter.

  • An EC2 instance that has only the following tag: {"Key":"Stage","Values":["Deploy"]}.

  • An RDS database that has the following two tags: {"Key":"Stage","Values":["Archived"]}, and {"Key":"Version","Values":["4"]}

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

Type is a required field

Method

GoString

func (s ResourceQuery) GoString() string

GoString returns the string representation

SetQuery

func (s *ResourceQuery) SetQuery(v string) *ResourceQuery

SetQuery sets the Query field's value.

SetType

func (s *ResourceQuery) SetType(v string) *ResourceQuery

SetType sets the Type field's value.

String

func (s ResourceQuery) String() string

String returns the string representation

Validate

func (s *ResourceQuery) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: