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à.
AWS::CloudFormation::Interface
AWS::CloudFormation::Interface
è una chiave di metadati che definisce il modo in cui i parametri vengono raggruppati e ordinati nella console. AWS CloudFormation Per impostazione predefinita, la console elenca i parametri di input in ordine alfabetico in base alla loro logica IDs quando si creano o si aggiornano gli stack nella console. Utilizzando questa chiave, è possibile definire il raggruppamento e l'ordine dei parametri in modo che gli utenti possano specificare i valori dei parametri in modo efficace. Ad esempio, è possibile raggruppare tutti i parametri EC2 correlati in un gruppo e tutti i parametri VPC correlati in un altro gruppo.
Nel chiave di metadati puoi specificare i gruppi da creare, i parametri da includere in ciascun gruppo e l'ordine in base al quale la console mostra ciascun parametro all'interno del relativo gruppo.
È inoltre possibile definire etichette per i parametri. Un'etichetta è un nome semplice o una descrizione che la console visualizza invece di visualizzare un ID logico del parametro. Le etichette sono utili per aiutare gli utenti a comprendere i valori da specificare per ciascun parametro. Ad esempio, è possibile creare un'etichetta per un parametro KeyPair
Select an EC2 key pair
.
Tutti i parametri a cui fai riferimento nella chiave di metadati devono essere dichiarati nella sezione Parameters
del modello.
Nota
Solo la CloudFormation console utilizza la chiave AWS::CloudFormation::Interface
dei metadati. AWS CLI e API le chiamate non utilizzano questa chiave.
Sintassi
Per dichiarare questa entità nel tuo CloudFormation modello, usa la seguente sintassi:
JSON
"Metadata" : { "AWS::CloudFormation::Interface" : { "ParameterGroups" : [
ParameterGroup, ...
], "ParameterLabels" :ParameterLabel
} }
YAML
Metadata: AWS::CloudFormation::Interface: ParameterGroups: -
ParameterGroup
ParameterLabels:ParameterLabel
Proprietà
ParameterGroups
-
Un elenco dei tipi di gruppo di parametri dove è possibile specificare i nomi di gruppo, i parametri di ciascun gruppo e l'ordine in cui i parametri sono visualizzati.
Required: No
Tipo: AWS::CloudFormation::Interface ParameterGroup
Aggiornamento richiesto: nessuna interruzione
ParameterLabels
-
Una mappatura dei parametri e dei relativi nomi descrittivi che la CloudFormation console mostra quando uno stack viene creato o aggiornato.
Required: No
Tipo: AWS::CloudFormation::Interface ParameterLabel
Aggiornamento richiesto: nessuna interruzione
Esempio
L'esempio seguente definisce due gruppi di parametri: Network Configuration
e Amazon EC2 Configuration
. Il gruppo Network Configuration
include i parametri VPCID
, SubnetId
e SecurityGroupID
, che sono definiti nella sezione Parameters
del modello (non mostrato). L'ordine in cui la console mostra questi parametri viene definito dall'ordine in cui i parametri sono elencati, a partire dal parametro VPCID
. L'esempio analogamente raggruppa e ordina i parametri Amazon EC2 Configuration
.
L'esempio definisce anche un'etichetta per il parametro VPCID
. La console mostrerà su quale VPC deve essere distribuito? anziché l'ID logico del parametro (VPCID
).
JSON
"Metadata" : { "AWS::CloudFormation::Interface" : { "ParameterGroups" : [ { "Label" : { "default" : "Network Configuration" }, "Parameters" : [ "VPCID", "SubnetId", "SecurityGroupID" ] }, { "Label" : { "default":"Amazon EC2 Configuration" }, "Parameters" : [ "InstanceType", "KeyName" ] } ], "ParameterLabels" : { "VPCID" : { "default" : "Which VPC should this be deployed to?" } } } }
YAML
Metadata: AWS::CloudFormation::Interface: ParameterGroups: - Label: default: "Network Configuration" Parameters: - VPCID - SubnetId - SecurityGroupID - Label: default: "Amazon EC2 Configuration" Parameters: - InstanceType - KeyName ParameterLabels: VPCID: default: "Which VPC should this be deployed to?"
Gruppi di parametri nella console
Utilizzando la chiave di metadati di questo esempio, la figura riportata di seguito mostra il modo in cui la console visualizza i gruppi di parametri al momento della creazione o dell'aggiornamento di uno stack: i gruppi di parametri nella console
![La console mostra i gruppi di parametri per questo esempio.](images/console-create-stack-parameter-groups.png)