Class: Aws::ResourceGroups::Types::CreateGroupInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb

Overview

Note:

When making an API call, you may pass CreateGroupInput data as a hash:

{
  name: "GroupName", # required
  description: "Description",
  resource_query: {
    type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
    query: "Query", # required
  },
  tags: {
    "TagKey" => "TagValue",
  },
  configuration: [
    {
      type: "GroupConfigurationType", # required
      parameters: [
        {
          name: "GroupConfigurationParameterName", # required
          values: ["GroupConfigurationParameterValue"],
        },
      ],
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#configurationArray<Types::GroupConfigurationItem>

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.

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

Returns:



95
96
97
98
99
100
101
102
103
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 95

class CreateGroupInput < Struct.new(
  :name,
  :description,
  :resource_query,
  :tags,
  :configuration)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

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

Returns:

  • (String)


95
96
97
98
99
100
101
102
103
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 95

class CreateGroupInput < Struct.new(
  :name,
  :description,
  :resource_query,
  :tags,
  :configuration)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

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.

Returns:

  • (String)


95
96
97
98
99
100
101
102
103
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 95

class CreateGroupInput < Struct.new(
  :name,
  :description,
  :resource_query,
  :tags,
  :configuration)
  SENSITIVE = []
  include Aws::Structure
end

#resource_queryTypes::ResourceQuery

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

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



95
96
97
98
99
100
101
102
103
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 95

class CreateGroupInput < Struct.new(
  :name,
  :description,
  :resource_query,
  :tags,
  :configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)


95
96
97
98
99
100
101
102
103
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 95

class CreateGroupInput < Struct.new(
  :name,
  :description,
  :resource_query,
  :tags,
  :configuration)
  SENSITIVE = []
  include Aws::Structure
end