Gestion des types de ressources Déterminer le type de ressource pris en charge Affichage des schémas de types de ressources

Utilisation des types de API ressources Cloud Control

Pour utiliser un type de ressource avec AWS Cloud Control API, ce type de ressource doit être présent et activé dans votre Compte AWS. Les types de AWS ressources pris en charge sont publics et toujours activés. Vous pouvez également choisir d'activer les types de ressources publiques proposés par des éditeurs tiers via le registre des AWS CloudFormation extensions.

Le registre des extensions est une fonctionnalité AWS CloudFormation qui contient des informations détaillées sur les types de ressources pouvant être utilisés dans votre compte. Il peut s'agir de types de ressources publiés par des tiers, en plus de ceux publiés par AWS. À l'aide du registre, vous pouvez gérer les types de ressources de votre compte, notamment :

Consultez les types de ressources disponibles et activés.
Enregistrez des types de ressources privées à utiliser dans votre compte.
Activez les types de ressources tierces publiques.
Gérez les versions des types de ressources, notamment en définissant la version par défaut d'un type de ressource dans votre compte.
Définissez les propriétés de configuration au niveau du compte pour un type de ressource, le cas échéant.

Vous pouvez également utiliser le AWS CloudFormation registre pour consulter le schéma d'un type de ressource, qui contient des informations importantes sur la manière d'utiliser la ressource avec Cloud ControlAPI, telles que les définitions des propriétés et les exigences en matière d'autorisation. Pour de plus amples informations, veuillez consulter Affichage des schémas de types de ressources.

Le registre est disponible via la CloudFormation console, en plus du CloudFormationAPI.

Note

Tous les types de ressources répertoriés dans le CloudFormation registre ne sont pas actuellement compatibles avec Cloud ControlAPI. Pour de plus amples informations, veuillez consulter Déterminer si un type de ressource prend en charge le contrôle du cloud API.

Pour plus d'informations sur les options de gestion des types de ressources, consultez la section Utilisation du CloudFormation registre dans le Guide de AWS CloudFormation l'utilisateur.

Gestion des types de ressources à l'aide du AWS CloudFormation API

Outre l'accès au registre des extensions via la AWS CloudFormation console, vous pouvez utiliser les opérations incluses dans le AWS CloudFormation API pour identifier et gérer les types de ressources de votre compte. Le tableau ci-dessous répertorie les API opérations que vous pouvez utiliser pour découvrir, activer et configurer les types de ressources disponibles dans votre compte.

CloudFormation APIopération	AWS CLI commande	Description
`DescribeType`	`describe-type`	Renvoie des informations détaillées sur un type de ressource.
`ListTypes`	`list-types`	Renvoie des informations récapitulatives sur un type de ressource.
`ActivateType`	`activate-type`	Active un type de ressource tierce publique, le rendant disponible pour utilisation dans votre compte.
`DeactivateType`	`deactivate-type`	Désactive un type de ressource tierce publique dans votre compte.
`ListTypeVersions`	`list-type-versions`	Renvoie des informations récapitulatives sur les versions d'un type de ressource.
`SetTypeDefaultVersion`	`set-type-default-version`	Spécifie la version par défaut d'un type de ressource.
`BatchDescribeTypeConfigurations`	`batch-describe-type-configurations`	Renvoie les données de configuration pour les types de ressources spécifiés.
`SetTypeConfiguration`	`set-type-configuration`	Spécifie les données de configuration pour un type de ressource dans votre compte.
`RegisterType`	`register-type`	Enregistre une ressource tierce privée, la rendant disponible pour utilisation sur votre compte.
`DeregisterType`	`deregister-type`	Désenregistre une ressource tierce privée et la retire de son utilisation active sur votre compte.

Déterminer si un type de ressource prend en charge le contrôle du cloud API

Par défaut, les types de ressources publiés dans le CloudFormation registre prennent automatiquement en charge les opérations de API ressources Cloud Control. Cela inclut les types de ressources privées, en plus des types de ressources tierces publiques. Toutefois, le AWS CloudFormation registre contient également des types de ressources hérités, classés comme non provisionnables. Ces types de ressources ne sont actuellement pas compatibles avec Cloud ControlAPI, et vous ne pouvez pas les utiliser dans le cadre d'opérations sur les ressources.

Pour obtenir la liste des types de ressources AWS publiques qui prennent actuellement en charge les opérations de API ressources Cloud Control, consultezTypes de ressources compatibles avec Cloud Control API.

Vous pouvez également utiliser le AWS Command Line Interface (AWS CLI) pour générer une liste des types de ressources pris en charge ou pour déterminer si un type de ressource spécifique prend en charge Cloud ControlAPI.

Génération d'une liste des ressources prises en charge à l'aide du AWS CLI

Utilisez la list-types commande, avec les paramètres suivants :
- type— Spécifiez RESOURCE pour sélectionner uniquement les types de ressources.
- visibility— Spécifiez PUBLIC si vous souhaitez sélectionner des ressources publiques ou PRIVATE privées.
- provisioning-type— Spécifiez FULLY_MUTABLE ou IMMUTABLE sélectionnez uniquement les types de ressources provisionnables.
Par exemple, la commande suivante sélectionne les 100 premiers types de ressources publiques entièrement modifiables depuis le CloudFormation registre.
```
$ aws cloudformation list-types \
    --type RESOURCE --visibility PUBLIC \
    --provisioning-type FULLY_MUTABLE --max-results 100
```

