

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# Organisation des CloudFormation paramètres à l'aide de `AWS::CloudFormation::Interface` métadonnées
<a name="aws-cloudformation-interface"></a>

`AWS::CloudFormation::Interface`est une clé de métadonnées qui définit la manière dont les paramètres sont regroupés et triés dans la CloudFormation console. Par défaut, la console répertorie les paramètres par ordre alphabétique de leurs identifiants logiques lorsque vous créez ou mettez à jour des piles. 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.

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.

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

## Syntaxe
<a name="aws-resource-cloudformation-interface-syntax"></a>

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

### JSON
<a name="aws-resource-cloudformation-interface-syntax.json"></a>

```
"Metadata" : {
  "AWS::CloudFormation::Interface" : {
    "ParameterGroups": [
      {
        "Label": {
          "default": "Group Label"
        },
        "Parameters": [
          "Parameter1",
          "Parameter2"
        ]
      }
    ],
    "ParameterLabels": {
      "Parameter1": {
        "default": "Friendly Name for Parameter1"
      }
    }
  }
}
```

### YAML
<a name="aws-resource-cloudformation-interface-syntax.yaml"></a>

```
Metadata:
  AWS::CloudFormation::Interface:
    ParameterGroups:
      - Label:
          default: Group Label
        Parameters:
          - Parameter1
          - Parameter2
    ParameterLabels:
      Parameter1:
        default: Friendly Name for Parameter1
```

## Propriétés
<a name="w2aac11c23c29c17c17"></a>

`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    
`Label`  
Nom du groupe de paramètres.  
*Obligatoire* : non  
`default`  
L'étiquette par défaut utilisée par la CloudFormation console pour nommer un groupe de paramètres.  
*Obligatoire* : non  
*Type* : chaîne  
`Parameters`  
Liste des paramètres logiques distinguant majuscules et minuscules IDs à inclure dans le groupe. Les paramètres doivent déjà être définis dans la section `Parameters` du modèle. Un paramètre ne peut être inclus que dans un seul groupe de paramètres.  
La console répertorie les paramètres que vous n'associez pas à un groupe de paramètres dans le groupe `Other parameters`, dans l'ordre alphabétique.  
*Obligatoire* : non  
*Type* : liste de valeurs de chaîne

`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    
Étiquette de paramètre  
Etiquette d'un paramètre. L'étiquette définit un nom ou une description convivial que la CloudFormation console affiche sur la page **Spécifier les paramètres** lorsqu'une pile est créée ou mise à jour. L’étiquette d’un paramètre doit correspondre à l’ID logique sensible à la casse d’un paramètre déclaré dans la section `Parameters` du modèle.  
*Obligatoire* : non  
`default`  
L'étiquette par défaut utilisée par la CloudFormation console pour nommer un paramètre.  
*Obligatoire* : non  
*Type* : chaîne

## Exemple
<a name="w2aac11c23c29c17c19"></a>

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
<a name="aws-cloudformation-interface-example.json"></a>

```
"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
<a name="aws-cloudformation-interface-example.yaml"></a>

```
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
<a name="w2aac11c23c29c17c19c11"></a>

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** 

![\[Console affichant les groupes de paramètres pour cet exemple.\]](http://docs.aws.amazon.com/fr_fr/AWSCloudFormation/latest/UserGuide/images/console-create-stack-parameter-groups.png)
