Il s'agit du nouveau guide AWS CloudFormation de référence des modèles. Veuillez mettre à jour vos favoris et vos liens. Pour obtenir de l'aide pour démarrer CloudFormation, consultez le guide de AWS CloudFormation l'utilisateur.

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.

Fonctions des règles

Les fonctions de règle sont des fonctions spéciales qui ne fonctionnent que dans la Rules section d'un CloudFormation modèle. Ces fonctions vous aident à valider les valeurs des paramètres à l'aide d'une logique personnalisée. Toutes les validations ont lieu avant de CloudFormation créer ou de mettre à jour des ressources.

Les règles sont utiles lorsque les contraintes de paramètres standard sont insuffisantes. Par exemple, lorsque le protocole SSL est activé, un certificat et un nom de domaine doivent être fournis. Une règle peut garantir le respect de ces dépendances.

Dans la condition ou les assertions d'une règle, vous pouvez utiliser des fonctions intrinsèques, comme Fn::Equals, Fn::Not et Fn::RefAll. La propriété condition détermine si les CloudFormation assertions sont appliquées. Si la condition est évaluée àtrue, CloudFormation évalue les assertions pour vérifier si une valeur de paramètre est valide lors de la création ou de la mise à jour d'une pile. Si la valeur d'un paramètre n'est pas valide, CloudFormation cela ne crée ni ne met à jour la pile. Si la condition est évaluée àfalse, CloudFormation elle ne vérifie pas la valeur du paramètre et poursuit l'opération de pile.

Si vous utilisez des règles pour la première fois dans vos modèles, nous vous recommandons de consulter d'abord la rubrique relative à la Rulessyntaxe des CloudFormation modèles dans le Guide de AWS CloudFormation l'utilisateur.

Fn::And

Renvoie true si toutes les conditions spécifiées correspondent à true, ou false si l'une des conditions indique false. Fn::And agit en tant qu'opérateur AND. Le nombre minimum de conditions que vous pouvez inclure est deux, et le maximum est dix.

Déclaration

"Fn::And" : [{condition}, {...}]

Paramètres

exemple

L'exemple suivant a la valeur true si le nom du groupe de sécurité référencé est égal à sg-mysggroup et si la valeur du paramètre InstanceType est t3.large ou t3.small :

"Fn::And": [
  {
    "Fn::Equals": [
      "sg-mysggroup",
      {"Ref": "ASecurityGroup"}
    ]
  },
  {
    "Fn::Contains": [
      [
        "t3.large",
        "t3.small"
      ],
      {"Ref": "InstanceType"}
    ]
  }
]

Fn::Contains

Renvoie true si une chaîne spécifiée correspond au moins à une valeur dans une liste de chaînes.

Déclaration

"Fn::Contains" : [[list_of_strings], string]

Paramètres

exemple

La fonction suivante a la valeur true si la valeur du paramètre InstanceType est contenu dans la liste (t3.large ou t3.small) :

"Fn::Contains" : [
  ["t3.large", "t3.small"], {"Ref" : "InstanceType"}
]

Fn::EachMemberEquals

Renvoie true si une chaîne spécifiée correspond à toutes les valeurs d'une liste.

Déclaration

"Fn::EachMemberEquals" : [[list_of_strings], string]

Paramètres

exemple

La fonction suivante renvoie true si la balise Department pour l'ensemble des paramètres de type AWS::EC2::VPC::Id a la valeur IT :

"Fn::EachMemberEquals" : [
  {"Fn::ValueOfAll" : ["AWS::EC2::VPC::Id", "Tags.Department"]}, "IT"
]

Fn::EachMemberIn

Renvoie true si chaque membre d'une liste de chaînes correspond au moins à une valeur d'une deuxième liste de chaînes.

Déclaration

"Fn::EachMemberIn" : [[strings_to_check], [strings_to_match]]

Paramètres

exemple

La fonction suivante vérifie si les utilisateurs spécifient un sous-réseau qui constitue un cloud privé virtuel (VPC) valide. Le VPC doit se trouver dans le compte et la région où les utilisateurs interagissent avec la pile. La fonction s'applique à tous les paramètres de type AWS::EC2::Subnet::Id.

