Amazonka.ResourceGroups.CreateGroup

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:

• resource-groups:CreateGroup

Creating a Request

data CreateGroup

See: newCreateGroup smart constructor.

Constructors

CreateGroup'

Fields

• configuration :: Maybe [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. 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.

• description :: Maybe Text

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

• resourceQuery :: Maybe 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 :: Maybe (HashMap Text Text)

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

• name :: Text

  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.

Instances

ToJSON CreateGroup

Defined in Amazonka.ResourceGroups.CreateGroup

Methods

toJSON :: CreateGroup -> Value

toEncoding :: CreateGroup -> Encoding

toJSONList :: [CreateGroup] -> Value

toEncodingList :: [CreateGroup] -> Encoding

ToHeaders CreateGroup

Defined in Amazonka.ResourceGroups.CreateGroup

Methods

toHeaders :: CreateGroup -> [Header]

ToPath CreateGroup

Defined in Amazonka.ResourceGroups.CreateGroup

Methods

toPath :: CreateGroup -> ByteString

ToQuery CreateGroup

Defined in Amazonka.ResourceGroups.CreateGroup

Methods

toQuery :: CreateGroup -> QueryString

AWSRequest CreateGroup

Defined in Amazonka.ResourceGroups.CreateGroup

Associated Types

type AWSResponse CreateGroup

Methods

request :: (Service -> Service) -> CreateGroup -> Request CreateGroup

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateGroup)))

Generic CreateGroup

Defined in Amazonka.ResourceGroups.CreateGroup

Associated Types

type Rep CreateGroup :: Type -> Type

Methods

from :: CreateGroup -> Rep CreateGroup x

to :: Rep CreateGroup x -> CreateGroup

Read CreateGroup

Defined in Amazonka.ResourceGroups.CreateGroup

Methods

readsPrec :: Int -> ReadS CreateGroup

readList :: ReadS [CreateGroup]

readPrec :: ReadPrec CreateGroup

readListPrec :: ReadPrec [CreateGroup]

Show CreateGroup

Defined in Amazonka.ResourceGroups.CreateGroup

Methods

showsPrec :: Int -> CreateGroup -> ShowS

show :: CreateGroup -> String

showList :: [CreateGroup] -> ShowS

NFData CreateGroup

Defined in Amazonka.ResourceGroups.CreateGroup

Methods

rnf :: CreateGroup -> ()

Eq CreateGroup

Defined in Amazonka.ResourceGroups.CreateGroup

Methods

(==) :: CreateGroup -> CreateGroup -> Bool

(/=) :: CreateGroup -> CreateGroup -> Bool

Hashable CreateGroup

Defined in Amazonka.ResourceGroups.CreateGroup

Methods

hashWithSalt :: Int -> CreateGroup -> Int

hash :: CreateGroup -> Int

type AWSResponse CreateGroup

Defined in Amazonka.ResourceGroups.CreateGroup

type AWSResponse CreateGroup = CreateGroupResponse

type Rep CreateGroup

Defined in Amazonka.ResourceGroups.CreateGroup

