View a markdown version of this page

Types de configuration et paramètres pris en charge - Groupes de ressources AWS

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Types de configuration et paramètres pris en charge

Resource Groups prend en charge l'utilisation des types de configuration suivants. Chaque type de configuration possède un ensemble de paramètres valides pour ce type.

AWS::ResourceGroups: :Générique

Ce type de configuration spécifie des paramètres qui imposent des exigences d'appartenance au groupe de ressources, plutôt que de configurer le comportement d'un type de ressource spécifique pour un AWS service. Ce type de configuration est automatiquement ajouté par les groupes liés aux services qui en ont besoin, tels que les types AWS::EC2::CapacityReservationPool etAWS::EC2::HostManagment.

Les informations suivantes Parameters sont valides pour le groupe AWS::ResourceGroups::Generic lié aux services. Type

  • allowed-resource-types

    Ce paramètre indique que le groupe de ressources peut être composé de ressources du type ou des types spécifiés uniquement.

    Type de données des valeurs : chaîne

    Valeurs autorisées :

    • AWS::EC2::Host— Un Configuration avec ce paramètre et cette valeur est requis lorsque la configuration du service contient également un type Configuration ofAWS::EC2::HostManagement. Cela garantit que le HostManagement groupe ne peut contenir que des hôtes dédiés Amazon EC2.

    • AWS::EC2::CapacityReservation— Un Configuration avec ce paramètre et cette valeur est requis lorsque la configuration du service contient également un Configuration élément de typeAWS::EC2::CapacityReservationPool. Cela garantit qu'un CapacityReservation groupe ne peut contenir que la capacité de réservation de capacité Amazon EC2.

    Obligatoire : conditionnel, basé sur d'autres Configuration éléments attachés au groupe de ressources. Consultez l'entrée précédente pour les valeurs autorisées.

    L'exemple suivant limite les membres du groupe aux seules instances hôtes Amazon EC2.

    [ { "Type": "AWS::ResourceGroups::Generic", "Parameters": [ { "Name": "allowed-resource-types", "Values": [ "AWS::EC2::Host" ] } ] } ]
  • deletion-protection

    Ce paramètre indique que le groupe de ressources ne peut être supprimé que s'il ne contient aucun membre. Pour plus d'informations, voir Supprimer un groupe de ressources hôte dans le Guide de l'utilisateur du License Manager

    Type de données des valeurs : Tableau de chaînes

    Valeurs autorisées : La seule valeur autorisée est [ "UNLESS_EMPTY" ] (la valeur doit être en majuscules).

    Obligatoire : conditionnel, basé sur d'autres Configuration éléments attachés au groupe de ressources. Ce paramètre est obligatoire uniquement lorsque le groupe de ressources possède également un autre Configuration élément avec la valeur Type deAWS::EC2::HostManagement.

    L'exemple suivant active la protection contre la suppression pour le groupe, sauf si celui-ci ne compte aucun membre.

    [ { "Type": "AWS::ResourceGroups::Generic", "Parameters": [ { "Name": "deletion-protection", "Values": [ "UNLESS_EMPTY" ] } ] } ]

AWS::AppRegistry: :Candidature

Ce Configuration type indique que le groupe de ressources représente une application créée par AWS Service Catalog AppRegistry.

Les groupes de ressources de ce type sont entièrement gérés par le AppRegistry service et ne peuvent pas être créés, mis à jour ou supprimés par les utilisateurs autrement qu'à l'aide des outils fournis par AppRegistry.

Note

Étant donné que les groupes de ressources de ce type sont automatiquement créés et gérés par l'utilisateur AWS et ne sont pas gérés par lui, ces groupes de ressources ne sont pas pris en compte dans votre quota pour le nombre maximum de groupes de ressources que vous pouvez créer dans votre Compte AWS.

Pour plus d'informations, consultez le guide AppRegistry d'utilisation du catalogue de services.