"Fn::EachMemberIn" : [ 
  {"Fn::ValueOfAll" : ["AWS::EC2::Subnet::Id", "VpcId"]}, {"Fn::RefAll" : "AWS::EC2::VPC::Id"}
]

Fn::Equals

Compare deux valeurs pour déterminer si elles sont égales. Renvoie true si les deux valeurs sont égales et false si elles ne le sont pas.

Déclaration

"Fn::Equals" : ["value_1", "value_2"]

Paramètres

exemple

L'exemple suivant prend la valeur true si la valeur du paramètre EnvironmentType est égale à prod :

"Fn::Equals" : [{"Ref" : "EnvironmentType"}, "prod"]

Fn::Not

Renvoie true pour une condition qui prend la valeur false, et false pour une condition qui a la valeur true. Fn::Not agit en tant qu'opérateur NOT.

Déclaration

"Fn::Not" : [{condition}]

Paramètres

exemple

L'exemple suivant prend la valeur true si la valeur du paramètre EnvironmentType est égale à prod :

"Fn::Not" : [{"Fn::Equals" : [{"Ref" : "EnvironmentType"}, "prod"]}]

Fn::Or

Renvoie true si l'une des conditions spécifiées a la valeur true, ou false si toutes les conditions ont la valeur false. Fn::Or agit en tant qu'opérateur OR. Le nombre minimum de conditions que vous pouvez inclure est deux, et le maximum est dix.

Déclaration

"Fn::Or" : [{condition}, {...}]

Paramètres

exemple

L'exemple suivant a la valeur true si le nom du groupe de sécurité référencé est égal à sg-mysggroup, ou si la valeur du paramètre InstanceType est t3.large ou t3.small :

"Fn::Or" : [
  {"Fn::Equals" : ["sg-mysggroup", {"Ref" : "ASecurityGroup"}]},
  {"Fn::Contains" : [["t3.large", "t3.small"], {"Ref" : "InstanceType"}]}
]

Fn::RefAll

Renvoie toutes les valeurs pour un type de paramètre spécifié.

Déclaration

"Fn::RefAll" : "parameter_type"

Paramètres

exemple

La fonction suivante renvoie une liste de tous les VPC IDs de la région et Compte AWS dans lesquels la pile est créée ou mise à jour :

"Fn::RefAll" : "AWS::EC2::VPC::Id"

Fn::ValueOf

Renvoie une valeur d'attribut ou une liste des valeurs pour un paramètre et un attribut spécifiques.

Déclaration

"Fn::ValueOf" : [ "parameter_logical_id", "attribute" ]

Paramètres

Exemples

L'exemple suivant renvoie la valeur de la balise Department pour le VPC spécifié par le paramètre ElbVpc :

"Fn::ValueOf" : ["ElbVpc", "Tags.Department"]

Si vous spécifiez plusieurs valeurs pour un paramètre, la ValueOf fonction Fn : : peut renvoyer une liste. Par exemple, vous pouvez spécifier plusieurs sous-réseaux et obtenir une liste de zones de disponibilité où chaque membre est la zone de disponibilité d'un sous-réseau spécifique :

"Fn::ValueOf" : ["ListOfElbSubnets", "AvailabilityZone"]

Fn::ValueOfAll

Renvoie une liste de toutes les valeurs d'attribut pour un type de paramètre et d'attribut donné.

Déclaration

"Fn::ValueOfAll" : ["parameter_type", "attribute"]

Paramètres

exemple

Dans l'exemple suivant, la Fn::ValueOfAll fonction renvoie une liste de valeurs, où chaque membre est la valeur de Department balise associée VPCs à cette balise :

"Fn::ValueOfAll" : ["AWS::EC2::VPC::Id", "Tags.Department"]

Fonctions prises en charge

Vous ne pouvez pas utiliser une autre fonction au sein des fonctions Fn::ValueOf et Fn::ValueOfAll. Par contre, vous pouvez utiliser les fonctions suivantes dans toutes les autres fonctions intrinsèques spécifiques aux règles :

Attributs pris en charge

La liste suivante décrit les valeurs d'attribut que vous pouvez extraire pour des ressources et des types de paramètre spécifiques :