Verwendung von Cloud Control API-Ressourcentypen - Cloud Control API

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Verwendung von Cloud Control API-Ressourcentypen

Um einen Ressourcentyp mit verwenden zu können AWS -Cloud-Control- API, muss dieser Ressourcentyp in Ihrem AWS-Konto vorhanden und aktiviert sein. Unterstützte AWS Ressourcentypen sind öffentlich und immer aktiviert. Sie können wählen, ob Sie öffentliche Ressourcentypen, die von Drittanbietern angeboten werden, auch über die AWS CloudFormation Erweiterungsregistrierung aktivieren möchten.

Die Erweiterungsregistrierung ist eine Funktion von AWS CloudFormation , die detaillierte Informationen zu den Ressourcentypen enthält, die in Ihrem Konto verwendet werden können. Dazu können auch Ressourcentypen gehören, die von Drittanbietern veröffentlicht wurden, sowie solche, die von AWS veröffentlicht wurden. Mithilfe der Registrierung können Sie die Ressourcentypen in Ihrem Konto verwalten, darunter:

  • Sehen Sie sich die verfügbaren und aktivierten Ressourcentypen an.

  • Registrieren Sie private Ressourcentypen zur Verwendung in Ihrem Konto.

  • Aktivieren Sie öffentliche Ressourcentypen von Drittanbietern.

  • Verwalten Sie die Versionen der Ressourcentypen, einschließlich der Festlegung der Standardversion eines Ressourcentyps in Ihrem Konto.

  • Legen Sie die Konfigurationseigenschaften eines Ressourcentyps auf Kontoebene fest, falls vorhanden.

Sie können die AWS CloudFormation Registrierung auch verwenden, um das Schema eines Ressourcentyps einzusehen, das wichtige Informationen zur Verwendung der Ressource mit der Cloud Control API enthält, wie Eigenschaftsdefinitionen und Berechtigungsanforderungen. Weitere Informationen finden Sie unter Schemas für Ressourcentypen anzeigen.

Die Registrierung ist neben der CloudFormation API auch über die CloudFormation Konsole verfügbar.

Anmerkung

Derzeit unterstützen nicht alle in der CloudFormation Registrierung aufgeführten Ressourcentypen die Cloud Control API. Weitere Informationen finden Sie unter Feststellen, ob ein Ressourcentyp die Cloud Control API unterstützt.

Weitere Informationen zu den Verwaltungsoptionen für Ressourcentypen finden Sie im AWS CloudFormation Benutzerhandbuch unter Verwenden der CloudFormation Registrierung.

Verwaltung von Ressourcentypen mithilfe der AWS CloudFormation API

Sie können nicht nur über die AWS CloudFormation Konsole auf die Erweiterungsregistrierung zugreifen, sondern auch die in der AWS CloudFormation API enthaltenen Operationen verwenden, um die Ressourcentypen in Ihrem Konto zu identifizieren und zu verwalten. In der folgenden Tabelle sind die API-Operationen aufgeführt, mit denen Sie die in Ihrem Konto verfügbaren Ressourcentypen ermitteln, aktivieren und konfigurieren können.

CloudFormation API-Betrieb AWS CLI Befehl Beschreibung

DescribeType

describe-type

Gibt detaillierte Informationen über einen Ressourcentyp zurück.

ListTypes

list-types

Gibt zusammenfassende Informationen über einen Ressourcentyp zurück.

ActivateType

activate-type

Aktiviert einen öffentlichen Ressourcentyp eines Drittanbieters und macht ihn für die Verwendung in Ihrem Konto verfügbar.

DeactivateType

deactivate-type

Deaktiviert einen öffentlichen Ressourcentyp eines Drittanbieters in Ihrem Konto.

ListTypeVersions

list-type-versions

Gibt zusammenfassende Informationen zu den Versionen eines Ressourcentyps zurück.

SetTypeDefaultVersion

set-type-default-version

Gibt die Standardversion eines Ressourcentyps an.

BatchDescribeTypeConfigurations

batch-describe-type-configurations