Lorsque vous AppRegistry créez un groupe de ressources lié à un service de ce type, il crée également automatiquement un groupe CloudFormation lié à un service supplémentaire distinct pour chaque AWS CloudFormation pile associée à l'application.

AppRegistry nomme automatiquement les groupes liés aux services de ce type qu'il crée avec le préfixe AWS_AppRegistry_Application- suivi du nom de l'application : AWS_AppRegistry_Application-MyAppName

Les paramètres suivants sont pris en charge pour le type de groupe AWS::AppRegistry::Application lié à un service.

  • Name

    Ce paramètre spécifie le nom convivial de l'application qui a été attribué par l'utilisateur lors de sa création dans AppRegistry.

    Type de données des valeurs : chaîne

    Valeurs autorisées : toute chaîne de texte autorisée par le AppRegistry service pour le nom d'une application.

    Obligatoire : oui

  • Arn

    Ce paramètre spécifie le chemin Amazon Resource Name (ARN) de l'application attribuée par AppRegistry.

    Type de données des valeurs : chaîne

    Valeurs autorisées : un ARN valide.

    Obligatoire : oui

Note

Pour modifier l'un de ces éléments, vous devez modifier l'application à l'aide de la AppRegistry console ou du AWS SDK et des AWS CLI opérations de ce service.

Ce groupe de ressources d'application inclut automatiquement en tant que membres du groupe les groupes de ressources créés pour les CloudFormation piles associées à l' AppRegistry application. Vous pouvez utiliser cette ListGroupResources opération pour voir ces groupes d'enfants.

L'exemple suivant montre à quoi ressemble la section de configuration d'un groupe AWS::AppRegistry::Application lié à un service.

[ { "Type": "AWS::AppRegistry::Application", "Parameters": [ { "Name": "Name", "Values": [ "MyApplication" ] }, { "Name": "Arn", "Values": [ "arn:aws:servicecatalog:us-east-1:123456789012:/applications/<application-id>" ] } ] } ]

AWS::CloudFormation: :Pile

Ce Configuration type indique que le groupe représente une AWS CloudFormation pile et que ses membres sont les AWS ressources créées par cette pile.

Les groupes de ressources de ce type sont automatiquement créés pour vous lorsque vous CloudFormation associez une pile au AppRegistry service. Vous ne pouvez pas créer, mettre à jour ou supprimer ces groupes, sauf à l'aide des outils fournis par AppRegistry.

AppRegistry nomme automatiquement les groupes liés aux services de ce type qu'il crée avec le préfixe AWS_CloudFormation_Stack- suivi du nom de la pile : AWS_CloudFormation_Stack-MyStackName

Note

Étant donné que les groupes de ressources de ce type sont automatiquement créés et gérés par l'utilisateur AWS et ne sont pas gérés par lui, ces groupes de ressources ne sont pas pris en compte dans votre quota pour le nombre maximum de groupes de ressources que vous pouvez créer dans votre Compte AWS.

Pour plus d'informations, consultez le guide AppRegistry d'utilisation du catalogue de services.

AppRegistry crée automatiquement un groupe de ressources lié à un service de ce type pour chaque CloudFormation pile que vous associez à l' AppRegistry application. Ces groupes de ressources deviennent des membres enfants du groupe de ressources parent de l' AppRegistryapplication.

Les membres de ce groupe de CloudFormation ressources sont les AWS ressources créées dans le cadre de la pile.

Les paramètres suivants sont pris en charge pour le type de groupe AWS::CloudFormation::Stack lié à un service.

  • Name

    Ce paramètre spécifie le nom convivial de la CloudFormation pile attribué par l'utilisateur lors de sa création.

    Type de données des valeurs : chaîne

    Valeurs autorisées : toute chaîne de texte autorisée par le CloudFormation service pour un nom de pile.

    Obligatoire : oui

  • Arn

    Ce paramètre spécifie le chemin Amazon Resource Name (ARN) de la CloudFormation pile attachée à l'application dans AppRegistry.

    Type de données des valeurs : chaîne

    Valeurs autorisées : un ARN valide.

    Obligatoire : oui