Déterminer si un type de ressource spécifique prend en charge le contrôle du cloud API à l'aide du AWS CLI

Utilisez la describe-type commande pour renvoyer les détails du type de ressource.

Les types de ressources comportant ProvisioningType l'un des deux FULLY_MUTABLE ou prenant IMMUTABLE en charge les opérations de API ressources Cloud Control.

L'exemple suivant renvoie les détails du type de AWS::Logs::LogGroup ressource.
```
$ aws cloudformation describe-type \
    --type RESOURCE --type-name AWS::Logs::LogGroup
```

Affichage des schémas de types de ressources

Au cours des opérations de création et de mise à jour des ressources, vous spécifiez les propriétés des ressources à définir ainsi que leurs valeurs. Les propriétés d'une ressource sont définies dans son schéma de type de ressource. Cela inclut le type de données, le caractère obligatoire de la propriété, les valeurs valides et d'autres contraintes de propriété.

Vous pouvez consulter le schéma d'un type de ressource à l'aide de la CloudFormation console ou du AWS CLI. En outre, le guide de AWS CloudFormation l'utilisateur contient des rubriques de référence pour chaque type de ressource disponible AWS publié. Pour obtenir des informations détaillées sur les propriétés des types de ressources, ainsi que des exemples d'utilisation, consultez les rubriques correspondantes dans la section de référence des types de AWS ressources et de propriétés.

Note

Tous les types de ressources répertoriés dans le guide de AWS CloudFormation l'utilisateur ne sont pas disponibles pour une utilisation avec Cloud ControlAPI. Pour déterminer si un type de ressource est disponible, consultezTypes de ressources compatibles avec Cloud Control API.

Pour des informations détaillées sur le schéma de définition du type de ressource, qui définit la manière dont le schéma de type de ressource peut être créé, voir Schéma de définition du type de ressource dans le Guide de l'CloudFormation CLIutilisateur pour le développement d'extensions.

Pour plus d'informations sur la façon d'afficher l'état actuel d'une ressource existante, y compris les valeurs de ses propriétés actuelles, consultezLire une ressource avec AWS Cloud Control API.

Affichage d'un schéma de type de ressource à l'aide de la AWS CloudFormation console

Connectez-vous à la AWS CloudFormation console AWS Management Console et ouvrez-la à l'adresse https://console.aws.amazon.com/cloudformation.
Dans le volet CloudFormationde navigation, sous Registre, sélectionnez Extensions activées.
Dans l'onglet Types de ressources, sélectionnez le type de ressource dont vous souhaitez afficher le schéma de ressources.

CloudFormation affiche la page de détails du type de ressource. Le schéma des ressources s'affiche dans l'onglet Schéma.

Affichage d'un schéma de type de ressource à l'aide du AWS CLI

Exécutez describe-type.

Dans la sortie renvoyée, la Schema structure contient le schéma du type de ressource.

Par exemple, la commande suivante renvoie des informations sur le type de AWS::Logs::LogGroup ressource.
```
$ aws cloudformation describe-type \
    --type RESOURCE --type-name AWS::Logs::LogGroup
```

Affichage des attributs des propriétés des ressources

Les propriétés du type de ressource sont définies dans la properties section du schéma du type de ressource. Cela inclut le type de données de la propriété, si la propriété est obligatoire et toutes les contraintes telles que les valeurs autorisées ou les modèles obligatoires.

En outre, certains attributs définis au niveau de la ressource déterminent quand ou si une propriété peut être spécifiée. Cela consiste notamment à :

Les propriétés définies required doivent être spécifiées dans l'état souhaité lors de la création de la ressource.
Les propriétés définies createOnlyProperties peuvent être définies par les utilisateurs, mais uniquement lors de la création des ressources.
Les propriétés définies comme ne readOnlyProperties peuvent pas être définies par les utilisateurs.
Les propriétés définies writeOnlyProperties peuvent être spécifiées par les utilisateurs lors de la création ou de la mise à jour d'une ressource, mais ne peuvent pas être renvoyées lors d'une demande de lecture ou de liste.

Affichage des opérations sur les ressources prises en charge

Vous pouvez déterminer les opérations prises en charge par un type de ressource en vous référant à la handlers section de son schéma de type de ressource. Si le type de ressource prend en charge une opération, il est répertorié dans la handlers section et contient un permissions élément répertoriant les autorisations requises par le gestionnaire.

Par exemple, vous trouverez ci-dessous la handlers section du schéma du type de ressource correspondant au type de AWS::Logs::LogGroup ressource. Cette section montre que ce type de ressource prend en charge les cinq opérations sur les ressources et répertorie les autorisations requises par chaque gestionnaire.


  "handlers": {
    "create": {
      "permissions": [
        "logs:DescribeLogGroups",
        "logs:CreateLogGroup",
        "logs:PutRetentionPolicy"
      ]
    },
    "read": {
      "permissions": [
        "logs:DescribeLogGroups"
      ]
    },
    "update": {
      "permissions": [
        "logs:DescribeLogGroups",
        "logs:AssociateKmsKey",
        "logs:DisassociateKmsKey",
        "logs:PutRetentionPolicy",
        "logs:DeleteRetentionPolicy"
      ]
    },
    "delete": {
      "permissions": [
        "logs:DescribeLogGroups",
        "logs:DeleteLogGroup"
      ]
    },
    "list": {
      "permissions": [
        "logs:DescribeLogGroups"
      ]
    }
  }

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Identifier les ressources avec AWS Cloud Control API

Types de ressources pris en charge