Gibt Konfigurationsdaten für die angegebenen Ressourcentypen zurück.

SetTypeConfiguration

set-type-configuration

Gibt die Konfigurationsdaten für einen Ressourcentyp in Ihrem Konto an.

RegisterType

register-type

Registriert eine private Drittanbieterressource und macht sie für die Verwendung in Ihrem Konto verfügbar.

DeregisterType

deregister-type

Deregistriert eine private Drittanbieterressource und entfernt sie so von der aktiven Nutzung in Ihrem Konto.

Feststellen, ob ein Ressourcentyp die Cloud Control API unterstützt

Standardmäßig unterstützen in der CloudFormation Registrierung veröffentlichte Ressourcentypen automatisch Cloud Control API-Ressourcenoperationen. Dazu gehören private Ressourcentypen sowie öffentliche Ressourcentypen von Drittanbietern. Die AWS CloudFormation Registrierung enthält jedoch auch ältere Ressourcentypen, die als nicht bereitstellbar eingestuft sind. Diese Ressourcentypen unterstützen derzeit die Cloud Control API nicht und Sie können sie nicht für Ressourcenoperationen verwenden.

Eine Liste der AWS öffentlichen Ressourcentypen, die derzeit Cloud Control API-Ressourcenoperationen unterstützen, finden Sie unterRessourcentypen, die die Cloud Control API unterstützen.

Sie können das AWS Command Line Interface (AWS CLI) auch verwenden, um eine Liste der unterstützten Ressourcentypen zu generieren oder um festzustellen, ob ein bestimmter Ressourcentyp die Cloud Control API unterstützt.

Generieren einer Liste unterstützter Ressourcen mit dem AWS CLI
  • Verwenden Sie den list-types Befehl mit den folgenden Parametern:

    • type— Geben Sie RESOURCE an, dass nur Ressourcentypen ausgewählt werden sollen.

    • visibility— Geben Sie PUBLIC an, ob Sie öffentliche oder PRIVATE private Ressourcen auswählen möchten.

    • provisioning-type— Geben Sie IMMUTABLE an FULLY_MUTABLE oder wählen Sie nur die Ressourcentypen aus, die bereitgestellt werden können.

    Mit dem folgenden Befehl werden beispielsweise die ersten 100 öffentlichen Ressourcentypen, die vollständig veränderbar sind, aus der CloudFormation Registrierung ausgewählt.

    $ aws cloudformation list-types \ --type RESOURCE --visibility PUBLIC \ --provisioning-type FULLY_MUTABLE --max-results 100
Feststellen, ob ein bestimmter Ressourcentyp die Cloud Control-API unterstützt, mithilfe von AWS CLI
  • Verwenden Sie den describe-type Befehl, um Details zum Ressourcentyp zurückzugeben.

    ProvisioningTypeRessourcentypen mit entweder FULLY_MUTABLE oder IMMUTABLE unterstützen Cloud Control API-Ressourcenoperationen.

    Das folgende Beispiel gibt Details zum AWS::Logs::LogGroup Ressourcentyp zurück.

    $ aws cloudformation describe-type \ --type RESOURCE --type-name AWS::Logs::LogGroup

Schemas für Ressourcentypen anzeigen

Bei Vorgängen zum Erstellen und Aktualisieren von Ressourcen geben Sie an, welche Ressourceneigenschaften festgelegt werden sollen und welche Werte sie haben. Die Eigenschaften einer Ressource sind in ihrem Ressourcentypschema definiert. Dazu gehören der Datentyp, ob die Eigenschaft erforderlich ist, gültige Werte und andere Eigenschaftseinschränkungen.

Sie können das Schema eines Ressourcentyps in der CloudFormation Konsole oder im anzeigen AWS CLI. Darüber hinaus enthält das AWS CloudFormation Benutzerhandbuch Referenzthemen für jeden verfügbaren Ressourcentyp, der AWS veröffentlicht. Ausführliche Informationen zu den Eigenschaften von Ressourcentypen sowie Anwendungsbeispiele finden Sie in den entsprechenden Themen im Referenzabschnitt zu AWS Ressourcen- und Eigenschaftstypen.