Note

Pour modifier l'un de ces éléments, vous devez modifier l'application à l'aide de la AppRegistry console ou d'un AWS SDK et d' AWS CLI opérations équivalents.

L'exemple suivant montre à quoi ressemble la section de configuration d'un groupe AWS::CloudFormation::Stack lié à un service.

[ { "Type": "AWS::CloudFormation::Stack", "Parameters": [ { "Name": "Name", "Values": [ "MyStack" ] }, { "Name": "Arn", "Values": [ "arn:aws:cloudformation:us-east-1:123456789012:stack/MyStack/<stack-id>" ] } ] } ]

AWS : :EC2 : : CapacityReservationPool

Ce Configuration type indique que le groupe de ressources représente un pool commun de capacités fourni par les membres du groupe. Les membres de ce groupe de ressources doivent être des réservations de capacité Amazon EC2. Un groupe de ressources peut inclure à la fois des réservations de capacité que vous possédez sur votre compte et des réservations de capacité qui sont partagées avec vous depuis d'autres comptes en utilisant AWS Resource Access Manager. Cela vous permet de lancer une instance Amazon EC2 en utilisant ce groupe de ressources comme valeur pour le paramètre de réservation de capacité. Dans ce cas, l'instance utilise la capacité réservée disponible dans le groupe.

Si le groupe de ressources n'a aucune capacité disponible, l'instance est lancée en tant qu'instance autonome à la demande en dehors du pool, sauf si vous configurez le groupe de ressources pour utiliser les blocs de UltraServer capacité Amazon EC2. Pour plus d'informations, consultez la section Utilisation des groupes de réservation de capacité dans le guide de l'utilisateur Amazon EC2.

Si vous configurez un groupe de ressources lié à un service avec un Configuration élément de ce type, vous devez également spécifier des Configuration éléments distincts avec les valeurs suivantes :

  • N'importe AWS::ResourceGroups::Generic quel type avec un seul paramètre :

    • Le paramètre allowed-resource-types et une valeur unique deAWS::EC2::CapacityReservation. Cela garantit que seules les réservations de capacité Amazon EC2 peuvent être membres du groupe de ressources.

  • Un AWS::EC2::CapacityReservationPool type avec deux paramètres :

    • reservation-type— Nécessaire uniquement lorsque vous configurez un groupe de réservation de capacité pour les blocs de UltraServer capacité Amazon EC2. La seule valeur autorisée dans ce champ estcapacity-block.

    • instance-type— Nécessaire uniquement lorsque vous configurez un groupe de réservation de capacité pour les blocs de UltraServer capacité Amazon EC2. Les valeurs autorisées dans ce champ sont trn2u.48xlarge etp6e-gb200.36xlarge.

L'exemple suivant montre la Configuration section d'une réservation On-Demand de capacité :

{ "Configuration": [ { "Type": "AWS::EC2::CapacityReservationPool", "Parameters": [] }, { "Type": "AWS::ResourceGroups::Generic", "Parameters": [ { "Name": "allowed-resource-types", "Values": [ "AWS::EC2::CapacityReservation" ] } ] } ] }

L'exemple suivant montre la Configuration section prenant en charge les blocs de UltraServer capacité Amazon EC2 :

{ "Configuration": [ { "Type": "AWS::EC2::CapacityReservationPool", "Parameters": [ { "Name": "instance-type", "Values": [ "trn2u.48xlarge" ] }, { "Name": "reservation-type", "Values": [ "capacity-block" ] } ] }, { "Type": "AWS::ResourceGroups::Generic", "Parameters": [ { "Name": "allowed-resource-types", "Values": [ "AWS::EC2::CapacityReservation" ] } ] } ] }

