HealthCheck
route53.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | route53-controller/apis/v1alpha1#HealthCheck |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | HealthCheck |
| ListKind | HealthCheckList |
| Plural | healthchecks |
| Singular | healthcheck |
A complex type that contains information about one health check that is associated with the current Amazon Web Services account.
Spec
healthCheckConfig:
alarmIdentifier:
name: string
region: string
childHealthChecks:
- string
disabled: boolean
enableSNI: boolean
failureThreshold: integer
fullyQualifiedDomainName: string
healthThreshold: integer
insufficientDataHealthStatus: string
inverted: boolean
ipAddress: string
measureLatency: boolean
port: integer
regions:
- string
requestInterval: integer
resourcePath: string
routingControlARN: string
searchString: string
type: string
tags:
- key: string
value: string
| Field | Description |
|---|---|
| healthCheckConfig Required | object A complex type that contains settings for a new health check. |
| healthCheckConfig.alarmIdentifier Optional | object 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. |
| healthCheckConfig.alarmIdentifier.name Optional | string |
| healthCheckConfig.alarmIdentifier.region Optional | string |
| healthCheckConfig.childHealthChecks Optional | array |
| healthCheckConfig.childHealthChecks.[] Required | string |
| healthCheckConfig.enableSNI Optional | boolean |
| healthCheckConfig.failureThreshold Optional | integer |
| healthCheckConfig.fullyQualifiedDomainName Optional | string |
| healthCheckConfig.healthThreshold Optional | integer |
| healthCheckConfig.insufficientDataHealthStatus Optional | string |
| healthCheckConfig.inverted Optional | boolean |
| healthCheckConfig.ipAddress Optional | string |
| healthCheckConfig.measureLatency Optional | boolean |
| healthCheckConfig.port Optional | integer |
| healthCheckConfig.regions Optional | array |
| healthCheckConfig.regions.[] Required | string |
| healthCheckConfig.resourcePath Optional | string |
| healthCheckConfig.routingControlARN Optional | string |
| healthCheckConfig.searchString Optional | string |
| healthCheckConfig.type Optional | string |
| tags Optional | array A complex type that contains a list of the tags that you want to add to the specified health check or hosted zone and/or the tags that you want to edit Value for. You can add a maximum of 10 tags to a health check or a hosted zone. |
| tags.[] Required | object A complex type that contains information about a tag that you want to add |
| or edit for the specified health check or hosted zone. | |
| tags.[].value Optional | string |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
callerReference: string
cloudWatchAlarmConfiguration:
comparisonOperator: string
dimensions:
- name: string
value: string
evaluationPeriods: integer
metricName: string
namespace: string
period: integer
statistic: string
threshold: number
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
healthCheckVersion: integer
id: string
linkedService:
description: string
servicePrincipal: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| callerReference Optional | string A unique string that you specified when you created the health check. |
| cloudWatchAlarmConfiguration Optional | object A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check. |
| cloudWatchAlarmConfiguration.comparisonOperator Optional | string |
| cloudWatchAlarmConfiguration.dimensions Optional | array |
| cloudWatchAlarmConfiguration.dimensions.[] Required | object For the metric that the CloudWatch alarm is associated with, a complex type |
| that contains information about one dimension. | |
| cloudWatchAlarmConfiguration.dimensions.[].value Optional | string |
| cloudWatchAlarmConfiguration.evaluationPeriods Optional | integer |
| cloudWatchAlarmConfiguration.metricName Optional | string |
| cloudWatchAlarmConfiguration.namespace Optional | string |
| cloudWatchAlarmConfiguration.period Optional | integer |
| cloudWatchAlarmConfiguration.statistic Optional | string |
| cloudWatchAlarmConfiguration.threshold Optional | number |
| conditions Optional | array All CRS managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| healthCheckVersion Optional | integer The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check. |
| id Optional | string The identifier that Amazon Route 53 assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long. |
| linkedService Optional | object If the health check was created by another service, the service that created the health check. When a health check is created by another service, you can’t edit or delete it using Amazon Route 53. |
| linkedService.description Optional | string |
| linkedService.servicePrincipal Optional | string |