Skip to content

Latest commit

 

History

History
59 lines (46 loc) · 1.67 KB

README.md

File metadata and controls

59 lines (46 loc) · 1.67 KB
Raw

apigateway-rest CfHighlander component

Build status

cftest workflow

Parameters

Name Use Default Global Type Allowed Values
EnvironmentName Tagging dev true String
EnvironmentType Tagging development true String ['development','production']
DomainName The fully qualified domain name (FQDN), such as www.example.com, with which you want to secure an ACM certificate false string
EdgeCertificateArn The ACM cert ARN created in us-east-1 false String
RegionalCertificateArn The regional ACM cert ARN false String
NetworkLoadBalander The ARN of a NLB for creating a VPC Link for this API Gateway false String

Outputs/Exports

Name Value Exported
RestApiId RestApiId true
RestApiStage RestApiStage true

Included Components

Example Configuration

Highlander

  Component name: 'apigateway', template: 'apigateway-rest' do
    parameter name: 'VPCId', value: root_domain
    parameter name: 'EdgeCertificateArn', value: cfout('acmv2', 'CertificateArn')
    parameter name: 'RegionalCertificateArn', value: cfout('acmv2', 'CertificateArn')
  end

API Gateway (Rest) Configuration

api_name: 'app1_api'

Cfhighlander Setup

install cfhighlander gem

gem install cfhighlander

or via docker

docker pull theonestack/cfhighlander

Testing Components

Running the tests

cfhighlander cftest efs-v2