Class: MintPress::Aws::Route53::HealthCheck

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb

Properties (Read/Write)

  • #caller_reference ⇒ [String]
    'A unique string that you specified when you created the health check.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::HealthCheck"
    • orig_name ⇒ 'caller_reference'
    • create_health_check_prop ⇒ 'caller_reference'
    • read_only ⇒ false
    

29
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 29

property :caller_reference, disposition: :attribute, description: 'A unique string that you specified when you created the health check.', source: "MintPress::Aws::Route53::HealthCheck", orig_name: 'caller_reference', type: [String], create_health_check_prop: 'caller_reference', read_only: false
  • #cloud_watch_alarm_configuration ⇒ [MintPress::Aws::Route53::CloudWatchAlarmConfiguration] (Default Value: MintPress::Aws::Route53::CloudWatchAlarmConfiguration.new)
    'A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::HealthCheck"
    • orig_name ⇒ 'cloud_watch_alarm_configuration'
    • default ⇒ MintPress::Aws::Route53::CloudWatchAlarmConfiguration.new
    

30
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 30

property :cloud_watch_alarm_configuration, disposition: :attribute, description: 'A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.', source: "MintPress::Aws::Route53::HealthCheck", orig_name: 'cloud_watch_alarm_configuration', type: [MintPress::Aws::Route53::CloudWatchAlarmConfiguration], default: MintPress::Aws::Route53::CloudWatchAlarmConfiguration.new
  • #health_check_config ⇒ [MintPress::Aws::Route53::HealthCheckConfig] (Default Value: MintPress::Aws::Route53::HealthCheckConfig.new)
    'A complex type that contains detailed information about one health check.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::HealthCheck"
    • orig_name ⇒ 'health_check_config'
    • default ⇒ MintPress::Aws::Route53::HealthCheckConfig.new
    • create_health_check_prop ⇒ 'health_check_config'
    • read_only ⇒ false
    

31
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 31

property :health_check_config, disposition: :attribute, description: 'A complex type that contains detailed information about one health check.', source: "MintPress::Aws::Route53::HealthCheck", orig_name: 'health_check_config', type: [MintPress::Aws::Route53::HealthCheckConfig], default: MintPress::Aws::Route53::HealthCheckConfig.new, create_health_check_prop: 'health_check_config', read_only: false
  • #health_check_version ⇒ [Integer]
    'A sequential counter that Amazon Route 53 sets to 1 when you create a health check and increments by 1 each time you update settings for the health check. We recommend that you use GetHealthCheck or ListHealthChecks to get the current value of HealthCheckVersion for the health check that you want to update, and that you include that value in your UpdateHealthCheck request. This prevents Route 53 from overwriting an intervening update: If the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the health check, Route 53 updates the health check with the new settings. If the value of HealthCheckVersion in the health check is greater, the health check was changed after you got the version number. Route 53 does not update the health check, and it returns a HealthCheckVersionMismatch error.'
    Property Attributes
    • source ⇒ "update_health_check"
    • orig_name ⇒ 'health_check_version'
    • update_health_check_prop ⇒ 'health_check_version'
    • read_only ⇒ false
    

32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 32

property :health_check_version, description: 'A sequential counter that Amazon Route 53 sets to 1 when you create
a health check and increments by 1 each time you update settings for
the health check.

We recommend that you use GetHealthCheck or ListHealthChecks to
get the current value of HealthCheckVersion for the health check
that you want to update, and that you include that value in your
UpdateHealthCheck request. This prevents Route 53 from overwriting
an intervening update:


If the value in the UpdateHealthCheck request matches the value of
HealthCheckVersion in the health check, Route 53 updates the
health check with the new settings.
If the value of HealthCheckVersion in the health check is greater,
the health check was changed after you got the version number. Route
53 does not update the health check, and it returns a
HealthCheckVersionMismatch error.', source: "update_health_check", orig_name: 'health_check_version', type: [Integer], update_health_check_prop: 'health_check_version', read_only: false
  • #id ⇒ [String]
    'The ID for the health check for which you want detailed information. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.'
    Property Attributes
    • source ⇒ "update_health_check"
    • orig_name ⇒ 'id'
    • delete_health_check_prop ⇒ 'health_check_id'
    • read_only ⇒ false
    • get_health_check_prop ⇒ 'health_check_id'
    • update_health_check_prop ⇒ 'health_check_id'
    