Anmerkung

Nicht alle im AWS CloudFormation Benutzerhandbuch aufgeführten Ressourcentypen sind für die Verwendung mit der Cloud Control API verfügbar. Informationen darüber, ob ein Ressourcentyp verfügbar ist, finden Sie unterRessourcentypen, die die Cloud Control API unterstützen.

Ausführliche Informationen zum Ressourcentypdefinitionsschema, das definiert, wie ein Ressourcentypschema erstellt werden kann, finden Sie unter Ressourcentypdefinitionsschema im CloudFormation CLI User Guide for Extension Development.

Informationen darüber, wie Sie den aktuellen Status einer vorhandenen Ressource, einschließlich ihrer aktuellen Eigenschaftswerte, anzeigen können, finden Sie unter. Eine Ressource lesen mit AWS -Cloud-Control- API

Ein Ressourcentypschema mithilfe der AWS CloudFormation Konsole anzeigen

  1. Melden Sie sich bei der an AWS Management Console und öffnen Sie die AWS CloudFormation Konsole unter https://console.aws.amazon.com/cloudformation.

  2. Wählen Sie im CloudFormationNavigationsbereich unter Registrierung die Option Aktivierte Erweiterungen aus.

  3. Wählen Sie auf der Registerkarte Ressourcentypen den Ressourcentyp aus, dessen Ressourcenschema Sie anzeigen möchten.

    CloudFormation zeigt die Seite mit den Details zum Ressourcentyp an. Das Ressourcenschema wird auf der Registerkarte Schema angezeigt.

Anzeigen eines Ressourcentypschemas mit dem AWS CLI

  • Führen Sie describe-type.

    In der zurückgegebenen Ausgabe enthält die Schema Struktur das Ressourcentypschema.

    Der folgende Befehl gibt beispielsweise Informationen über den AWS::Logs::LogGroup Ressourcentyp zurück.

    $ aws cloudformation describe-type \ --type RESOURCE --type-name AWS::Logs::LogGroup

Eigenschaftsattribute von Ressourcen anzeigen

Ressourcentypeigenschaften werden im properties Abschnitt des Ressourcentypschemas definiert. Dazu gehören der Eigenschaftsdatentyp, ob die Eigenschaft erforderlich ist, und alle Einschränkungen wie zulässige Werte oder erforderliche Muster.

Darüber hinaus bestimmen bestimmte auf Ressourcenebene festgelegte Attribute, wann oder ob eine Eigenschaft angegeben werden kann. Dies umfasst:

  • Eigenschaften, die als definiert sind, required müssen bei der Ressourcenerstellung im gewünschten Zustand angegeben werden.

  • Eigenschaften, die als definiert sind, createOnlyProperties können von Benutzern festgelegt werden, jedoch nur während der Ressourcenerstellung.

  • Eigenschaften, die als definiert sind, readOnlyProperties können nicht von Benutzern festgelegt werden.

  • Eigenschaften, die als definiert sind, writeOnlyProperties können von Benutzern beim Erstellen oder Aktualisieren einer Ressource angegeben werden, können aber bei einer Lese- oder Listenanforderung nicht zurückgegeben werden.

Unterstützte Ressourcenoperationen anzeigen

Sie können anhand des handlers Abschnitts seines Ressourcentypschemas ermitteln, welche Operationen ein Ressourcentyp unterstützt. Wenn der Ressourcentyp eine Operation unterstützt, ist er im handlers Abschnitt aufgeführt und enthält ein permissions Element, das die Berechtigungen auflistet, die der Handler benötigt.

Im Folgenden finden Sie beispielsweise den handlers Abschnitt des Ressourcentypschemas für den AWS::Logs::LogGroup Ressourcentyp. Dieser Abschnitt zeigt, dass dieser Ressourcentyp alle fünf Ressourcenoperationen unterstützt, und listet die Berechtigungen auf, die jeder Handler benötigt.

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