Vorlageneinschränkungsregeln

Die Regeln, die Vorlageneinschränkungen in einem AWS Service Catalog Portfolio definieren, beschreiben, wann Endbenutzer die Vorlage verwenden können und welche Werte sie für Parameter angeben können, die in der AWS CloudFormation Vorlage deklariert sind, die zum Erstellen des Produkts verwendet wird, das sie verwenden möchten. Regeln sind nützlich, um zu verhindern, dass Endbenutzer unabsichtlich einen falschen Wert angeben. Sie können beispielsweise eine Regel hinzufügen, um zu überprüfen, ob Endbenutzer ein gültiges Subnetz in einer bestimmten VPC angegeben oder m1.small-Instance-Typen für Testumgebungen verwendet haben. AWS CloudFormation verwendet Regeln, um Parameterwerte zu validieren, bevor die Ressourcen für das Produkt erstellt werden.

Jede Regel besteht aus zwei Eigenschaften: eine Regelbedingung (optional) und Assertions (erforderlich). Die Regelbedingung bestimmt, wann eine Regel wirksam wird. Die Assertions beschreiben, welche Werte Benutzer für einen bestimmten Parameter angeben können. Wenn Sie keine Regelbedingung definieren, werden die Assertions der Regel immer wirksam. Zum Definieren einer Regelbedingung und von Assertions verwenden Sie regelspezifische intrinsische Funktionen. Dies sind Funktionen, die nur im Abschnitt Rules einer Vorlage verwendet werden können. Sie können Funktionen verschachteln, aber das Endergebnis einer Regelbedingung oder Assertion muss entweder "true" oder "false" lauten.

Beispiel: Angenommen, Sie haben eine VPC und einen Subnetzparameter im Abschnitt Parameters deklariert. Sie können eine Regel erstellen, die validiert, das sich ein angegebenes Subnetz in einer bestimmten VPC befindet. Wenn ein Benutzer eine VPC angibt, wertet AWS CloudFormation die Assertion aus, um zu überprüfen, ob sich der Subnetzparameterwert in dieser VPC befindet, bevor der Stack erstellt oder aktualisiert wird. Wenn der Parameterwert ungültig ist, tritt sofort ein Fehler auf und AWS CloudFormation erstellt oder aktualisiert den Stack nicht. Wenn Benutzer keine VPC angeben, überprüft AWS CloudFormation den Subnetzparameterwert nicht.

Syntax

Der Abschnitt Rules einer Vorlage besteht aus dem Schlüsselnamen Rules, gefolgt von einem einzigen Doppelpunkt. Regeldeklarationen werden durch Klammern eingeschlossen. Wenn Sie mehrere Regeln deklarieren, werden sie durch Kommas getrennt. Für jede Regel deklarieren Sie einen logischen Namen in Anführungszeichen gefolgt von einem Doppelpunkt und Klammern, die die Regelbedingung und Assertionen umschließen.

Eine Regel kann eine RuleCondition-Eigenschaft enthalten und muss eine Assertions-Eigenschaft einschließen. Für jede Regel können Sie nur eine Regelbedingung definieren. Innerhalb der Assertions-Eigenschaft können Sie eine oder mehrere Assertionen definieren. Sie definieren eine Regelbedingung und Assertionen mit regelspezifischen intrinsischen Funktionen, wie in der folgenden Pseudovorlage dargestellt:

"Rules":{
   "Rule01":{
      "RuleCondition":{
         "Rule-specific intrinsic function"
      },
      "Assertions":[
         {
            "Assert":{
               "Rule-specific intrinsic function"
            },
            "AssertDescription":"Information about this assert"
         },
         {
            "Assert":{
               "Rule-specific intrinsic function"
            },
            "AssertDescription":"Information about this assert"
         }
      ]
   },
   "Rule02":{
      "Assertions":[
         {
            "Assert":{
               "Rule-specific intrinsic function"
            },
            "AssertDescription":"Information about this assert"
         }
      ]
   }
}

Die Pseudovorlage zeigt einen Rules-Abschnitt mit zwei Regeln namens Rule01 und Rule02 an. Rule01 enthält eine Regelbedingung und zwei Assertionen. Wenn die Funktion in der Regelbedingung mit "true" ausgewertet wird, werden beide Funktionen in jeder Assertion ausgewertet und angewendet. Wenn die Regelbedingung "false" ergibt, wird die Regel nicht wirksam. Rule02 ist stets wirksam, da sie über keine Regelbedingung verfügt. Dies bedeutet, dass die eine Assertion immer ausgewertet und angewendet wird.

Informationen zu regelspezifischen intrinsischen Funktionen zum Definieren von Regelbedingungen und Assertionen finden Sie unter AWS Regelfunktionen im AWS CloudFormation -Benutzerhandbuch.

Beispiel: Bedingtes Überprüfen eines Parameterwerts

Die beiden folgenden Regeln überprüfen den Wert des Parameters InstanceType. Je nach Wert des Environment-Parameters (test oder prod) muss der Benutzer m1.small oder m1.large für den InstanceType-Parameter angeben. Die Parameter InstanceType und Environment müssen im Parameters-Abschnitt derselben Vorlage deklariert sein.

"Rules" : {
  "testInstanceType" : {
    "RuleCondition" : {"Fn::Equals":[{"Ref":"Environment"}, "test"]},
    "Assertions" : [
      {
        "Assert" :  { "Fn::Contains" : [ ["m1.small"], {"Ref" : "InstanceType"} ] },
        "AssertDescription" : "For the test environment, the instance type must be m1.small"
      }
    ]
  },
  "prodInstanceType" : {
    "RuleCondition" : {"Fn::Equals":[{"Ref":"Environment"}, "prod"]},
    "Assertions" : [
      {
        "Assert" :  { "Fn::Contains" : [ ["m1.large"], {"Ref" : "InstanceType"} ] },
        "AssertDescription" : "For the prod environment, the instance type must be m1.large"
      }
    ]
  }
}