50
51
52
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 50

property :id, description: 'The ID for the health check for which you want detailed information.
When you created the health check, CreateHealthCheck returned the ID
in the response, in the HealthCheckId element.', source: "update_health_check", orig_name: 'id', type: [String], delete_health_check_prop: 'health_check_id', read_only: false, get_health_check_prop: 'health_check_id', update_health_check_prop: 'health_check_id', array: false, hash: false
  • #linked_service ⇒ [MintPress::Aws::Route53::LinkedService] (Default Value: MintPress::Aws::Route53::LinkedService.new)
    'If the health check was created by another service, the service that created the health check.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::HealthCheck"
    • orig_name ⇒ 'linked_service'
    • default ⇒ MintPress::Aws::Route53::LinkedService.new
    

53
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 53

property :linked_service, disposition: :attribute, description: 'If the health check was created by another service, the service that created the health check.', source: "MintPress::Aws::Route53::HealthCheck", orig_name: 'linked_service', type: [MintPress::Aws::Route53::LinkedService], default: MintPress::Aws::Route53::LinkedService.new
  • #max_items ⇒ [Integer]
    'The maximum number of health checks that you want ListHealthChecks to return in response to the current request. Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Route 53 returns only the first 100 health checks.'
    Property Attributes
    • list_health_checks_prop ⇒ 'max_items'
    • read_only ⇒ false
    • source ⇒ "list_health_checks"
    

54
55
56
57
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 54

property :max_items, list_health_checks_prop: 'max_items', type: [Integer], read_only: false, source: "list_health_checks", description: 'The maximum number of health checks that you want ListHealthChecks
to return in response to the current request. Amazon Route 53 returns
a maximum of 100 items. If you set MaxItems to a value greater than
100, Route 53 returns only the first 100 health checks.'
  • #ip_address ⇒ [String]
    'The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don"t specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Route 53 then checks the health of the endpoint. Use one of the following formats for the value of IPAddress: IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44. IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345. If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, see the applicable documentation: Linux: Elastic IP Addresses (EIP) in the Amazon EC2 User Guide for Linux Instances Windows: Elastic IP Addresses (EIP) in the Amazon EC2 User Guide for Windows Instances If a health check already has a value for IPAddress, you can change the value. However, you can"t update an existing health check to add or remove the value of IPAddress. For more information, see FullyQualifiedDomainName. Constraints: Route 53 can"t check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can"t create health checks, see the following documents: RFC 5735, Special Use IPv4 Addresses RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space RFC 5156, Special-Use IPv6 Addresses'
    Property Attributes
    • update_health_check_prop ⇒ 'ip_address'
    • read_only ⇒ false
    • source ⇒ "update_health_check"
    

58
59
60
61
62
63
64
65
66
67
68
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
96
97
98
99
100
101
102
103
104
105
106
107
108
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 58

property :ip_address, update_health_check_prop: 'ip_address', type: [String], read_only: false, source: "update_health_check", description: 'The IPv4 or IPv6 IP address for the endpoint that you want Amazon
Route 53 to perform health checks on. If you don"t specify a value
for IPAddress, Route 53 sends a DNS request to resolve the domain
name that you specify in FullyQualifiedDomainName at the interval
that you specify in RequestInterval. Using an IP address that is
returned by DNS, Route 53 then checks the health of the endpoint.

Use one of the following formats for the value of IPAddress:


IPv4 address: four values between 0 and 255, separated by
periods (.), for example, 192.0.2.44.
IPv6 address: eight groups of four hexadecimal values,
separated by colons (:), for example,
2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6
addresses as described in RFC 5952, for example,
2001:db8:85a3::abcd:1:2345.



