Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

CloudFormation Unterstützung für Spracherweiterungen

Das AWS SAMCLI unterstützt Vorlagen, die die AWS::LanguageExtensions Transformation verwendenFn::ForEach, einschließlichFn::Length,Fn::ToJsonString, und Fn::FindInMap withDefaultValue. Vollständige Referenzinformationen zu diesen Konstrukten finden Sie unter AWS::LanguageExtensions Transform im AWS CloudFormation Benutzerhandbuch.

Informationen zur Verwendung von Spracherweiterungen in einer AWS SAM Vorlage finden Sie AWS::LanguageExtensions im vorherigen Transform AWS::Serverless-2016-10-31 Abschnitt:

Transform:
  - AWS::LanguageExtensions
  - AWS::Serverless-2016-10-31

Wenn der AWS::LanguageExtensions im Transform Abschnitt einer Vorlage AWS SAMCLI erkannt wird und Sie sich für die lokale Verarbeitung entschieden haben, werden die Konstrukte der Spracherweiterungen lokal erweitert, bevor AWS SAM Transformationen ausgeführt werden. Dadurch kannsam build,sam package,sam deploy,sam sync, sam validatesam local invoke, und mit Vorlagen arbeiten sam local start-apisam local start-lambda, die diese Konstrukte verwenden.

Die lokale Verarbeitung ist standardmäßig deaktiviert. Wenn diese Option deaktiviert ist, AWS SAMCLI leitet der die Vorlage unverändert weiter und CloudFormation verarbeitet die AWS::LanguageExtensions Transformation serverseitig bei der Bereitstellung. Informationen zu Aktivierungsmethoden finden Sie unterSpracherweiterungen werden aktiviert.

Die Erweiterung erfolgt in zwei Phasen, wenn sie aktiviert ist:

Die ursprüngliche Vorlage (mit Fn::ForEach intakter Vorlage) wird für die CloudFormation Bereitstellung beibehalten, da die AWS::LanguageExtensions Transformation serverseitig CloudFormation verarbeitet wird.

Spracherweiterungen werden aktiviert

Die lokale Verarbeitung von AWS::LanguageExtensions erfolgt per Opt-In pro Befehl. Es gibt drei äquivalente Aktivierungsmethoden, die in der Reihenfolge ihrer Priorität aufgeführt sind:

Fn:: ForEach

Fn::ForEachgeneriert mehrere Ressourcen, Bedingungen oder Ausgaben aus einer einzigen Vorlagendefinition:

Transform:
  - AWS::LanguageExtensions
  - AWS::Serverless-2016-10-31

Parameters:
  ServiceNames:
    Type: CommaDelimitedList
    Default: "Users,Orders,Products"

Resources:
  Fn::ForEach::Services:
    - Name
    - !Ref ServiceNames
    - ${Name}Function:
        Type: AWS::Serverless::Function
        Properties:
          Handler: index.handler
          Runtime: python3.12
          CodeUri: ./services/${Name}

Beim Ausführen wird dies aufUsersFunction, undOrdersFunction, sam build erweitertProductsFunction, die jeweils aus ihrem jeweiligen Quellverzeichnis erstellt wurden.

Dynamische Artefakteigenschaften

Wenn eine paketierbare Eigenschaft eine Schleifenvariable verwendet (z. B../services/${Name}), AWS SAMCLI generiert sie einen CloudFormation Mappings Abschnitt, der jeden Sammlungswert seinem Amazon S3 zuordnet. URI Der Fn::ForEach Text wird so umgeschrieben, dass er verwendet werden CloudFormation kann, Fn::FindInMap damit er bei der Bereitstellung das richtige Artefakt auflösen kann.

Bei den erkannten Artefakteigenschaften handelt es sich um dieselben, die heute neu geschrieben wurden. sam package Das beinhaltet:

Bei Eigenschaften mit Punkten (z. B. Command.ScriptLocation on AWS::Glue::Job oder Code.ImageUri onAWS::Lambda::Function) wird der Wert an der verschachtelten Position auf der Ressource gelesen und geschrieben. Der generierte Mapping-Name verwendet nur das Blattsegment des Eigenschaftenpfads.

Wenn es sich bei der Eigenschaft um eine Loop-Vorlage handelt, lautet der Mapping-Name SAM<LeafProperty><LoopName> (zum Beispiel oder). SAMCodeUriServices SAMScriptLocationJobs

Zum Beispiel nach: sam package

Mappings:
  SAMCodeUriServices:
    Users:
      CodeUri: s3://my-bucket/abc123
    Orders:
      CodeUri: s3://my-bucket/def456
    Products:
      CodeUri: s3://my-bucket/ghi789

Resources:
  Fn::ForEach::Services:
    - Name
    - !Ref ServiceNames
    - ${Name}Function:
        Type: AWS::Serverless::Function
        Properties:
          Handler: index.handler
          Runtime: python3.12
          CodeUri: !FindInMap [SAMCodeUriServices, !Ref Name, CodeUri]

Mehrere Ressourcen pro ForEach Körper

Ein einzelner Fn::ForEach Körper kann mehr als eine Ressource pro Iteration emittieren. Jede Ressource wird für jeden Sammlungswert generiert:

Resources:
  Fn::ForEach::Tables:
    - TableName
    - [Users, Orders, Products]
    - ${TableName}Table:
        Type: AWS::DynamoDB::Table
        Properties:
          TableName: !Sub "${AWS::StackName}-${TableName}"
          # ...

      ${TableName}StreamProcessor:
        Type: AWS::Serverless::Function
        Properties:
          CodeUri: stream-processors/${TableName}/
          Events:
            DDBStream:
              Type: DynamoDB
              Properties:
                Stream: !GetAtt
                  - !Sub "${TableName}Table"
                  - StreamArn

