CloudFormation Ressourcenspezifikation

Das Tool AWS CloudFormation Die Ressourcenspezifikation ist eine Textdatei JSON im -Format, die die unterstützten Ressourcen und Eigenschaften definiert. CloudFormation Das Dokument ist eine maschinenlesbare, stark typisierte Spezifikation, mit der Sie Tools zum Erstellen von Vorlagen erstellen können. CloudFormation Sie können die Spezifikation beispielsweise verwenden, um Funktionen zur auto Vervollständigung und Validierung für CloudFormation Vorlagen in Ihrer IDE (integrierten Entwicklungsumgebung) zu erstellen.

Die Ressourcenspezifikation ist sowohl eine einzelne Datei als auch eine Reihe von Dateien, wobei jede Datei die Definition des Ressourcentyps enthält. Die einzelne und die getrennten Dateien enthalten identische Informationen. Je nach Tool und Ihrer Implementierung verwenden Sie die Datei oder die Dateien, die für Sie am besten geeignet sind.

In der folgenden Tabelle erkennen Sie, wie Sie die Ressourcenspezifikation herunterladen.

Die Ressourcenverfügbarkeit kann je nach Region variieren. Um die Verfügbarkeit einer Ressource in einer bestimmten Region zu prüfen, beziehen Sie sich auf die Ressourcenspezifikation für diese Region.

Das folgende Beispiel zeigt die Spezifikation für ein AWS Key Management Service Schlüsselressource (AWS::KMS::Key). Es werden die Eigenschaften für die AWS::KMS::Key-Ressource, die erforderlichen Eigenschaften, der Typ des zulässigen Werts für jede Eigenschaft und deren Aktualisierungsverhalten angegeben. Details zur Spezifikation finden Sie unter Spezifikationsformat.

    "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"
        }
      }
    }