Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 1.1 KB

README.md

File metadata and controls

51 lines (37 loc) · 1.1 KB
Raw

Introduction

This module creates an Elastic File System (EFS) service endpoint

Description

This module will create a new EFS service endpoint and security group tied to the provide VPC.

Inputs/Outputs

Input Parameters

Required

  • vpc-id - the VPC ID where this EFS will be tied to via Security Groups
  • removal-policy - the retention policy to put on the EFS service
    • defaults to RETAIN
    • supports DESTROY and RETAIN only

Optional

Input Example

  - name: vpc-id
    valueFrom:
      moduleMetadata:
        group: optionals
        name: networking
        key: VpcId
  - name: removal-policy
    value: RETAIN

Module Metadata Outputs

  • EFSFileSystemArn - the ARN of the EFS
  • EFSFileSystemId - the unique EFS ID
  • EFSSecurityGroupId - the created Security Group tied to the EFS
  • VPCId - the VPC tied to the new EFS

Output Example

{
  "EFSFileSystemArn": "arn:aws:elasticfilesystem:us-east-1:12346789012:file-system/fs-XXXXXXX",
  "EFSFileSystemId": "fs-XXXXXXX",
  "EFSSecurityGroupId": "sg-XXXXXXX",
  "VPCId": "vpc-XXXXXXX"
}