Skip to content

CreateGroupInput

Source code in docs_src/capo_resource_groups/types/create_group_input.py
class CreateGroupInput(TypedDict, closed=True):
    name: "capo_resource_groups.types.create_group_name.CreateGroupName"
    """<p>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 <code>AWS</code>, <code>aws</code>, 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.</p>"""
    description: NotRequired["capo_resource_groups.types.description.Description"]
    """<p>The description of the resource group. Descriptions can consist of letters, numbers, hyphens, underscores, periods, and spaces.</p>"""
    resource_query: NotRequired[
        "capo_resource_groups.types.resource_query.ResourceQuery"
    ]
    """<p>The resource query that determines which Amazon Web Services resources are members of this group. For more information about resource queries, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag">Create a tag-based group in Resource Groups</a>. </p> <note> <p>A resource group can contain either a <code>ResourceQuery</code> or a <code>Configuration</code>, but not both.</p> </note>"""
    tags: NotRequired["capo_resource_groups.types.tags.Tags"]
    """<p>The tags to add to the group. A tag is key-value pair string.</p>"""
    configuration: NotRequired[
        "capo_resource_groups.types.group_configuration_list.GroupConfigurationList"
    ]
    """<p>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 <a>GroupConfigurationItem</a> elements. For details about the syntax of service configurations, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html">Service configurations for Resource Groups</a>.</p> <note> <p>A resource group can contain either a <code>Configuration</code> or a <code>ResourceQuery</code>, but not both.</p> </note>"""
    criticality: NotRequired["capo_resource_groups.types.criticality.Criticality"]
    """<p>The critical rank of the application group on a scale of 1 to 10, with a rank of 1 being the most critical, and a rank of 10 being least critical.</p>"""
    owner: NotRequired["capo_resource_groups.types.owner.Owner"]
    """<p>A name, email address or other identifier for the person or group who is considered as the owner of this application group within your organization. </p>"""
    display_name: NotRequired["capo_resource_groups.types.display_name.DisplayName"]
    """<p>The name of the application group, which you can change at any time. </p>"""

configuration instance-attribute

configuration: NotRequired[GroupConfigurationList]

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.

criticality instance-attribute

criticality: NotRequired[Criticality]

The critical rank of the application group on a scale of 1 to 10, with a rank of 1 being the most critical, and a rank of 10 being least critical.

description instance-attribute

description: NotRequired[Description]

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

display_name instance-attribute

display_name: NotRequired[DisplayName]

The name of the application group, which you can change at any time.

name instance-attribute

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.

owner instance-attribute

owner: NotRequired[Owner]

A name, email address or other identifier for the person or group who is considered as the owner of this application group within your organization.

resource_query instance-attribute

resource_query: NotRequired[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 instance-attribute

tags: NotRequired[Tags]

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