Wie löse ich zirkuläre Abhängigkeiten mit AWS Serverless Application Model (SAM) -Vorlagen in CloudFormation?

Kurzbeschreibung

Sie erhalten eine Fehlermeldung in CloudFormation, wenn Sie die folgende AWS-SAM-Beispielvorlage verwenden:

AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
Description: Circular Dependency
Resources:
  Bucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: !Sub "{AWS::StackName}-${AWS::Region}-${AWS::AccountId}"
  Function:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: s3://mybucket/function.zip
      Runtime: nodejs12.x
      Handler: index.handler
      Policies:
        - Version: 2012-10-17
          Statement:
            - Effect: Allow
              Action: s3:GetObject*
              Resource: !Sub "arn:aws:s3:::${Bucket}*"
      Events:
        Upload:
          Properties:
            Bucket:
              Ref: Bucket
            Events: s3:ObjectCreated:*
          Type: S3

Die Vorlage erzeugt einen Fehler, da sie die folgende zirkuläre Abhängigkeit erzeugt:

1. Die Bucket -Ressource hängt von der FunctionUploadPermission ab.
2. Die FunctionUploadPermission hängt von der Funktion ab.
3. Die Funktion hängt von der FunctionRole ab.
4. FunctionRole hängt von der Bucket-Ressource ab, die eine Schleife erzeugt.

Hinweis: In der Fehlermeldung ist die FunctionUploadPermission-Ressource vom Typ AWS::Lambda::Permission. Diese Ressource wird von AWS SAM automatisch generiert, wenn die Eigenschaft Events für AWS::Serverless::Function angegeben wird. Die FunctionRole-Ressource ist vom Typ AWS::IAM::Role. Diese Ressource wird von AWS SAM automatisch generiert, wenn die Rolleneigenschaft für AWS::Serverless::Function nicht angegeben ist.

Um die zirkuläre Abhängigkeit zu lösen, müssen Sie die Schleife unterbrechen, indem Sie den dynamischen Verweis auf die Bucket-Ressource ersetzen.

Behebung

Ersetzen Sie die CloudFormation-Vorlage, die eine zirkuläre Abhängigkeit hat, durch die folgende Vorlage:

Permission is hereby granted, free of charge, to any person obtaining a copy of this
software and associated documentation files (the "Software"), to deal in the Software
without restriction, including without limitation the rights to use, copy, modify,
merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
Description: Circular Dependency
Resources:
  Bucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: !Sub "${AWS::StackName}-${AWS::Region}-${AWS::AccountId}"
  Function:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: s3://mybucket/function.zip
      Runtime: nodejs12.x
      Handler: index.handler
      Policies:
        - Version: 2012-10-17
          Statement:
            - Effect: Allow
              Action: s3:GetObject*
              Resource: !Sub "arn:aws:s3:::${AWS::StackName}-${AWS::Region}-${AWS::AccountId}*"
      Events:
        Upload:
          Properties:
            Bucket:
              Ref: Bucket
            Events: s3:ObjectCreated:*
          Type: S3

In der Vorlage verwendet der Bucket-Name im Abschnitt Ressourcen der Policy-Anweisung dieselben Pseudo-Parameter, die in der Eigenschaft BucketName-Ressource verwendet werden. Jetzt können Sie den Bucket-Namen übergeben, ohne direkt auf diesen Bucket zu verweisen. Folglich ist der Fehler behoben, da die zirkuläre Abhängigkeitsschleife unterbrochen ist. Das heißt, die zirkuläre Abhängigkeitsschleife, die sich aus der FunctionRole in Abhängigkeit von der Bucket -Ressource ergab.

Hinweis: Ersetzen Sie s3://mybucket/function.zip durch Ihren Speicherort.

Weitere Informationen

Fn::Sub (intrinsic function)

Ref (intrinsic function)

AWS::Serverless::Function

AWS::S3::Bucket