https://github.com/dwolla/cloudflare-public-hostname-lambda
CloudFormation custom resource Lambda to manage DNS records at Cloudflare
https://github.com/dwolla/cloudflare-public-hostname-lambda
aws-lambda cloudflare cloudformation
Last synced: 8 months ago
JSON representation
CloudFormation custom resource Lambda to manage DNS records at Cloudflare
- Host: GitHub
- URL: https://github.com/dwolla/cloudflare-public-hostname-lambda
- Owner: Dwolla
- License: mit
- Created: 2017-03-30T19:32:52.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2023-04-14T16:44:38.000Z (almost 3 years ago)
- Last Synced: 2025-04-06T23:34:37.030Z (11 months ago)
- Topics: aws-lambda, cloudflare, cloudformation
- Language: Scala
- Size: 51.8 KB
- Stars: 2
- Watchers: 15
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cloudflare DNS Record Handler
[](https://travis-ci.org/Dwolla/cloudflare-public-hostname-lambda)
An AWS CloudFormation custom resource that manages a Cloudflare DNS Record.
To run all tests:
```ShellSession
sbt clean 'testOnly -- timefactor 10' 'stack/testOnly -- timefactor 10' stack/it:test
```
## Deploy
To deploy the stack, ensure the required IAM roles exist (`DataEncrypter` and `cloudformation/deployer/cloudformation-deployer`), then deploy with `sbt`:
```ShellSession
sbt -DAWS_ACCOUNT_ID={your-account-id} publish stack/deploy
```
The `publish` task comes from [Dwolla’s S3 sbt plugin](https://github.com/Dwolla/sbt-s3-publisher), and the stack/deploy task comes from [Dwolla’s CloudFormation sbt plugin](https://github.com/Dwolla/sbt-cloudformation-stack).
## CloudFormation Custom Resource
Here is an example of how to include this as a custom resource in a CloudFormation stack.
```json
{
"Parameters": {
"CloudflareEmail": {
"Description": "Email address of the account that can interact with the Cloudflare API",
"Type": "String"
},
"CloudflareKey": {
"Description": "Cloudflare API Key",
"NoEcho": true,
"Type": "String"
}
},
"Resources": {
"CloudflareRecord": {
"Properties": {
"Name": "example.dwolla.net",
"Content": "example.us-west-2.sandbox.dwolla.net",
"Type": "CNAME",
"TTL": 42,
"Proxied": true,
"CloudflareEmail": {
"Ref": "CloudflareEmail"
},
"CloudflareKey": {
"Ref": "CloudflareKey"
},
"ServiceToken": {
"Fn::ImportValue": "CloudflareDnsRecordLambda"
}
},
"Type": "Custom::CloudflareDnsRecord"
}
}
}
```
There are five primary parameters defining the DNS record:
|Parameter Name|Type|Notes|
|--------------|----|-----|
|`Name`|String|The public-facing name of the DNS record. This is what can be resolved.|
|`Content`|String|This is the value of the record. For an `A` record, this should be an IP address. For a `CNAME`, it should be a hostname.|
|`Type`|one of: `A`, `CNAME`, or the other supported Cloudflare record types|May not be modified without deleting the existing record|
|`TTL`|Integer (seconds)|Optional TTL; if not set, Cloudflare assigns an automatic TTL|
|`Proxied`|boolean|Optional; indicates whether requests should be proxied through Cloudflare’s DDoS service.|