Après avoir ajouté instance-type et reservation-type à la configuration d'un groupe de ressources lorsque vous utilisez des blocs de UltraServer capacité Amazon EC2, les comportements suivants s'appliquent à ce groupe de ressources :

  • Vous pouvez ajouter des réservations de capacité supplémentaires dans cette configuration de groupe de ressources, mais les reservation-type réservations supplémentaires doivent également être instance-type définies sur capacity-block et sur trn2u.48xlarge oup6e-gb200.48xlarge.

  • Actuellement, la seule valeur autorisée pour reservation-type estcapacity-block, et les seules valeurs autorisées pour instance-type sont trn2u.48xlarge et. p6e-gb200.48xlarge

  • Vous ne pouvez pas ajouter Amazon EC2 Capacity Blocks for ML dans un groupe de ressources qui n'inclut pas les instance-type configurations reservation-type et.

  • L'ajout des paramètres reservation-type et capacity-block de configuration ne modifie pas le processus d'ajout ou de suppression des réservations de groupe.

  • Si vous supprimez la réservation de capacité du groupe, ou si vous supprimez le groupe, les réservations au sein du groupe restent utilisées jusqu'à ce que les instances soient résiliées.

  • Actuellement, les groupes de ressources dotés des paramètres instance-type de configuration reservation-type et ne peuvent pas être mis à jour après la configuration initiale. Pour modifier ou supprimer la configuration, vous devez supprimer le groupe, puis créer un nouveau groupe avec de nouvelles configurations.

  • Vous ne pouvez pas lancer une instance dans un groupe vide ni modifier une instance pour cibler un groupe vide.

AWS : :EC2 : : HostManagement

Cet identifiant spécifie les paramètres de gestion des hôtes Amazon EC2 AWS License Manager qui sont appliqués aux membres du groupe. Pour plus d'informations, voir Héberger des groupes de ressources dans AWS License Manager.

Si vous configurez un groupe de ressources lié à un service avec un Configuration élément de ce type, vous devez également spécifier des Configuration éléments distincts avec les valeurs suivantes :

  • Un AWS::ResourceGroups::Generic type, avec un paramètre de allowed-resource-types et une valeur unique deAWS::EC2::Host. Cela garantit que seuls les hôtes dédiés Amazon EC2 peuvent être membres du groupe.

  • Un AWS::ResourceGroups::Generic type, avec un paramètre de deletion-protection et une valeur unique deUNLESS_EMPTY. Cela garantit que le groupe ne peut pas être supprimé à moins qu'il ne soit vide.