Zuordnung, Name, Kollision, Auflösung

Wenn zwei Ressourcen im selben Fn::ForEach Hauptteil dieselbe dynamische Artefakteigenschaft deklarieren (z. B. sowohl an als auch als StateMachine useDefinitionUri), wird ein Api Suffix AWS SAMCLI angehängt, das aus dem statischen Teil der Vorlage für die logische ID der Ressource übernommen wurde, um die Zuordnungsnamen eindeutig zu halten:

Liegt keine Kollision vor, wird der Basisname (z. B.SAMDefinitionUriServices) verwendet.

Parameter-based Sammlungen

Wenn es sich bei der Fn::ForEach Sammlung um eine Parameterreferenz handelt (z. B.!Ref ServiceNames) und der Schleifenkörper eine dynamische Artefakteigenschaft verwendet (z. B.CodeUri: ./services/${Name}), AWS SAMCLI benötigt er die Sammlungswerte, um die unter beschriebenen SAM* Zuordnungen zu generieren. Dynamische Artefakteigenschaften Sie werden bei der Verarbeitung der Vorlage wie folgt aufgelöst:

# Package with the values you intend to deploy with
sam package --language-extensions --parameter-overrides ServiceNames="Users,Orders,Products"

# Deploy with the same values
sam deploy --language-extensions --parameter-overrides ServiceNames="Users,Orders,Products"

Verschachtelte Stacks

Fn::ForEachin Nested Stack wird Templates (AWS::CloudFormation::Stack) unterstützt. Der AWS SAMCLI übergibt die Parameters Eigenschaft des übergeordneten Stacks an die Erweiterung der untergeordneten Vorlage, sodass untergeordnete Fn::ForEach Sammlungen, die auf vom Elternteil bereitgestellte Parameter verweisen, korrekt aufgelöst werden.

# parent.yaml
Resources:
  ChildStack:
    Type: AWS::CloudFormation::Stack
    Properties:
      TemplateURL: ./child.yaml
      Parameters:
        ServiceNames: "Users,Orders,Products"

Verschachteltes Fn: ForEach

Es werden bis zu 5 Verschachtelungsebenen unterstützt, die dem CloudFormation Limit entsprechen:

Resources:
  Fn::ForEach::Envs:
    - Env
    - [Dev, Staging, Prod]
    - Fn::ForEach::Services:
        - Svc
        - [Users, Orders]
        - ${Env}${Svc}Function:
            Type: AWS::Serverless::Function
            Properties:
              CodeUri: ./services/${Svc}
              Environment:
                Variables:
                  STAGE: ${Env}

ForEach in den Ausgängen

Fn::ForEachBlöcke werden auch innerhalb des Outputs Abschnitts erweitert, sodass Sie pro Sammlungswert eine Ausgabe ausgeben können:

Outputs:
  Fn::ForEach::FunctionArns:
    - Name
    - [alpha, beta]
    - ${Name}FunctionArn:
        Value: !GetAtt
          - !Sub "${Name}Function"
          - Arn

Bedingungen und DependsOn

Ressourcen, die von Fn::ForEach can emittiert werden, tragen Condition und DependsOn wie jede andere Ressource. Die Bedingung oder Abhängigkeit wird auf jede generierte Ressource repliziert:

Conditions:
  IsProd: !Equals [!Ref Environment, prod]

Resources:
  SharedTable:
    Type: AWS::DynamoDB::Table
    # ...

  Fn::ForEach::Functions:
    - Name
    - [api, worker]
    - ${Name}Function:
        Type: AWS::Serverless::Function
        Condition: IsProd
        DependsOn: SharedTable
        Properties:
          Handler: main.handler
          CodeUri: functions/${Name}/

&{Identifier} -Syntax

Die &{identifier} Syntax entfernt nicht-alphanumerische Zeichen aus dem ersetzten Wert, was nützlich ist, um gültige logische IDs aus Werten wie IP-Adressen zu generieren:

Fn::ForEach::Hosts:
  - IP
  - ["10.0.0.1", "10.0.0.2"]
  - Host&{IP}:
      Type: AWS::EC2::Instance
      # Expands to Host10001, Host10002

Unterstützte systeminterne Funktionen

Die folgenden systemeigenen Funktionen werden während der Erweiterung lokal gelöst:

Funktionen, die bereitgestellte Ressourcen (Fn::GetAtt,,Fn::GetAZs) benötigenFn::ImportValue, werden beibehalten, CloudFormation damit sie bei der Bereitstellung behoben werden können.

Validierungsfehler

Die folgenden Vorlagenprobleme werden lokal erkannt, bevor die AWS SAM Transformation ausgeführt wird:

Einschränkungen

Telemetrie

Das AWS SAMCLI gibt ein CFNLanguageExtensions Telemetrieereignis aus, wenn ein Befehl mit --language-extensions (oder einer entsprechenden Umgebungsvariablen) aufgerufen wird und die Vorlage die Transformation deklariert. AWS::LanguageExtensions Das Ereignis wird einmal pro Aufruf ausgelöst und es wird kein Vorlageninhalt übertragen. Wenn die lokale Verarbeitung ausgeschaltet ist (Standardeinstellung), wird kein Ereignis ausgelöst.