如何使用serverless.yml创建AWS S3存储桶并向其中添加文件？

Question

我想知道是否可以利用 serverless.yml 在 serverless-framework 的部署过程中创建一个存储桶并添加特定的文件。

目前为止，我已经成功添加了创建存储桶的 S3 资源，但不确定如何添加特定的文件。

resources:
  Resources:
    UploadBucket:
      Type: AWS::S3::Bucket
      Properties:
        BucketName: ${self:custom.s3.bucket}
        AccessControl: Private
        CorsConfiguration:
          CorsRules:
          - AllowedMethods:
            - GET
            - PUT
            - POST
            - HEAD
            AllowedOrigins:
            - "*"
            AllowedHeaders:
            - "*"

不确定是否可能，或如何利用serverless.yml在部署过程中上传默认文件（如果尚未存在）。

- Pedro Baptista Afonso

Answer 1

目前AWS CloudFormation没有官方资源来管理（添加/删除）存储桶（Bucket）中的单个S3对象，但您可以使用自定义资源创建一个资源，并使用Lambda函数调用AWS SDK for NodeJS中的PUT Object/DELETE Object API来实现。

以下是完整的CloudFormation模板示例：

Description: Create an S3 Object using a Custom Resource.
Parameters:
  BucketName:
    Description: S3 Bucket Name (must not already exist)
    Type: String
  Key:
    Description: S3 Object Key
    Type: String
  Body:
    Description: S3 Object Body
    Type: String
Resources:
  Bucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: !Ref BucketName
  S3Object:
    Type: Custom::S3Object
    Properties:
      ServiceToken: !GetAtt S3ObjectFunction.Arn
      Bucket: !Ref Bucket
      Key: !Ref Key
      Body: !Ref Body
  S3ObjectFunction:
    Type: AWS::Lambda::Function
    Properties:
      Description: S3 Object Custom Resource
      Handler: index.handler
      Role: !GetAtt LambdaExecutionRole.Arn
      Code:
        ZipFile: !Sub |
          var response = require('cfn-response');
          var AWS = require('aws-sdk');
          var s3 = new AWS.S3();
          exports.handler = function(event, context) {
            var respond = (e) => response.send(event, context, e ? response.FAILED : response.SUCCESS, e ? e : {});
            var params = event.ResourceProperties;
            delete params.ServiceToken;
            if (event.RequestType == 'Create' || event.RequestType == 'Update') {
              s3.putObject(params).promise()
                .then((data)=>respond())
                .catch((e)=>respond(e));
            } else if (event.RequestType == 'Delete') {
              delete params.Body;
              s3.deleteObject(params).promise()
                .then((data)=>respond())
                .catch((e)=>respond(e));
            } else {
              respond({Error: 'Invalid request type'});
            }
          };
      Timeout: 30
      Runtime: nodejs4.3
  LambdaExecutionRole:
    Type: AWS::IAM::Role
    Properties:
      AssumeRolePolicyDocument:
        Version: '2012-10-17'
        Statement:
        - Effect: Allow
          Principal: {Service: [lambda.amazonaws.com]}
          Action: ['sts:AssumeRole']
      Path: /
      ManagedPolicyArns:
      - "arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole"
      Policies:
      - PolicyName: S3Policy
        PolicyDocument:
          Version: '2012-10-17'
          Statement:
            - Effect: Allow
              Action:
                - 's3:PutObject'
                - 'S3:DeleteObject'
              Resource: !Sub "arn:aws:s3:::${BucketName}/${Key}"

您应该能够在serverless.yml配置文件中使用这些资源，但是我不确定Serverless如何与CloudFormation资源/参数完全集成。

- wjordan

---

有关实际用例，请参见 https://serverless-stack.com/chapters/configure-s3-in-serverless.html，其中包含一个SLSF模板。 - Vadorequest

Answer 2

您是否考虑过使用serverless-s3-sync插件。该插件允许您在部署的一部分中从本地计算机上传文件夹到S3。

plugins:
  - serverless-s3-sync

custom:
  s3Sync:
    - bucketName: ${self:custom.s3.bucket} # required
      bucketPrefix: assets/ # optional
      localDir: dist/assets # required

- Sam Williams

---

你知道是否有一种方法仅将文件夹中的特定文件上传到S3而不是整个文件夹吗？ - daniel langer

Answer 3

如果您想要部署网站，可以使用 serverless-finch，如果存储桶不存在，它会自动为您创建。

- V Maharajh