AWS CloudFormation spécification des ressources

La spécification AWS CloudFormation des ressources est un fichier texte au format JSON qui définit les ressources et les propriétés prises en charge. AWS CloudFormation Le document est une spécification lisible par machine et fortement dactylographiée que vous pouvez utiliser pour créer des outils de création de modèles. AWS CloudFormation Par exemple, vous pouvez utiliser la spécification pour créer des fonctionnalités de complétion automatique et de validation pour les AWS CloudFormation modèles dans votre environnement de développement intégré (IDE).

La spécification de ressource est organisée à la fois en tant que fichier unique et série de fichiers, où chaque fichier contient la définition d'un type de ressource. Les fichiers uniques et séparés contiennent des informations identiques. En fonction de l'outil et de votre implémentation, utilisez le ou les fichiers adaptés.

Pour télécharger la spécification de ressource, consultez le tableau suivant.

La disponibilité de la ressource peut varier en fonction de la région. Pour vérifier la disponibilité d'une ressource dans une région donnée, consultez la spécification de la ressource pour cette région.

L'exemple suivant montre la spécification d'une ressource AWS Key Management Service clé (AWS::KMS::Key). Il présente les propriétés de la ressource AWS::KMS::Key, les propriétés qui sont obligatoires, le type de valeur autorisée pour chaque propriété et leur comportement de mise à jour. Pour plus d'informations sur la spécification, consultez la rubrique Format de la spécification.

    "AWS::KMS::Key": {
      "Attributes": {
        "Arn": {
          "PrimitiveType": "String"
        }
      },
      "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html",
      "Properties": {
        "Description": {
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-description",
          "PrimitiveType": "String",
          "Required": false,
          "UpdateType": "Mutable"
        },
        "EnableKeyRotation": {
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-enablekeyrotation",
          "PrimitiveType": "Boolean",
          "Required": false,
          "UpdateType": "Mutable"
        },
        "Enabled": {
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-enabled",
          "PrimitiveType": "Boolean",
          "Required": false,
          "UpdateType": "Mutable"
        },
        "KeyPolicy": {
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keypolicy",
          "PrimitiveType": "Json",
          "Required": true,
          "UpdateType": "Mutable"
        },
        "KeyUsage": {
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keyusage",
          "PrimitiveType": "String",
          "Required": false,
          "UpdateType": "Immutable"
        }
      }
    }