type Rep CreateGroup = D1 ('MetaData "CreateGroup" "Amazonka.ResourceGroups.CreateGroup" "amazonka-resourcegroups-2.0-B1PbpVYkdAmDCiu1dJFqfU" 'False) (C1 ('MetaCons "CreateGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GroupConfigurationItem])) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "resourceQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceQuery)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateGroup

Arguments

:: Text

CreateGroup

-> CreateGroup

Create a value of CreateGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateGroup, createGroup_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.

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

CreateGroup, createGroup_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.

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

CreateGroup, createGroup_name - 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.

Request Lenses

createGroup_configuration :: Lens' CreateGroup (Maybe [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. 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.

createGroup_description :: Lens' CreateGroup (Maybe Text)

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

createGroup_resourceQuery :: Lens' CreateGroup (Maybe 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.

createGroup_tags :: Lens' CreateGroup (Maybe (HashMap Text Text))

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

createGroup_name :: Lens' CreateGroup Text

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.

Destructuring the Response

data CreateGroupResponse

See: newCreateGroupResponse smart constructor.

Constructors

CreateGroupResponse'

Fields

• group' :: Maybe Group

  The description of the resource group.

• groupConfiguration :: Maybe GroupConfiguration

  The service configuration associated with the resource group. For details about the syntax of a service configuration, see Service configurations for resource groups.

• resourceQuery :: Maybe ResourceQuery

  The resource query associated with the group. For more information about resource queries, see Create a tag-based group in Resource Groups.

• tags :: Maybe (HashMap Text Text)

  The tags associated with the group.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateGroupResponse

Defined in Amazonka.ResourceGroups.CreateGroup

Associated Types

type Rep CreateGroupResponse :: Type -> Type

Methods

from :: CreateGroupResponse -> Rep CreateGroupResponse x

to :: Rep CreateGroupResponse x -> CreateGroupResponse

Read CreateGroupResponse

Defined in Amazonka.ResourceGroups.CreateGroup

Methods

readsPrec :: Int -> ReadS CreateGroupResponse

readList :: ReadS [CreateGroupResponse]

readPrec :: ReadPrec CreateGroupResponse

readListPrec :: ReadPrec [CreateGroupResponse]

Show CreateGroupResponse

Defined in Amazonka.ResourceGroups.CreateGroup

Methods

showsPrec :: Int -> CreateGroupResponse -> ShowS

show :: CreateGroupResponse -> String

showList :: [CreateGroupResponse] -> ShowS

NFData CreateGroupResponse

Defined in Amazonka.ResourceGroups.CreateGroup

Methods

rnf :: CreateGroupResponse -> ()

Eq CreateGroupResponse

Defined in Amazonka.ResourceGroups.CreateGroup

Methods

(==) :: CreateGroupResponse -> CreateGroupResponse -> Bool

(/=) :: CreateGroupResponse -> CreateGroupResponse -> Bool

type Rep CreateGroupResponse

Defined in Amazonka.ResourceGroups.CreateGroup

type Rep CreateGroupResponse = D1 ('MetaData "CreateGroupResponse" "Amazonka.ResourceGroups.CreateGroup" "amazonka-resourcegroups-2.0-B1PbpVYkdAmDCiu1dJFqfU" 'False) (C1 ('MetaCons "CreateGroupResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "group'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Group)) :*: S1 ('MetaSel ('Just "groupConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GroupConfiguration))) :*: (S1 ('MetaSel ('Just "resourceQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceQuery)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateGroupResponse

Arguments

:: Int

$sel:httpStatus:CreateGroupResponse'

-> CreateGroupResponse

Create a value of CreateGroupResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:group':CreateGroupResponse', createGroupResponse_group - The description of the resource group.

$sel:groupConfiguration:CreateGroupResponse', createGroupResponse_groupConfiguration - The service configuration associated with the resource group. For details about the syntax of a service configuration, see Service configurations for resource groups.

CreateGroup, createGroupResponse_resourceQuery - The resource query associated with the group. For more information about resource queries, see Create a tag-based group in Resource Groups.

CreateGroup, createGroupResponse_tags - The tags associated with the group.

$sel:httpStatus:CreateGroupResponse', createGroupResponse_httpStatus - The response's http status code.

Response Lenses

createGroupResponse_group :: Lens' CreateGroupResponse (Maybe Group)

The description of the resource group.

createGroupResponse_groupConfiguration :: Lens' CreateGroupResponse (Maybe GroupConfiguration)

The service configuration associated with the resource group. For details about the syntax of a service configuration, see Service configurations for resource groups.

createGroupResponse_resourceQuery :: Lens' CreateGroupResponse (Maybe ResourceQuery)

The resource query associated with the group. For more information about resource queries, see Create a tag-based group in Resource Groups.

createGroupResponse_tags :: Lens' CreateGroupResponse (Maybe (HashMap Text Text))

The tags associated with the group.

createGroupResponse_httpStatus :: Lens' CreateGroupResponse Int

The response's http status code.