Les paramètres suivants sont pris en charge pour le type de groupe AWS::EC2::HostManagement lié à un service.

  • auto-allocate-host

    Ce paramètre indique si les instances sont lancées sur un hôte dédié spécifique ou sur un hôte disponible doté d'une configuration correspondante. Pour plus d'informations, reportez-vous à la section Présentation du placement automatique et de l'affinité dans le Guide de l'utilisateur Amazon EC2.

    Type de données des valeurs : booléen

    Valeurs autorisées : « vrai » ou « faux » (doit être en minuscules).

    Obligatoire : non

    [ { "Type": "AWS::EC2::HostManagement", "Parameters": [ { "Name": "auto-allocate-host", "Values": [ "true" ] }, { "Name": "any-host-based-license-configuration", "Values": [ "true" ] } ] }, { "Type": "AWS::ResourceGroups::Generic", "Parameters": [ { "Name": "allowed-resource-types", "Values": [ "AWS::EC2::Host" ] }, { "Name": "deletion-protection", "Values": [ "UNLESS_EMPTY" ] } ] } ]
  • auto-release-host

    Ce paramètre indique si un hôte dédié du groupe est automatiquement libéré après l'arrêt de sa dernière instance en cours d'exécution. Pour plus d'informations, consultez la section Déploiement d'hôtes dédiés dans le guide de l'utilisateur Amazon EC2.

    Type de données des valeurs : booléen

    Valeurs autorisées : « vrai » ou « faux » (doit être en minuscules).

    Obligatoire : non

    [ { "Type": "AWS::EC2::HostManagement", "Parameters": [ { "Name": "auto-release-host", "Values": [ "false" ] }, { "Name": "any-host-based-license-configuration", "Values": [ "true" ] } ] }, { "Type": "AWS::ResourceGroups::Generic", "Parameters": [ { "Name": "allowed-resource-types", "Values": [ "AWS::EC2::Host" ] }, { "Name": "deletion-protection", "Values": [ "UNLESS_EMPTY" ] } ] } ]
  • allowed-host-families

    Ce paramètre spécifie quelles familles de types d'instances peuvent être utilisées par les instances membres de ce groupe.

    Type de données des valeurs : tableau de chaînes.

    Valeurs autorisées : chacune doit être un identifiant de famille de type d'instance Amazon EC2 valide, tel queC4, M5P3dn, ouR5d.

    Obligatoire : non

    L'exemple d'élément de configuration suivant indique que les instances lancées peuvent appartenir uniquement aux familles de types d'instances C5 ou M5.

    [ { "Type": "AWS::EC2::HostManagement", "Parameters": [ { "Name": "allowed-host-families", "Values": [ "c5", "m5" ] }, { "Name": "any-host-based-license-configuration", "Values": [ "true" ] } ] }, { "Type": "AWS::ResourceGroups::Generic", "Parameters": [ { "Name": "allowed-resource-types", "Values": [ "AWS::EC2::Host" ] }, { "Name": "deletion-protection", "Values": [ "UNLESS_EMPTY" ] } ] } ]
  • allowed-host-based-license-configurations

    Ce paramètre spécifie les chemins Amazon Resource Name (ARN) d'une ou de plusieurs configurations de licence core/socket basées que vous souhaitez appliquer aux membres du groupe.

    Type de données des valeurs : tableau d'ARN.

    Valeurs autorisées : chacune doit correspondre à un ARN de configuration License Manager valide.

    Obligatoire : selon les conditions. Vous devez spécifier ce paramètre ou les deuxany-host-based-license-configuration, mais pas les deux. Elles s'excluent mutuellement.

    L'exemple d'élément de configuration suivant indique que les membres du groupe peuvent utiliser les deux configurations du gestionnaire de licences spécifiées.

    [ { "Type": "AWS::EC2::HostManagement", "Parameters": [ { "Name": "allowed-host-based-license-configurations", "Values": [ "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba41EXAMPLE1111", "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-8a786a26f50ba416eb658EXAMPLE2222" ] } ] }, { "Type": "AWS::ResourceGroups::Generic", "Parameters": [ { "Name": "allowed-resource-types", "Values": [ "AWS::EC2::Host" ] }, { "Name": "deletion-protection", "Values": [ "UNLESS_EMPTY" ] } ] } ]
  • any-host-based-license-configuration

    Ce paramètre indique que vous ne souhaitez pas associer de configuration de licence spécifique à votre groupe. Dans ce cas, toutes les configurations de licence core/socket basées sont disponibles pour les membres de votre groupe de ressources hôtes. Utilisez ce paramètre si vous disposez d'un nombre illimité de licences et que vous souhaitez optimiser l'utilisation de l'hôte.

    Type de données des valeurs : booléen

    Valeurs autorisées : « vrai » ou « faux » (doit être en minuscules).

    Obligatoire : selon les conditions. Vous devez spécifier ce paramètre ou les deuxallowed-host-based-license-configurations, mais pas les deux. Elles s'excluent mutuellement.

    L'exemple d'élément de configuration suivant indique que les membres du groupe peuvent utiliser n'importe quelle configuration de licence core/socket basée.

    [ { "Type": "AWS::EC2::HostManagement", "Parameters": [ { "Name": "any-host-based-license-configuration", "Values": [ "true" ] } ] }, { "Type": "AWS::ResourceGroups::Generic", "Parameters": [ { "Name": "allowed-resource-types", "Values": [ "AWS::EC2::Host" ] }, { "Name": "deletion-protection", "Values": [ "UNLESS_EMPTY" ] } ] } ]

