No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
test
.gitignore
.travis.yml
.yamllint
LICENSE
README.md
module.yml
package.json

README.md

Build Status NPM version

cfn-modules: AWS EFS file system

AWS EFS file system with alerting.

Install

Install Node.js and npm first!

npm i @cfn-modules/efs-file-system

Usage

By default, the EFS file system is only writable by the Linux root user.

---
AWSTemplateFormatVersion: '2010-09-09'
Description: 'cfn-modules example'
Resources:
  FileSystem:
    Type: 'AWS::CloudFormation::Stack'
    Properties:
      Parameters:
        VpcModule: !GetAtt 'Vpc.Outputs.StackName' # required
        ClientSgModule: !GetAtt 'ClientSg.Outputs.StackName' # required
        AlertingModule: !GetAtt 'Alerting.Outputs.StackName' # optional
        KmsKeyModule: !GetAtt 'Key.Outputs.StackName' # optional
        PerformanceMode: generalPurpose # optional
        NumberOfAvailabilityZones: !GetAtt 'Vpc.Outputs.NumberOfAvailabilityZones' # optional (must match with the value of the vpc module)
      TemplateURL: './node_modules/@cfn-modules/efs-file-system/module.yml'

Parameters

Name Description Default Required? Allowed values
VpcModule Stack name of vpc module yes
ClientSgModule Stack name of client-sg module where traffic is allowed from on port 5432 to the database no
AlertingModule Stack name of alerting module no
KmsKeyModule Stack name of kms-key module no
PerformanceMode The performance mode of the file system generalPurpose no [generalPurpose, maxIO]
NumberOfAvailabilityZones How many availability zones should be used? Same as in the vpc module! 3 no> [2-3]

Limitations

  • Secure: EFS file system is not backed up