[ aws . resource-groups ]

create-group

Description

Creates a resource group with the specified name and description. You can optionally include a resource query, or a service configuration.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-group
--name <value>
[--description <value>]
[--resource-query <value>]
[--tags <value>]
[--configuration <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--name (string)

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 or aws ; these are reserved. A resource group name must be unique within each AWS Region in your AWS account.

--description (string)

The description of the resource group. Descriptions can consist of letters, numbers, hyphens, underscores, periods, and spaces.

--resource-query (structure)

The resource query that determines which AWS resources are members of this group.

Note

You can specify either a ResourceQuery or a Configuration , but not both.

Type -> (string)

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

  • *CLOUDFORMATION_STACK_1_0: * Specifies that the Query contains an ARN for a CloudFormation stack.

  • ``TAG_FILTERS_1_0:`` * Specifies that the ``Query`` parameter contains a JSON string that represents a collection of simple tag filters for resource types and tags. The JSON string uses a syntax similar to the `` `GetResources <https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html>`__ `` operation, but uses only the `` `ResourceTypeFilters <https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html#resourcegrouptagging-GetResources-request-ResourceTypeFilters>`__ `` and `` `TagFilters <https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html#resourcegrouptagging-GetResources-request-TagFiltersTagFilters>`__ `` 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 query could include the following.

    • An 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 query would not include the following items in the results, however.

  • An 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.

Query -> (string)

The query that defines a group or a search.

Shorthand Syntax:

Type=string,Query=string

JSON Syntax:

{
  "Type": "TAG_FILTERS_1_0"|"CLOUDFORMATION_STACK_1_0",
  "Query": "string"
}

--tags (map)

The tags to add to the group. A tag is key-value pair string.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--configuration (list)

A configuration associates the resource group with an AWS service and specifies how the service can interact with the resources in the group. A configuration is an array of GroupConfigurationItem elements.

Note

You can specify either a Configuration or a ResourceQuery in a group, but not both.

(structure)

An item in a group configuration. A group configuration can have one or more items.

Type -> (string)

Specifies the type of group configuration item. Each item must have a unique value for type .

You can specify the following string values:

  • AWS::EC2::CapacityReservationPool For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2 Users Guide .

  • AWS::ResourceGroups::Generic - Supports parameters that configure the behavior of resource groups of any type.

Parameters -> (list)

A collection of parameters for this group configuration item.

(structure)

A parameter for a group configuration item.

Name -> (string)

The name of the group configuration parameter.

You can specify the following string values:

  • For configuration item type AWS::ResourceGroups::Generic :

    • allowed-resource-types Specifies the types of resources that you can add to this group by using the GroupResources operation.

  • For configuration item type AWS::EC2::CapacityReservationPool :

    • None - This configuration item type doesn’t support any parameters.

For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2 Users Guide .

Values -> (list)

The values of for this parameter.

You can specify the following string value:

  • For item type allowed-resource-types : the only supported parameter value is AWS::EC2::CapacityReservation .

(string)

JSON Syntax:

[
  {
    "Type": "string",
    "Parameters": [
      {
        "Name": "string",
        "Values": ["string", ...]
      }
      ...
    ]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

Example 1: To create a tag-based resource group

The following create-group example creates a tag-based resource group of Amazon EC2 instances in the current region. It’s based on a query for resources that are tagged with the key Name, and the value WebServers. The group name is tbq-WebServer. The query is in a separate JSON file that is passed to the command.

aws resource-groups create-group \
    --name tbq-WebServer \
    --resource-query file://query.json

Contents of query.json:

{
    "Type": "TAG_FILTERS_1_0",
    "Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}"
}

Output:

{
    "Group": {
        "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer",
        "Name": "tbq-WebServer"
    },
    "ResourceQuery": {
        "Type": "TAG_FILTERS_1_0",
        "Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}"
    }
}

Example 2: To create a CloudFormation stack-based resource group

The following create-group example creates an AWS CloudFormation stack-based resource group named sampleCFNstackgroup. The query includes all resources in the specified CloudFormation stack that are supported by AWS Resource Groups.

aws resource-groups create-group \
    --name cbq-CFNstackgroup \
    --resource-query file://query.json

Contents of query.json:

{
    "Type": "CLOUDFORMATION_STACK_1_0",
    "Query": "{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"StackIdentifier\":\"arn:aws:cloudformation:us-west-2:123456789012:stack/MyCFNStack/1415z9z0-z39z-11z8-97z5-500z212zz6fz\"}"
}

Output:

{
    "Group": {
        "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/cbq-CFNstackgroup",
        "Name": "cbq-CFNstackgroup"
    },
    "ResourceQuery": {
        "Type": "CLOUDFORMATION_STACK_1_0",
        "Query": "{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"StackIdentifier\":\"arn:aws:cloudformation:us-east-2:123456789012:stack/MyCFNStack/1415z9z0-z39z-11z8-97z5-500z212zz6fz\"}"}'
    }
}

For more information, see Create Groups in the AWS Resource Groups User Guide.

Output

Group -> (structure)

The description of the resource group.

GroupArn -> (string)

The ARN of the resource group.

Name -> (string)

The name of the resource group.

Description -> (string)

The description of the resource group.

ResourceQuery -> (structure)

The resource query associated with the group.

Type -> (string)

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

  • *CLOUDFORMATION_STACK_1_0: * Specifies that the Query contains an ARN for a CloudFormation stack.

  • ``TAG_FILTERS_1_0:`` * Specifies that the ``Query`` parameter contains a JSON string that represents a collection of simple tag filters for resource types and tags. The JSON string uses a syntax similar to the `` `GetResources <https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html>`__ `` operation, but uses only the `` `ResourceTypeFilters <https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html#resourcegrouptagging-GetResources-request-ResourceTypeFilters>`__ `` and `` `TagFilters <https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html#resourcegrouptagging-GetResources-request-TagFiltersTagFilters>`__ `` 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 query could include the following.

    • An 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 query would not include the following items in the results, however.

  • An 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.

Query -> (string)

The query that defines a group or a search.

Tags -> (map)

The tags associated with the group.

key -> (string)

value -> (string)

GroupConfiguration -> (structure)

The service configuration associated with the resource group. AWS Resource Groups supports adding service configurations for the following resource group types:

Configuration -> (list)

The configuration currently associated with the group and in effect.

(structure)

An item in a group configuration. A group configuration can have one or more items.

Type -> (string)

Specifies the type of group configuration item. Each item must have a unique value for type .

You can specify the following string values:

  • AWS::EC2::CapacityReservationPool For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2 Users Guide .

  • AWS::ResourceGroups::Generic - Supports parameters that configure the behavior of resource groups of any type.

Parameters -> (list)

A collection of parameters for this group configuration item.

(structure)

A parameter for a group configuration item.

Name -> (string)

The name of the group configuration parameter.

You can specify the following string values:

  • For configuration item type AWS::ResourceGroups::Generic :

    • allowed-resource-types Specifies the types of resources that you can add to this group by using the GroupResources operation.

  • For configuration item type AWS::EC2::CapacityReservationPool :

    • None - This configuration item type doesn’t support any parameters.

For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2 Users Guide .

Values -> (list)

The values of for this parameter.

You can specify the following string value:

  • For item type allowed-resource-types : the only supported parameter value is AWS::EC2::CapacityReservation .

(string)

ProposedConfiguration -> (list)

If present, the new configuration that is in the process of being applied to the group.

(structure)

An item in a group configuration. A group configuration can have one or more items.

Type -> (string)

Specifies the type of group configuration item. Each item must have a unique value for type .

You can specify the following string values:

  • AWS::EC2::CapacityReservationPool For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2 Users Guide .

  • AWS::ResourceGroups::Generic - Supports parameters that configure the behavior of resource groups of any type.

Parameters -> (list)

A collection of parameters for this group configuration item.

(structure)

A parameter for a group configuration item.

Name -> (string)

The name of the group configuration parameter.

You can specify the following string values:

  • For configuration item type AWS::ResourceGroups::Generic :

    • allowed-resource-types Specifies the types of resources that you can add to this group by using the GroupResources operation.

  • For configuration item type AWS::EC2::CapacityReservationPool :

    • None - This configuration item type doesn’t support any parameters.

For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2 Users Guide .

Values -> (list)

The values of for this parameter.

You can specify the following string value:

  • For item type allowed-resource-types : the only supported parameter value is AWS::EC2::CapacityReservation .

(string)

Status -> (string)

The current status of an attempt to update the group configuration.

FailureReason -> (string)

If present, the reason why a request to update the group configuration failed.