String groupLifecycleEventsDesiredStatus
The desired target status of the group lifecycle events feature. If
String groupLifecycleEventsStatus
The current status of the group lifecycle events feature.
String groupLifecycleEventsStatusMessage
The text of any error message occurs during an attempt to turn group lifecycle events on or off.
String name
The name of the group, which is the identifier of the group in other operations. You can't change the name of a
resource group after you create it. A resource group name can consist of letters, numbers, hyphens, periods, and
underscores. The name cannot start with AWS, aws, or any other possible capitalization;
these are reserved. A resource group name must be unique within each Amazon Web Services Region in your Amazon
Web Services account.
String description
The description of the resource group. Descriptions can consist of letters, numbers, hyphens, underscores, periods, and spaces.
ResourceQuery resourceQuery
The resource query that determines which Amazon Web Services resources are members of this group. For more information about resource queries, see Create a tag-based group in Resource Groups.
A resource group can contain either a ResourceQuery or a Configuration, but not both.
Map<K,V> tags
The tags to add to the group. A tag is key-value pair string.
List<E> configuration
A configuration associates the resource group with an Amazon Web Services service and specifies how the service can interact with the resources in the group. A configuration is an array of GroupConfigurationItem elements. For details about the syntax of service configurations, see Service configurations for Resource Groups.
A resource group can contain either a Configuration or a ResourceQuery, but not both.
Group group
The description of the resource group.
ResourceQuery resourceQuery
The resource query associated with the group. For more information about resource queries, see Create a tag-based group in Resource Groups.
Map<K,V> tags
The tags associated with the group.
GroupConfiguration groupConfiguration
The service configuration associated with the resource group. For details about the syntax of a service configuration, see Service configurations for Resource Groups.
Group group
A full description of the deleted resource group.
AccountSettings accountSettings
The current settings for the optional features in Resource Groups.
String group
The name or the ARN of the resource group for which you want to retrive the service configuration.
GroupConfiguration groupConfiguration
A structure that describes the service configuration attached with the specified group. For details about the service configuration syntax, see Service configurations for Resource Groups.
GroupQuery groupQuery
The resource query associated with the specified group. For more information about resource queries, see Create a tag-based group in Resource Groups.
Group group
A structure that contains the metadata details for the specified resource group. Use GetGroupQuery and GetGroupConfiguration to get those additional details of the resource group.
String arn
The ARN of the resource group whose tags you want to retrieve.
List<E> configuration
The configuration currently associated with the group and in effect.
List<E> proposedConfiguration
If present, the new configuration that is in the process of being applied to the group.
String status
The current status of an attempt to update the group configuration.
String failureReason
If present, the reason why a request to update the group configuration failed.
String type
Specifies the type of group configuration item. Each item must have a unique value for type. For the
list of types that you can specify for a configuration item, see Supported resource
types and parameters.
List<E> parameters
A collection of parameters for this group configuration item. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.
String 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.
List<E> 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.
String groupName
The name of the resource group that is associated with the specified resource query.
ResourceQuery resourceQuery
The resource query that determines which Amazon Web Services resources are members of the associated resource group.
List<E> succeeded
A list of ARNs of the resources that this operation successfully added to the group.
List<E> failed
A list of ARNs of any resources that this operation failed to add to the group.
List<E> pending
A list of ARNs of any resources that this operation is still in the process adding to the group. These pending
additions continue asynchronously. You can check the status of pending additions by using the
ListGroupResources operation, and checking the Resources array in the response
and the Status field of each object in that array.
ResourceIdentifier identifier
ResourceStatus status
A structure that contains the status of this resource's membership in the group.
This field is present in the response only if the group is of type AWS::EC2::HostManagement.
String groupName
Deprecated - don't use this parameter. Use the Group request field instead.
String group
The name or the ARN of the resource group
List<E> filters
Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources
operation. Filters the results to include only those of the specified resource types.
resource-type - Filter resources by their type. Specify up to five resource types in the format
AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or
AWS::S3::Bucket.
When you specify a resource-type filter for ListGroupResources, Resource Groups
validates your filter resource types against the types that are defined in the query associated with the group.
For example, if a group contains only S3 buckets because its query specifies only that resource type, but your
resource-type filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances.
In this case, a ListGroupResources request returns a BadRequestException error with a
message similar to the following:
The resource types specified as filters in the request are not valid.
The error includes a list of resource types that failed the validation because they are not part of the query
associated with the group. This validation doesn't occur when the group query specifies
AWS::AllSupported, because a group based on such a query can contain any of the allowed resource
types for the query type (tag-based or Amazon CloudFront stack-based queries).
Integer maxResults
The total number of results that you want included on each page of the response. If you do not include this
parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum
you specify, the NextToken response element is present and has a value (is not null). Include that
value as the NextToken request parameter in the next call to the operation to get the next part of
the results. Note that the service might return fewer results than the maximum even when there are more results
available. You should check NextToken after every operation to ensure that you receive all of the
results.
String nextToken
The parameter for receiving additional results if you receive a NextToken response in a previous
request. A NextToken response indicates that more output is available. Set this parameter to the
value provided by a previous call's NextToken response to indicate where the output should continue
from.
List<E> resources
An array of resources from which you can determine each resource's identity, type, and group membership status.
List<E> resourceIdentifiers
Deprecated - don't use this parameter. Use the Resources response field instead.
String nextToken
If present, indicates that more output is available than is included in the current response. Use this value in
the NextToken request parameter in a subsequent call to the operation to get the next part of the
output. You should repeat this until the NextToken response element comes back as null.
List<E> queryErrors
A list of QueryError objects. Each error contains an ErrorCode and Message
. Possible values for ErrorCode are CLOUDFORMATION_STACK_INACTIVE,
CLOUDFORMATION_STACK_NOT_EXISTING, CLOUDFORMATION_STACK_UNASSUMABLE_ROLE and
RESOURCE_TYPE_NOT_SUPPORTED.
List<E> filters
Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.
resource-type - Filter the results to include only those resource groups that have the specified
resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return
any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.
configuration-type - Filter the results to include only those groups that have the specified
configuration types attached. The current supported values are:
AWS::AppRegistry::Application
AWS::AppRegistry::ApplicationResourceGroups
AWS::CloudFormation::Stack
AWS::EC2::CapacityReservationPool
AWS::EC2::HostManagement
AWS::NetworkFirewall::RuleGroup
Integer maxResults
The total number of results that you want included on each page of the response. If you do not include this
parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum
you specify, the NextToken response element is present and has a value (is not null). Include that
value as the NextToken request parameter in the next call to the operation to get the next part of
the results. Note that the service might return fewer results than the maximum even when there are more results
available. You should check NextToken after every operation to ensure that you receive all of the
results.
String nextToken
The parameter for receiving additional results if you receive a NextToken response in a previous
request. A NextToken response indicates that more output is available. Set this parameter to the
value provided by a previous call's NextToken response to indicate where the output should continue
from.
List<E> groupIdentifiers
A list of GroupIdentifier objects. Each identifier is an object that contains both the Name
and the GroupArn.
List<E> groups
Deprecated - don't use this field. Use the GroupIdentifiers response field instead.
String nextToken
If present, indicates that more output is available than is included in the current response. Use this value in
the NextToken request parameter in a subsequent call to the operation to get the next part of the
output. You should repeat this until the NextToken response element comes back as null.
String resourceArn
The Amazon resource name (ARN) of the resource that's in a pending state.
String group
The name or ARN of the resource group with the configuration that you want to update.
List<E> configuration
The new configuration to associate with the specified group. A configuration associates the resource group with an Amazon Web Services service and specifies how the service can interact with the resources in the group. A configuration is an array of GroupConfigurationItem elements.
For information about the syntax of a service configuration, see Service configurations for Resource Groups.
A resource group can contain either a Configuration or a ResourceQuery, but not both.
String 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. 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.
String 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 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 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"]}]
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 CloudFormation stack whose resources you want
included in the group.
String name
The current status.
ResourceQuery resourceQuery
The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.
Integer maxResults
The total number of results that you want included on each page of the response. If you do not include this
parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum
you specify, the NextToken response element is present and has a value (is not null). Include that
value as the NextToken request parameter in the next call to the operation to get the next part of
the results. Note that the service might return fewer results than the maximum even when there are more results
available. You should check NextToken after every operation to ensure that you receive all of the
results.
String nextToken
The parameter for receiving additional results if you receive a NextToken response in a previous
request. A NextToken response indicates that more output is available. Set this parameter to the
value provided by a previous call's NextToken response to indicate where the output should continue
from.
List<E> resourceIdentifiers
The ARNs and resource types of resources that are members of the group that you specified.
String nextToken
If present, indicates that more output is available than is included in the current response. Use this value in
the NextToken request parameter in a subsequent call to the operation to get the next part of the
output. You should repeat this until the NextToken response element comes back as null.
List<E> queryErrors
A list of QueryError objects. Each error contains an ErrorCode and Message
.
Possible values for ErrorCode:
CLOUDFORMATION_STACK_INACTIVE
CLOUDFORMATION_STACK_NOT_EXISTING
CLOUDFORMATION_STACK_UNASSUMABLE_ROLE
List<E> succeeded
A list of resources that were successfully removed from the group by this operation.
List<E> failed
A list of any resources that failed to be removed from the group by this operation.
List<E> pending
A list of any resources that are still in the process of being removed from the group by this operation. These
pending removals continue asynchronously. You can check the status of pending removals by using the
ListGroupResources operation. After the resource is successfully removed, it no longer
appears in the response.
String groupLifecycleEventsDesiredStatus
Specifies whether you want to turn group lifecycle events on or off.
AccountSettings accountSettings
A structure that displays the status of the optional features in the account.
String groupName
Don't use this parameter. Use Group instead.
String group
The name or the ARN of the resource group to query.
ResourceQuery resourceQuery
The resource query to determine which Amazon Web Services resources are members of this resource group.
A resource group can contain either a Configuration or a ResourceQuery, but not both.
GroupQuery groupQuery
The updated resource query associated with the resource group after the update.
String groupName
Don't use this parameter. Use Group instead.
String group
The name or the ARN of the resource group to modify.
String description
The new description that you want to update the resource group with. Descriptions can contain letters, numbers, hyphens, underscores, periods, and spaces.
Group group
The update description of the resource group.
Copyright © 2024. All rights reserved.