If the endpoint is an EC2 instance, we recommend that you create an
Elastic IP address, associate it with your EC2 instance, and specify
the Elastic IP address for IPAddress. This ensures that the IP
address of your instance never changes. For more information, see the
applicable documentation:


Linux: Elastic IP Addresses (EIP) in the Amazon EC2 User Guide
for Linux Instances
Windows: Elastic IP Addresses (EIP) in the Amazon EC2 User
Guide for Windows Instances



 If a health check already has a value for IPAddress, you can change
the value. However, you can"t update an existing health check to add
or remove the value of IPAddress.

 

For more information, see FullyQualifiedDomainName.

Constraints: Route 53 can"t check the health of endpoints for which
the IP address is in local, private, non-routable, or multicast
ranges. For more information about IP addresses for which you can"t
create health checks, see the following documents:


RFC 5735, Special Use IPv4 Addresses
RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space
RFC 5156, Special-Use IPv6 Addresses'
  • #port ⇒ [Integer]
    'The port on the endpoint that you want Amazon Route 53 to perform health checks on. Don"t specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED.'
    Property Attributes
    • update_health_check_prop ⇒ 'port'
    • read_only ⇒ false
    • source ⇒ "update_health_check"
    

109
110
111
112
113
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 109

property :port, update_health_check_prop: 'port', type: [Integer], read_only: false, source: "update_health_check", description: 'The port on the endpoint that you want Amazon Route 53 to perform
health checks on.

 Don"t specify a value for Port when you specify a value for Type
of CLOUDWATCH_METRIC or CALCULATED.'
  • #resource_path ⇒ [String]
    'The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y. Specify this value only if you want to change it.'
    Property Attributes
    • update_health_check_prop ⇒ 'resource_path'
    • read_only ⇒ false
    • source ⇒ "update_health_check"
    

114
115
116
117
118
119
120
121
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 114

property :resource_path, update_health_check_prop: 'resource_path', type: [String], read_only: false, source: "update_health_check", description: 'The path that you want Amazon Route 53 to request when performing
health checks. The path can be any value for which your endpoint will
return an HTTP status code of 2xx or 3xx when the endpoint is healthy,
for example the file /docs/route53-health-check.html. You can also
include query string parameters, for example,
/welcome.html?language=jp&login=y.

Specify this value only if you want to change it.'
  • #fully_qualified_domain_name ⇒ [String] (Default Value: Proc.new { self.name })
    'Amazon Route 53 behavior depends on whether you specify a value for IPAddress. If a health check already has a value for IPAddress, you can change the value. However, you can"t update an existing health check to add or remove the value of IPAddress. If you specify a value for IPAddress: Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks. When Route 53 checks the health of an endpoint, here is how it constructs the Host header: If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header. If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header. If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header. If you don"t specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the above cases. If you don"t specify a value for IPAddress: If you don"t specify a value for IPAddress, Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is returned by DNS, Route 53 then checks the health of the endpoint. If you don"t specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there"s no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error. If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com). In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable. In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn"t pass a Host header.'
    Property Attributes
    • update_health_check_prop ⇒ 'fully_qualified_domain_name'
    • read_only ⇒ false
    • source ⇒ "update_health_check"
    • default ⇒ Proc.new { self.name }
    

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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 122

property :fully_qualified_domain_name, update_health_check_prop: 'fully_qualified_domain_name', type: [String], read_only: false, source: "update_health_check", description: 'Amazon Route 53 behavior depends on whether you specify a value for
IPAddress.

 If a health check already has a value for IPAddress, you can change
the value. However, you can"t update an existing health check to add
or remove the value of IPAddress.

 

If you specify a value for IPAddress:

Route 53 sends health check requests to the specified IPv4 or IPv6
address and passes the value of FullyQualifiedDomainName in the
Host header for all health checks except TCP health checks. This is
typically the fully qualified DNS name of the endpoint on which you
want Route 53 to perform health checks.

When Route 53 checks the health of an endpoint, here is how it
constructs the Host header:


