AWS::CloudFormation::Interface

AWS::CloudFormation::Interface est une clé de métadonnées qui définit comment les paramètres sont regroupés et triés dans la console AWS CloudFormation. Lorsque vous créez ou mettez à jour des piles dans la console, la console répertorie les paramètres d'entrée dans l'ordre alphabétique en fonction de leur ID logique. Cette clé vous permet de définir le regroupement et l'ordre de paramètres que vous souhaitez. De cette manière, les utilisateurs peuvent spécifier efficacement les valeurs des paramètres. Par exemple, vous pouvez regrouper tous les paramètres liés à EC2 dans un seul et même groupe et tous les paramètres liés au VPC dans un autre.

En plus du regroupement et de l'ordre des paramètres, vous pouvez définir des étiquettes pour les paramètres. Une étiquette est un nom descriptif ou une description que la console affiche au lieu de l'ID logique du paramètre. Les étiquettes sont utiles pour aider les utilisateurs à comprendre les valeurs à spécifier pour chaque paramètre. Par exemple, vous pouvez ajouter au paramètre KeyPair l'étiquette Select an EC2 key pair.

Note

Seule la CloudFormation console utilise la clé de AWS::CloudFormation::Interface métadonnées. AWS CLIet les appels d'API n'utilisent pas cette clé.

Syntaxe

Pour déclarer cette entité dans votre CloudFormation modèle, utilisez la syntaxe suivante :

JSON

"Metadata" : {
  "AWS::CloudFormation::Interface" : {
    "ParameterGroups" : [ ParameterGroup, ... ],
    "ParameterLabels" : ParameterLabel
  }
}

YAML

Metadata:
  AWS::CloudFormation::Interface:
    ParameterGroups:
      - ParameterGroup
    ParameterLabels:
      ParameterLabel

Propriétés

ParameterGroups

Liste des types de groupes de paramètres, où vous spécifiez des noms de groupe, les paramètres de chaque groupe et l'ordre dans lequel les paramètres sont affichés.

Obligatoire : non

Type : AWS::CloudFormation::Interface ParameterGroup

Requis pour la mise à jour : aucune interruption

ParameterLabels

Un mappage des paramètres et de leurs noms conviviaux que la CloudFormation console affiche lors de la création ou de la mise à jour d'une pile.

Obligatoire : non

Type : AWS::CloudFormation::Interface ParameterLabel

Requis pour la mise à jour : aucune interruption

Exemple

L'exemple suivant définit deux groupes de paramètres : Network Configuration et Amazon EC2 Configuration. Le groupe Network Configuration comprend les VPCID, SubnetId et SecurityGroupID, qui sont définis dans la section Parameters du modèle (non affichée). L'ordre dans lequel la console affiche ces paramètres est défini par l'ordre dans lequel ils sont répertoriés, en commençant par le paramètre VPCID. Cet exemple regroupe et ordonne les paramètres Amazon EC2 Configuration d'une manière similaire.

Cet exemple définit également une étiquette pour le paramètre VPCID. La console affiche Which VPC should this be deployed to? (dans quel VPC ceci doit-il est déployé ?) au lieu de l'ID logique du paramètre (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?"

Groupes de paramètres dans la console

L'illustration suivante présente la façon dont la console affiche les groupes de paramètres lorsqu'une pile est créée ou mise à jour en utilisant la clé de métadonnées de cet exemple : Groupes de paramètres dans la console