AWS::CloudFormation::Interface

AWS::CloudFormation::Interfaceest une clé de métadonnées qui définit la manière dont les paramètres sont regroupés et triés dans la AWS CloudFormation console. Par défaut, la console répertorie les paramètres d'entrée par ordre alphabétique selon leur logique IDs lorsque vous créez ou mettez à jour des piles dans la console. 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 EC2 paramètres connexes dans un groupe et tous les VPC paramètres connexes dans un autre groupe.

Dans la clé de métadonnées, vous pouvez spécifier les groupes à créer, les paramètres à inclure dans chaque groupe et l'ordre dans lequel la console affiche chaque paramètre au sein de son groupe.

Vous pouvez également 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.

Tous les paramètres que vous référencez dans la clé de métadonnées doivent être déclarés dans la section Parameters du modèle.

Syntaxe

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

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

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

Propriétés

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 affichera vers qui cela VPC doit-il être déployé ? au lieu de l'ID logique du paramètre (VPCID).

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

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