Module: Enscalator::Plugins::Route53

Included in:
RichTemplateDSL
Defined in:
lib/enscalator/plugins/route53.rb

Overview

Create Route53 resources

Constant Summary collapse

HEALTH_CHECK_TYPE =

Valid types for Route53 healthcheck

%w(HTTP HTTPS HTTP_STR_MATCH HTTPS_STR_MATCH TCP)
RECORD_TYPE =

Valid types for dns records

%w(A AAAA CNAME MX NS PTR SOA SPF SRV TXT)

Instance Method Summary collapse

Instance Method Details

#create_healthcheck(app_name, stack_name, fqdn: nil, ip_address: nil, port: 80, type: 'HTTP', resource_path: '/', request_interval: 30, failure_threshold: 3, tags: []) ⇒ Object

Create Route53 healthcheck for given fqdn/ip address

Parameters:

  • app_name (String) —

    application name

  • stack_name (String) —

    stack name

  • fqdn (String) (defaults to: nil) —

    fully qualified domain name (FQDN)

  • ip_address (String) (defaults to: nil) —

    ip address

  • port (Integer) (defaults to: 80) —

    number

  • type (String) (defaults to: 'HTTP') —

    healthcheck type

  • resource_path (String) (defaults to: '/') —

    uri path healthcheck backend would query

  • request_interval (Integer) (defaults to: 30) —

    query intervals for healthcheck backend

  • failure_threshold (Integer) (defaults to: 3) —

    number of accumulated failures to consider endpoint not healthy

  • tags (Array) (defaults to: []) —

    additional tags



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/enscalator/plugins/route53.rb', line 23

def create_healthcheck(app_name,
                       stack_name,
                       fqdn: nil,
                       ip_address: nil,
                       port: 80,
                       type: 'HTTP',
                       resource_path: '/',
                       request_interval: 30,
                       failure_threshold: 3,
                       tags: [])
  unless HEALTH_CHECK_TYPE.include?(type)
    fail("Route53 healthcheck type can only be one of the following: #{HEALTH_CHECK_TYPE.join(',')}")
  end
  fail('Route53 healthcheck requires either fqdn or ip address') unless fqdn || ip_address

  properties = {
    HealthCheckConfig: {
      IPAddress: ip_address,
      FullyQualifiedDomainName: fqdn,
      Port: port,
      Type: type,
      ResourcePath: resource_path,
      RequestInterval: request_interval,
      FailureThreshold: failure_threshold
    }
  }

  properties[:HealthCheckTags] = [
    {
      Key: 'Application',
      Value: app_name
    },
    {
      Key: 'Stack',
      Value: stack_name
    }
  ]

  properties[:HealthCheckTags].concat(tags) unless tags.blank?

  resource "#{app_name}Healthcheck",
           Type: 'AWS::Route53::HealthCheck',
           Properties: properties
end

#create_multiple_dns_records ⇒ Object

RESERVED

Create multiple record sets for given hosted zone



167
168
169
 
# File 'lib/enscalator/plugins/route53.rb', line 167

def create_multiple_dns_records
  fail('method "create_multiple_dns_records" is not implemented')
end

#create_private_hosted_zone ⇒ Object

RESERVED

Create new private hosted zone



98
99
100
 
# File 'lib/enscalator/plugins/route53.rb', line 98

def create_private_hosted_zone
  fail('method "create_private_hosted_zone" is not implemented')
end

#create_public_hosted_zone(app_name, stack_name, name, comment, tags: []) ⇒ Object

Create new public hosted zone



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/enscalator/plugins/route53.rb', line 69

def create_public_hosted_zone(app_name, stack_name, name, comment, tags: [])
  properties = {
    Name: name
  }

  properties[:HostedZoneConfig] = {
    Comment: comment
  } unless comment.blank?

  properties[:HostedZoneTags] = [
    {
      Key: 'Application',
      Value: app_name
    },
    {
      Key: 'Stack',
      Value: stack_name
    }
  ]
  properties[:HostedZoneTags].concat(tags) unless tags.blank?

  resource_name = "#{app_name}HostedZone"
  resource resource_name,
           Type: 'AWS::Route53::HostedZone',
           Properties: properties
  resource_name
end

#create_single_dns_record(app_name, stack_name, zone_name, record_name, ttl: 300, type: 'A', healthcheck: nil, zone_id: nil, alias_target: {}, resource_records: []) ⇒ Object

Create new single record set for given hosted zone

Parameters:

  • app_name (String) —

    application name

  • stack_name (String) —

    stack name

  • zone_name (String) —

    hosted zone name

  • record_name (String) —

    dns record name

  • ttl (Integer) (defaults to: 300) —

    time to live

  • type (String) (defaults to: 'A') —

    dns record type

  • healthcheck (Hash) (defaults to: nil) —

    reference to the healthcheck resource

  • alias_target (Hash) (defaults to: {}) —

    alias target

  • resource_records (Array) (defaults to: []) —

    resources associated with record_name



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/enscalator/plugins/route53.rb', line 115

def create_single_dns_record(app_name,
                             stack_name,
                             zone_name,
                             record_name,
                             ttl: 300,
                             type: 'A',
                             healthcheck: nil,
                             zone_id: nil,
                             alias_target: {},
                             resource_records: [])
  if type && !RECORD_TYPE.include?(type)
    fail("Route53 record type can only be one of the following: #{RECORD_TYPE.join(',')}")
  end
  if healthcheck && (!healthcheck.is_a?(Hash) || !healthcheck.include?(:Ref))
    fail('healthcheck must be a valid cloudformation Ref function')
  end
  if alias_target && (!alias_target.is_a?(Hash))
    fail('AliasTarget must be a Hash')
  end

  name = app_name || stack_name.titleize.remove(/\s/)
  properties = {
    Name: record_name,
    Comment: "#{type} record for #{[app_name, 'in '].join(' ') if app_name}#{stack_name} stack",
    Type: type
  }

  # HostedZoneId and HostedZoneName options are mutually exclusive
  if zone_id && !zone_id.nil?
    properties[:HostedZoneId] = zone_id
  else
    properties[:HostedZoneName] = zone_name
  end

  if !alias_target.blank?
    fail('AliasTarget can be created only for A or AAAA type records') unless %w(A AAAA).include?(type)
    unless alias_target.key?(:HostedZoneId) && alias_target.key?(:DNSName)
      fail('AliasTarget must have HostedZoneId and DNSName properties')
    end
    properties[:AliasTarget] = alias_target
  else
    properties[:TTL] = ttl
    properties[:HealthCheckId] = healthcheck if healthcheck
    properties[:ResourceRecords] = resource_records.empty? ? ref("#{app_name}PublicIpAddress") : resource_records
  end

  resource "#{name}Hostname",
           Type: 'AWS::Route53::RecordSet',
           Properties: properties
end