If you specify a value of 80 for Port and HTTP or
HTTP_STR_MATCH for Type, Route 53 passes the value of
FullyQualifiedDomainName to the endpoint in the Host header.
If you specify a value of 443 for Port and HTTPS or
HTTPS_STR_MATCH for Type, Route 53 passes the value of
FullyQualifiedDomainName to the endpoint in the Host header.
If you specify another value for Port and any value except TCP
for Type, Route 53 passes 
FullyQualifiedDomainName:Port  to the
endpoint in the Host header.



If you don"t specify a value for FullyQualifiedDomainName, Route 53
substitutes the value of IPAddress in the Host header in each of
the above cases.

If you don"t specify a value for IPAddress:

If you don"t specify a value for IPAddress, Route 53 sends a DNS
request to the domain that you specify in FullyQualifiedDomainName
at the interval you specify in RequestInterval. Using an IPv4
address that is returned by DNS, Route 53 then checks the health of
the endpoint.

 If you don"t specify a value for IPAddress, Route 53 uses only IPv4
to send health checks to the endpoint. If there"s no resource record
set with a type of A for the name that you specify for
FullyQualifiedDomainName, the health check fails with a "DNS
resolution failed" error.

 

If you want to check the health of weighted, latency, or failover
resource record sets and you choose to specify the endpoint only by
FullyQualifiedDomainName, we recommend that you create a separate
health check for each endpoint. For example, create a health check for
each HTTP server that is serving content for www.example.com. For the
value of FullyQualifiedDomainName, specify the domain name of the
server (such as us-east-2-www.example.com), not the name of the
resource record sets (www.example.com).

In this configuration, if the value of FullyQualifiedDomainName
matches the name of the resource record sets and you then associate
the health check with those resource record sets, health check results
will be unpredictable.

In addition, if the value of Type is HTTP, HTTPS,
HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of
FullyQualifiedDomainName in the Host header, as it does when you
specify a value for IPAddress. If the value of Type is TCP,
Route 53 doesn"t pass a Host header.', default: Proc.new { self.name }
  • #search_string ⇒ [String]
    'If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. (You can"t change the value of Type when you update a health check.)'
    Property Attributes
    • update_health_check_prop ⇒ 'search_string'
    • read_only ⇒ false
    • source ⇒ "update_health_check"
    

195
196
197
198
199
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 195

property :search_string, update_health_check_prop: 'search_string', type: [String], read_only: false, source: "update_health_check", description: 'If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the
string that you want Amazon Route 53 to search for in the response
body from the specified resource. If the string appears in the
response body, Route 53 considers the resource healthy. (You can"t
change the value of Type when you update a health check.)'
  • #failure_threshold ⇒ [Integer]
    'The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide. If you don"t specify a value for FailureThreshold, the default value is three health checks.'
    Property Attributes
    • update_health_check_prop ⇒ 'failure_threshold'
    • read_only ⇒ false
    • source ⇒ "update_health_check"
    

200
201
202
203
204
205
206
207
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 200

property :failure_threshold, update_health_check_prop: 'failure_threshold', type: [Integer], read_only: false, source: "update_health_check", description: 'The number of consecutive health checks that an endpoint must pass or
fail for Amazon Route 53 to change the current status of the endpoint
from unhealthy to healthy or vice versa. For more information, see
How Amazon Route 53 Determines Whether an Endpoint Is Healthy in
the Amazon Route 53 Developer Guide.

If you don"t specify a value for FailureThreshold, the default
value is three health checks.'
  • #inverted ⇒ [TrueClass,FalseClass]
    'Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.'
    Property Attributes
    • update_health_check_prop ⇒ 'inverted'
    • read_only ⇒ false
    • source ⇒ "update_health_check"
    

208
209
210
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 208

property :inverted, update_health_check_prop: 'inverted', type: [TrueClass,FalseClass], read_only: false, source: "update_health_check", description: 'Specify whether you want Amazon Route 53 to invert the status of a
health check, for example, to consider a health check unhealthy when
it otherwise would be considered healthy.'
  • #disabled ⇒ [TrueClass,FalseClass]
    'Stops Route 53 from performing health checks. When you disable a health check, here"s what happens: Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource. Calculated health checks: Route 53 stops aggregating the status of the referenced health checks. Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics. After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted. Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.'
    Property Attributes
    • update_health_check_prop ⇒ 'disabled'
    • read_only ⇒ false
    • source ⇒ "update_health_check"
    

