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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#configuration ⇒ Array<Types::GroupConfigurationItem>

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

<note markdown=“1”> A resource group can contain either a ‘Configuration` or a `ResourceQuery`, but not both.

</note>

[1]: docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html

Returns:



107
108
109
110
111
112
113
114
115
 
# File 'lib/aws-sdk-resourcegroups/types.rb', line 107

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

#description ⇒ String

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

Returns:

  • (String) 


107
108
109
110
111
112
113
114
115
 
# File 'lib/aws-sdk-resourcegroups/types.rb', line 107

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

#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`, `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.

Returns:

  • (String) 


107
108
109
110
111
112
113
114
115
 
# File 'lib/aws-sdk-resourcegroups/types.rb', line 107

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

#resource_query ⇒ Types::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].

<note markdown=“1”> A resource group can contain either a ‘ResourceQuery` or a `Configuration`, but not both.

</note>

[1]: docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag

Returns:



107
108
109
110
111
112
113
114
115
 
# File 'lib/aws-sdk-resourcegroups/types.rb', line 107

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

#tags ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


107
108
109
110
111
112
113
114
115
 
# File 'lib/aws-sdk-resourcegroups/types.rb', line 107

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