lulo-plugin-apigateway-domain-name

2.1.0 • Public • Published

lulo Amazon API Gateway Domain Name

lulo Amazon API Gateway Domain Name creates a new Domain Name that can be used for API Gateway.

lulo Amazon API Gateway Domain Name is a lulo plugin

Installation

npm install lulo-plugin-api-gateway-domain-name --save

Usage

Properties

  • domainName: The domain name. Required
  • certificateName: The name of the certificate. Required
  • certificateArn: ACM Certificate arn, must be issued in us-east-1. Conditional. Since 2.0.0

Note: The following parameters are still supported but have been deprecated. Use certificateArn instead.

  • certificateChain: The certificate chain. Deprecated since 2.0.0
  • certificateBody: The certificate body. Deprecated since 2.0.0
  • certificatePrivateKey: The certificate private key. Deprecated since 2.0.0

Note: API Gateway does not allow modifications to the certificate except for certificateName. If you need to renew the certificate, please use the API Gateway Console. Changes to the other properties will have no effect on the resource.

Return Values

Fn::GetAtt

distributionDomainName The product { "Fn::GetAtt": ["DomainName", "distributionDomainName"] }. Note: You must create a DNS record matching domainName pointing to this distribution.

Required IAM Permissions

The Custom Resource Lambda requires the following permissions for this plugin to work:

{
   "Effect": "Allow",
   "Action": [
        "apigateway:*",
        "cloudfront:UpdateDistribution"
   ],
   "Resource": "*"
}

License

The MIT License (MIT)

Change Log

Change Log

Package Sidebar

Install

npm i lulo-plugin-apigateway-domain-name

Weekly Downloads

0

Version

2.1.0

License

MIT

Unpacked Size

24.1 kB

Total Files

9

Last publish

Collaborators

  • polythene