211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 211

property :disabled, update_health_check_prop: 'disabled', type: [TrueClass,FalseClass], read_only: false, source: "update_health_check", description: 'Stops Route 53 from performing health checks. When you disable a
health check, here"s what happens:


Health checks that check the health of endpoints: Route 53 stops
submitting requests to your application, server, or other resource.
Calculated health checks: Route 53 stops aggregating the status
of the referenced health checks.
Health checks that monitor CloudWatch alarms: Route 53 stops
monitoring the corresponding CloudWatch metrics.



After you disable a health check, Route 53 considers the status of the
health check to always be healthy. If you configured DNS failover,
Route 53 continues to route traffic to the corresponding resources. If
you want to stop routing traffic to a resource, change the value of
Inverted.

Charges for a health check still apply when the health check is
disabled. For more information, see Amazon Route 53 Pricing.'
  • #health_threshold ⇒ [Integer]
    'The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks and ChildHealthCheck elements. Note the following: If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy. If you specify 0, Route 53 always considers this health check to be healthy.'
    Property Attributes
    • update_health_check_prop ⇒ 'health_threshold'
    • read_only ⇒ false
    • source ⇒ "update_health_check"
    

232
233
234
235
236
237
238
239
240
241
242
243
244
245
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 232

property :health_threshold, update_health_check_prop: 'health_threshold', type: [Integer], read_only: false, source: "update_health_check", description: 'The number of child health checks that are associated with a
CALCULATED health that Amazon Route 53 must consider healthy for the
CALCULATED health check to be considered healthy. To specify the
child health checks that you want to associate with a CALCULATED
health check, use the ChildHealthChecks and ChildHealthCheck
elements.

Note the following:


If you specify a number greater than the number of child health
checks, Route 53 always considers this health check to be unhealthy.
If you specify 0, Route 53 always considers this health check to
be healthy.'
  • #child_health_checks ⇒ Array of ⇒ [String]
    'A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.'
    Property Attributes
    • update_health_check_prop ⇒ 'child_health_checks'
    • read_only ⇒ false
    • source ⇒ "update_health_check"
    

246
247
248
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 246

property :child_health_checks, update_health_check_prop: 'child_health_checks', type: [String], array: true, read_only: false, source: "update_health_check", description: 'A complex type that contains one ChildHealthCheck element for each
health check that you want to associate with a CALCULATED health
check.'
  • #enable_sni ⇒ [TrueClass,FalseClass]
    'Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate. Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don"t enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you"re still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid. The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.'
    Property Attributes
    • update_health_check_prop ⇒ 'enable_sni'
    • read_only ⇒ false
    • source ⇒ "update_health_check"
    

249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 249

property :enable_sni, update_health_check_prop: 'enable_sni', type: [TrueClass,FalseClass], read_only: false, source: "update_health_check", description: 'Specify whether you want Amazon Route 53 to send the value of
FullyQualifiedDomainName to the endpoint in the client_hello
message during TLS negotiation. This allows the endpoint to respond
to HTTPS health check requests with the applicable SSL/TLS
certificate.

Some endpoints require that HTTPS requests include the host name in
the client_hello message. If you don"t enable SNI, the status of
the health check will be SSL alert handshake_failure. A health check
can also have that status for other reasons. If SNI is enabled and
you"re still getting the error, check the SSL/TLS configuration on
your endpoint and confirm that your certificate is valid.

The SSL/TLS certificate on your endpoint includes a domain name in the
Common Name field and possibly several more in the Subject
Alternative Names field. One of the domain names in the certificate
should match the value that you specify for
FullyQualifiedDomainName. If the endpoint responds to the
client_hello message with a certificate that does not include the
domain name that you specified in FullyQualifiedDomainName, a health
checker will retry the handshake. In the second attempt, the health
checker will omit FullyQualifiedDomainName from the client_hello
message.'
  • #regions ⇒ Array of ⇒ [String]
    'A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.'
    Property Attributes
    • update_health_check_prop ⇒ 'regions'
    • read_only ⇒ false
    • source ⇒ "update_health_check"
    