L'exemple suivant montre comment inclure tous les paramètres de gestion de l'hôte dans une seule configuration.

[ { "Type": "AWS::EC2::HostManagement", "Parameters": [ { "Name": "auto-allocate-host", "Values": [ "true" ] }, { "Name": "auto-release-host", "Values": [ "false" ] }, { "Name": "allowed-host-families", "Values": [ "c5", "m5" ] }, { "Name": "allowed-host-based-license-configurations", "Values": [ "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba41EXAMPLE1111", "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-8a786a26f50ba416eb658EXAMPLE2222" ] } ] }, { "Type": "AWS::ResourceGroups::Generic", "Parameters": [ { "Name": "allowed-resource-types", "Values": [ "AWS::EC2::Host" ] }, { "Name": "deletion-protection", "Values": [ "UNLESS_EMPTY" ] } ] } ]

AWS::NetworkFirewall::RuleGroup

Cet identifiant spécifie les paramètres des groupes de AWS Network Firewall règles qui sont appliqués aux membres du groupe. Les administrateurs de pare-feu peuvent spécifier l'ARN d'un groupe de ressources de ce type afin de résoudre automatiquement les adresses IP des membres du groupe pour une règle de pare-feu au lieu d'avoir à répertorier chaque adresse manuellement. Pour plus d'informations, consultez la section Utilisation de groupes de ressources basés sur des balises dans AWS Network Firewall.

Vous pouvez créer des groupes de ressources de ce type de configuration à l'aide de la console Network Firewall ou en exécutant une AWS CLI commande ou une opération du AWS SDK.

Les groupes de ressources de ce type de configuration sont soumis aux restrictions suivantes :

  • Les membres du groupe se composent uniquement de ressources dont le type est pris en charge par Network Firewall.

  • Le groupe doit contenir une requête basée sur des balises pour gérer les membres du groupe ; toutes les ressources dont les types sont pris en charge et dont les balises correspondent à la requête sont automatiquement membres du groupe.

  • Ce type de configuration n'est pas Parameters pris en charge.

  • Pour supprimer un groupe de ressources de ce type de configuration, aucun groupe de règles de pare-feu réseau ne peut le référencer.

L'exemple suivant illustre les ResourceQuery sections Configuration et d'un groupe de ce type.

{ "Configuration": [ { "Type": "AWS::NetworkFirewall::RuleGroup", "Parameters": [] } ], "ResourceQuery": { "Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"environment\",\"Values\":[\"production\"]}]}", "Type": "TAG_FILTERS_1_0" } }

L'exemple de AWS CLI commande suivant crée un groupe de ressources avec la configuration et la requête précédentes.

$ aws resource-groups create-group \ --name test-group \ --resource-query '{"Type": "TAG_FILTERS_1_0", "Query": "{\"ResourceTypeFilters\": [\"AWS::EC2::Instance\"], \"TagFilters\": [{\"Key\": \"environment\", \"Values\": [\"production\"]}]}"}' \ --configuration '[{"Type": "AWS::NetworkFirewall::RuleGroup", "Parameters": []}]' { "Group":{ "GroupArn":"arn:aws:resource-groups:us-west-2:123456789012:group/test-group", "Name":"test-group", "OwnerId":"123456789012" }, "Configuration": [ { "Type": "AWS::NetworkFirewall::RuleGroup", "Parameters": [] } ], "ResourceQuery": { "Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"environment\",\"Values\":[\"production\"]}]}", "Type": "TAG_FILTERS_1_0" } }