Skip to content

Create Group

resourcegroups_create_group R Documentation

Creates a resource group with the specified name and description

Description

Creates a resource group with the specified name and description. You can optionally include either a resource query or a service configuration. For more information about constructing a resource query, see Build queries and groups in Resource Groups in the Resource Groups User Guide. For more information about service-linked groups and service configurations, see Service configurations for Resource Groups.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:CreateGroup

Usage

resourcegroups_create_group(Name, Description, ResourceQuery, Tags,
  Configuration)

Arguments

Name

[required] 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.

Description

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

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.

Tags

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

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.

Value

A list with the following syntax:

list(
  Group = list(
    GroupArn = "string",
    Name = "string",
    Description = "string"
  ),
  ResourceQuery = list(
    Type = "TAG_FILTERS_1_0"|"CLOUDFORMATION_STACK_1_0",
    Query = "string"
  ),
  Tags = list(
    "string"
  ),
  GroupConfiguration = list(
    Configuration = list(
      list(
        Type = "string",
        Parameters = list(
          list(
            Name = "string",
            Values = list(
              "string"
            )
          )
        )
      )
    ),
    ProposedConfiguration = list(
      list(
        Type = "string",
        Parameters = list(
          list(
            Name = "string",
            Values = list(
              "string"
            )
          )
        )
      )
    ),
    Status = "UPDATING"|"UPDATE_COMPLETE"|"UPDATE_FAILED",
    FailureReason = "string"
  )
)

Request syntax

svc$create_group(
  Name = "string",
  Description = "string",
  ResourceQuery = list(
    Type = "TAG_FILTERS_1_0"|"CLOUDFORMATION_STACK_1_0",
    Query = "string"
  ),
  Tags = list(
    "string"
  ),
  Configuration = list(
    list(
      Type = "string",
      Parameters = list(
        list(
          Name = "string",
          Values = list(
            "string"
          )
        )
      )
    )
  )
)