Utilizzo dei tipi di API risorse Cloud Control - Controllo del cloud API

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Utilizzo dei tipi di API risorse Cloud Control

Per utilizzare un tipo di risorsa con AWS Cloud Control API, quel tipo di risorsa deve essere presente e attivato nel tuo. Account AWS I tipi di AWS risorse supportati sono pubblici e sempre attivati. Puoi scegliere di attivare i tipi di risorse pubbliche offerti da editori di terze parti anche tramite il registro delle AWS CloudFormation estensioni.

Il registro delle estensioni è una funzionalità AWS CloudFormation che contiene informazioni dettagliate sui tipi di risorse disponibili per l'uso nel tuo account. Questi possono includere tipi di risorse pubblicati da terze parti, oltre a quelli pubblicati da AWS. Utilizzando il registro, puoi gestire i tipi di risorse del tuo account, tra cui:

  • Visualizza i tipi di risorse disponibili e attivati.

  • Registra i tipi di risorse private da utilizzare nel tuo account.

  • Attiva tipi di risorse pubbliche di terze parti.

  • Gestisci le versioni dei tipi di risorsa, inclusa l'impostazione della versione predefinita di un tipo di risorsa nel tuo account.

  • Imposta le proprietà di configurazione a livello di account di un tipo di risorsa, se disponibile.

Puoi anche utilizzare il AWS CloudFormation registro per visualizzare lo schema di un tipo di risorsa, che contiene informazioni importanti su come utilizzare la risorsa con Cloud ControlAPI, come le definizioni delle proprietà e i requisiti di autorizzazione. Per ulteriori informazioni, consulta Visualizzazione degli schemi dei tipi di risorse.

Il registro è disponibile tramite la CloudFormation console, oltre a CloudFormationAPI.

Nota

Attualmente non tutti i tipi di risorse elencati nel CloudFormation registro supportano Cloud ControlAPI. Per ulteriori informazioni, consulta Determinare se un tipo di risorsa supporta Cloud Control API.

Per ulteriori informazioni sulle opzioni di gestione dei tipi di risorse, consulta Uso del CloudFormation registro nella Guida AWS CloudFormation per l'utente.

Gestione dei tipi di risorse utilizzando il AWS CloudFormation API

Oltre ad accedere al registro delle estensioni tramite la AWS CloudFormation console, puoi utilizzare le operazioni incluse in AWS CloudFormation API per identificare e gestire i tipi di risorse presenti nel tuo account. La tabella seguente elenca le API operazioni che puoi utilizzare per scoprire, attivare e configurare i tipi di risorse disponibili nel tuo account.

CloudFormation APIoperazione AWS CLI comando Descrizione

DescribeType

describe-type

Restituisce informazioni dettagliate su un tipo di risorsa.

ListTypes

list-types

Restituisce informazioni di riepilogo su un tipo di risorsa.

ActivateType

activate-type

Attiva un tipo di risorsa pubblica di terze parti, rendendolo disponibile per l'uso nel tuo account.

DeactivateType

deactivate-type

Disattiva un tipo di risorsa pubblica di terze parti nel tuo account.

ListTypeVersions

list-type-versions

Restituisce informazioni di riepilogo sulle versioni di un tipo di risorsa.

SetTypeDefaultVersion

set-type-default-version

Speciifica la versione predefinita di un tipo di risorsa.

BatchDescribeTypeConfigurations

batch-describe-type-configurations

Restituisce i dati di configurazione per i tipi di risorse specificati.

SetTypeConfiguration

set-type-configuration

Specifica i dati di configurazione per un tipo di risorsa nel tuo account.

RegisterType

register-type

Registra una risorsa privata di terze parti, rendendola disponibile per l'uso nel tuo account.

DeregisterType

deregister-type

Annulla la registrazione di una risorsa privata di terze parti, rimuovendola dall'uso attivo nel tuo account.

Determinare se un tipo di risorsa supporta Cloud Control API

Per impostazione predefinita, i tipi di risorse pubblicati nel CloudFormation registro supportano automaticamente le operazioni sulle API risorse di Cloud Control. Ciò include i tipi di risorse private, oltre ai tipi di risorse pubbliche di terze parti. Tuttavia, il AWS CloudFormation registro contiene anche tipi di risorse legacy, classificati come non fornibili. Questi tipi di risorse attualmente non supportano Cloud Control API e non è possibile utilizzarli nelle operazioni relative alle risorse.

Per un elenco dei tipi di risorse AWS pubbliche che attualmente supportano le operazioni relative alle API risorse di Cloud Control, consultaTipi di risorse che supportano Cloud Control API.

Puoi anche usare il AWS Command Line Interface (AWS CLI) per generare un elenco di tipi di risorse supportati o per determinare se un tipo di risorsa specifico supporta Cloud ControlAPI.