272
273
274
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 272

property :regions, update_health_check_prop: 'regions', type: [String], array: true, read_only: false, source: "update_health_check", description: 'A complex type that contains one Region element for each region that
you want Amazon Route 53 health checkers to check the specified
endpoint from.'
  • #alarm_identifier ⇒ [MintPress::Aws::Route53::AlarmIdentifier] (Default Value: MintPress::Aws::Route53::AlarmIdentifier.new)
    'A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.'
    Property Attributes
    • update_health_check_prop ⇒ 'alarm_identifier'
    • default ⇒ MintPress::Aws::Route53::AlarmIdentifier.new
    • read_only ⇒ false
    • source ⇒ "update_health_check"
    

275
276
277
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 275

property :alarm_identifier, update_health_check_prop: 'alarm_identifier', type: [MintPress::Aws::Route53::AlarmIdentifier], default: MintPress::Aws::Route53::AlarmIdentifier.new, read_only: false, source: "update_health_check", description: 'A complex type that identifies the CloudWatch alarm that you want
Amazon Route 53 health checkers to use to determine whether the
specified health check is healthy.'
  • #insufficient_data_health_status ⇒ [String]
    'When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check: Healthy: Route 53 considers the health check to be healthy. Unhealthy: Route 53 considers the health check to be unhealthy. LastKnownStatus: Route 53 uses the status of the health check from the last time CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.'
    Property Attributes
    • update_health_check_prop ⇒ 'insufficient_data_health_status'
    • read_only ⇒ false
    • source ⇒ "update_health_check"
    

278
279
280
281
282
283
284
285
286
287
288
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 278

property :insufficient_data_health_status, update_health_check_prop: 'insufficient_data_health_status', type: [String], read_only: false, source: "update_health_check", description: 'When CloudWatch has insufficient data about the metric to determine
the alarm state, the status that you want Amazon Route 53 to assign to
the health check:


Healthy: Route 53 considers the health check to be healthy.
Unhealthy: Route 53 considers the health check to be unhealthy.
LastKnownStatus: Route 53 uses the status of the health check
from the last time CloudWatch had sufficient data to determine the
alarm state. For new health checks that have no last known status,
the default status for the health check is healthy.'
  • #reset_elements ⇒ Array of ⇒ [String]
    'A complex type that contains one ResettableElementName element for each element that you want to reset to the default value. Valid values for ResettableElementName include the following: ChildHealthChecks: Amazon Route 53 resets ChildHealthChecks to null. FullyQualifiedDomainName: Route 53 resets FullyQualifiedDomainName. to null. Regions: Route 53 resets the Regions list to the default set of regions. ResourcePath: Route 53 resets ResourcePath to null.'
    Property Attributes
    • update_health_check_prop ⇒ 'reset_elements'
    • read_only ⇒ false
    • source ⇒ "update_health_check"
    

289
290
291
292
293
294
295
296
297
298
299
300
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 289

property :reset_elements, update_health_check_prop: 'reset_elements', type: [String], array: true, read_only: false, source: "update_health_check", description: 'A complex type that contains one ResettableElementName element for
each element that you want to reset to the default value. Valid values
for ResettableElementName include the following:


ChildHealthChecks: Amazon Route 53 resets ChildHealthChecks
to null.
FullyQualifiedDomainName: Route 53 resets
FullyQualifiedDomainName. to null.
Regions: Route 53 resets the Regions list to the default set
of regions.
ResourcePath: Route 53 resets ResourcePath to null.'
  • #name ⇒ [String]

    Property Attributes 
    

301
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 301

property :name, type: [String]
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

305
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 305

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

308
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check.rb', line 308

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ HealthCheck

Returns a new instance of HealthCheck.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#get ⇒ Object

#list ⇒ Object

#update ⇒ Object