search

KristanMcDonald / serverless-vpc-peering-options

Plugin to set VPC peering options after deployment that are unavailable via Cloudformation
MIT License
0 stars 0 forks source link

readme

serverless-vpc-peering-options

Plugin to set VPC peering options after deployment that are unavailable via Cloudformation

serverless npm version MIT licensed

Why

Cloudformation allows you to create VPC peering connections, which is great - but it then doesn't allow you to set the options assoicated with that peering arrangement. You can only do this from CLI, console or (now) this plugin!

Usage

Installation

npm install serverless-vpc-peering-options --save-dev

Configuration

plugins:
  - serverless-vpc-peering-options

custom:
  vpcPeerOptions:
    peer: YourPeeringResource
    accepterAllowDnsResolutionFromRemoteVpc: true
    accepterAllowEgressFromLocalClassicLinkToRemoteVpc: true
    accepterAllowEgressFromLocalVpcToRemoteClassicLink: false
    requesterAllowDnsResolutionFromRemoteVpc: false
    requesterAllowEgressFromLocalClassicLinkToRemoteVpc: false
    requesterAllowEgressFromLocalVpcToRemoteClassicLink: false
    enabled: true

The peer and enabled parameters are required - everything else defaults to false, and can be left unset (which is the AWS default).