GroupConfigurationParameter
A parameter for a group configuration item. For details about group service configuration syntax, see Service configurations for resource groups.
Contents
NoteIn the following list, the required parameters are described first.
Name
The name of the group configuration parameter. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 80.
Pattern: [a-z-]+
Required: Yes Values
The value or values to be used for the specified parameter. For the list of values you can use with each parameter, see Supported resource types and parameters.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [a-zA-Z0-9:_-]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
GroupFilter
GroupFilter
A filter collection that you can use to restrict the results from a List operation to only those you want to include.
Contents
NoteIn the following list, the required parameters are described first.
Name
The name of the filter. Filter names are case-sensitive.
Type: String
Valid Values: resource-type | configuration-type Required: Yes
Values
One or more filter values. Allowed filter values vary by group filter name, and are case-sensitive.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: AWS::(AllSupported|[a-zA-Z0-9]+::[a-zA-Z0-9]+) Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
GroupIdentifier
GroupIdentifier
The unique identifiers for a resource group.
Contents
NoteIn the following list, the required parameters are described first.
GroupArn
The ARN of the resource group.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 1600.
Pattern: arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\d{1}:[0-9]
{12}:group/[a-zA-Z0-9_\.-]{1,128}
Required: No GroupName
The name of the resource group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [a-zA-Z0-9_\.-]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
GroupQuery
GroupQuery
A mapping of a query attached to a resource group that determines the AWS resources that are members of the group.
Contents
NoteIn the following list, the required parameters are described first.
GroupName
The name of the resource group that is associated with the specified resource query.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [a-zA-Z0-9_\.-]+
Required: Yes ResourceQuery
The resource query that determines which AWS resources are members of the associated resource group.
Type: ResourceQuery (p. 94) object Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ListGroupResourcesItem
ListGroupResourcesItem
A structure returned by the ListGroupResources (p. 37) operation that contains identity and group membership status information for one of the resources in the group.
Contents
NoteIn the following list, the required parameters are described first.
Identifier
A structure that contains the ARN of a resource and its resource type.
Type: ResourceIdentifier (p. 93) object Required: No
Status
A structure that contains the status of this resource's membership in the group.
NoteThis field is present in the response only if the group is of type AWS::EC2::HostManagement.
Type: ResourceStatus (p. 97) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
PendingResource
PendingResource
A structure that identifies a resource that is currently pending addition to the group as a member.
Adding a resource to a resource group happens asynchronously as a background task and this one isn't completed yet.
Contents
Note
In the following list, the required parameters are described first.
ResourceArn
The Amazon resource name (ARN) of the resource that's in a pending state.
Type: String
Pattern: arn:aws(-[a-z]+)*:[a-z0-9\-]*:([a-z]{2}(-[a-z]+)+-\d{1})?:([0-9]
{12})?:.+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
QueryError
QueryError
A two-part error structure that can occur in ListGroupResources or SearchResources operations on CloudFront stack-based queries. The error occurs if the CloudFront stack on which the query is based either does not exist, or has a status that renders the stack inactive. A QueryError occurrence does not necessarily mean that AWS Resource Groups could not complete the operation, but the resulting group might have no member resources.
Contents
Note
In the following list, the required parameters are described first.
ErrorCode
Possible values are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING.
Type: String
Valid Values: CLOUDFORMATION_STACK_INACTIVE | CLOUDFORMATION_STACK_NOT_EXISTING Required: No
Message
A message that explains the ErrorCode value. Messages might state that the specified CloudFront stack does not exist (or no longer exists). For CLOUDFORMATION_STACK_INACTIVE, the message typically states that the CloudFront stack has a status that is not (or no longer) active, such as CREATE_FAILED.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ResourceFilter
ResourceFilter
A filter name and value pair that is used to obtain more specific results from a list of resources.
Contents
NoteIn the following list, the required parameters are described first.
Name
The name of the filter. Filter names are case-sensitive.
Type: String
Valid Values: resource-type Required: Yes
Values
One or more filter values. Allowed filter values vary by resource filter name, and are case-sensitive.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: AWS::[a-zA-Z0-9]+::[a-zA-Z0-9]+
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ResourceIdentifier
ResourceIdentifier
A structure that contains the ARN of a resource and its resource type.
Contents
NoteIn the following list, the required parameters are described first.
ResourceArn
The ARN of a resource.
Type: String
Pattern: arn:aws(-[a-z]+)*:[a-z0-9\-]*:([a-z]{2}(-[a-z]+)+-\d{1})?:([0-9]
{12})?:.+
Required: No ResourceType
The resource type of a resource, such as AWS::EC2::Instance.
Type: String
Pattern: AWS::[a-zA-Z0-9]+::\w+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ResourceQuery
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 AWS Resource Groups in the AWS 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 AWS 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 AWS Resource Groups and Tag Editor in the AWS Resource Groups User Guide. For example:
"ResourceTypeFilters":["AWS::S3::Bucket", "AWS::EC2::Instance"]
Contents
NoteIn the following list, the required parameters are described first.
Query
The query that defines a group or a search. The contents depends on the value of the Type element.
• ResourceTypeFilters – Applies to all ResourceQuery objects of either Type. 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 AWS Resource Groups and Tag Editor in the AWS Resource Groups User Guide.
Example: "ResourceTypeFilters": ["AWS::AllSupported"] or
"ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]
• TagFilters – applicable only if Type = TAG_FILTERS_1_0. The Query contains a JSON string that represents a collection of simple tag filters. The JSON string uses a syntax similar to the GetResources operation, but uses only the ResourceTypeFilters and TagFilters 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 and Version, with two values each:
[{"Stage":["Test","Deploy"]},{"Version":["1","2"]}]
See Also
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 if Type = CLOUDFORMATION_STACK_1_0. The value of this parameter is the Amazon Resource Name (ARN) of the AWS CloudFormation stack whose resources you want included in the group.
Type: String
Length Constraints: Maximum length of 4096.
Pattern: [\s\S]*
Required: Yes 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 AWS CloudFormation stack. The Query contains a StackIdentifier 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^\w+$
Valid Values: TAG_FILTERS_1_0 | CLOUDFORMATION_STACK_1_0 Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
See Also
ResourceStatus
ResourceStatus
A structure that identifies the current group membership status for a resource. Adding a resource to a resource group is performed asynchronously as a background task. A PENDING status indicates, for this resource, that the process isn't completed yet.
Contents
Note
In the following list, the required parameters are described first.
Name
The current status.
Type: String
Valid Values: PENDING Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Accessing