resourcegroups_create_group: Creates a resource group with the specified name and...

Description Usage Arguments Value Request syntax

View source: R/resourcegroups_operations.R

Description

Creates a resource group with the specified name and description. You can optionally include a resource query, or a service configuration. For more information about constructing a resource query, see Create a tag-based group in Resource Groups. For more information about service configurations, see Service configurations for resource groups.

Minimum permissions

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

Usage

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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"
          )
        )
      )
    )
  )
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.