Generazione di un elenco di risorse supportate utilizzando il AWS CLI
  • Utilizzate il list-types comando, con i seguenti parametri:

    • typeRESOURCE Specificare di selezionare solo i tipi di risorse.

    • visibilityPUBLIC Specificare se selezionare risorse pubbliche o PRIVATE private.

    • provisioning-typeIMMUTABLE Specificare FULLY_MUTABLE o selezionare solo i tipi di risorse che sono disponibili.

    Ad esempio, il comando seguente seleziona i primi 100 tipi di risorse pubbliche completamente modificabili dal registro. CloudFormation

    $ aws cloudformation list-types \ --type RESOURCE --visibility PUBLIC \ --provisioning-type FULLY_MUTABLE --max-results 100
Determinare se un tipo di risorsa specifico supporta Cloud Control utilizzando il API AWS CLI
  • Usa il describe-type comando per restituire i dettagli del tipo di risorsa.

    Tipi di risorse con uno ProvisioningType dei due FULLY_MUTABLE o che IMMUTABLE supportano le operazioni relative alle API risorse di Cloud Control.

    L'esempio seguente restituisce i dettagli del tipo di AWS::Logs::LogGroup risorsa.

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

Visualizzazione degli schemi dei tipi di risorse

Durante le operazioni di creazione e aggiornamento delle risorse, si specificano le proprietà delle risorse da impostare e i relativi valori. Le proprietà di una risorsa sono definite nello schema del tipo di risorsa. Ciò include il tipo di dati, l'eventuale obbligatorietà della proprietà, i valori validi e altri vincoli di proprietà.

È possibile visualizzare lo schema di un tipo di risorsa utilizzando la CloudFormation console o il. AWS CLI Inoltre, la Guida per l'AWS CloudFormation utente contiene argomenti di riferimento per ogni tipo di risorsa disponibile AWS pubblicata. Per informazioni dettagliate sulle proprietà dei tipi di risorsa, oltre agli esempi di utilizzo, consultate gli argomenti corrispondenti nella sezione di riferimento per i tipi di AWS risorse e proprietà.

Nota

Non tutti i tipi di risorse elencati nella Guida per l'AWS CloudFormation utente sono disponibili per l'uso con Cloud ControlAPI. Per determinare se un tipo di risorsa è disponibile, consultaTipi di risorse che supportano Cloud Control API.

Per informazioni dettagliate sullo schema di definizione del tipo di risorsa, che definisce come creare lo schema del tipo di risorsa, vedere Schema di definizione del tipo di risorsa nella Guida CloudFormation CLI utente per lo sviluppo di estensioni.

Per informazioni su come visualizzare lo stato corrente di una risorsa esistente, che include i valori delle proprietà correnti, vedereLeggere una risorsa con AWS Cloud Control API.

Visualizzazione dello schema di un tipo di risorsa utilizzando la AWS CloudFormation console

  1. Accedi AWS Management Console e apri la AWS CloudFormation console all'indirizzo https://console.aws.amazon.com/cloudformazione.

  2. Nel riquadro di CloudFormationnavigazione, in Registro, seleziona Estensioni attivate.

  3. Nella scheda Tipi di risorse, seleziona il tipo di risorsa di cui desideri visualizzare lo schema delle risorse.

    CloudFormation visualizza la pagina dei dettagli del tipo di risorsa. Lo schema delle risorse viene visualizzato nella scheda Schema.

Visualizzazione dello schema di un tipo di risorsa utilizzando il AWS CLI

  • Esegui describe-type.

    Nell'output restituito, la Schema struttura contiene lo schema del tipo di risorsa.

    Ad esempio, il comando seguente restituisce informazioni sul tipo di AWS::Logs::LogGroup risorsa.

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

Visualizzazione degli attributi delle proprietà delle risorse

Le proprietà del tipo di risorsa sono definite nella properties sezione dello schema del tipo di risorsa. Ciò include il tipo di dati della proprietà, se la proprietà è obbligatoria ed eventuali vincoli, come i valori consentiti o i modelli obbligatori.

Inoltre, determinati attributi impostati a livello di risorsa determinano quando o se una proprietà può essere specificata. Questo include:

  • Le proprietà definite come required devono essere specificate nello stato desiderato durante la creazione della risorsa.

  • Le proprietà definite come createOnlyProperties possono essere impostate dagli utenti, ma solo durante la creazione delle risorse.

  • Le proprietà definite come non readOnlyProperties possono essere impostate dagli utenti.

  • Le proprietà definite come writeOnlyProperties possono essere specificate dagli utenti durante la creazione o l'aggiornamento di una risorsa, ma non possono essere restituite durante una richiesta di lettura o di elenco.

Visualizzazione delle operazioni sulle risorse supportate

È possibile determinare le operazioni supportate da un tipo di risorsa facendo riferimento alla handlers sezione del relativo schema dei tipi di risorse. Se il tipo di risorsa supporta un'operazione, questa è elencata nella handlers sezione e contiene un permissions elemento che elenca le autorizzazioni richieste dal gestore.

Ad esempio, di seguito è riportata la handlers sezione dello schema del tipo di risorsa per il tipo di AWS::Logs::LogGroup risorsa. Questa sezione mostra che questo tipo di risorsa supporta tutte e cinque le operazioni relative alle risorse ed elenca le autorizzazioni richieste da ciascun gestore.

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