io.cloudshiftdev.awscdk.services.route53.CfnHealthCheck.kt Maven / Gradle / Ivy
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.route53
import io.cloudshiftdev.awscdk.CfnResource
import io.cloudshiftdev.awscdk.IInspectable
import io.cloudshiftdev.awscdk.IResolvable
import io.cloudshiftdev.awscdk.TreeInspector
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import kotlin.Any
import kotlin.Boolean
import kotlin.Number
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
import io.cloudshiftdev.constructs.Construct as CloudshiftdevConstructsConstruct
import software.constructs.Construct as SoftwareConstructsConstruct
/**
* The `AWS::Route53::HealthCheck` resource is a Route 53 resource type that contains settings for a
* Route 53 health check.
*
* For information about associating health checks with records, see
* [HealthCheckId](https://docs.aws.amazon.com/Route53/latest/APIReference/API_ResourceRecordSet.html#Route53-Type-ResourceRecordSet-HealthCheckId)
* in
* [ChangeResourceRecordSets](https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html)
* .
*
*
* You can't create a health check with simple routing.
*
*
* *ELB Load Balancers*
*
* If you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not
* create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a
* load balancer, you configure settings for an ELB health check, which performs a similar function to
* a Route 53 health check.
*
* *Private Hosted Zones*
*
* You can associate health checks with failover records in a private hosted zone. Note the
* following:
*
* * Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC
* by IP address, you must assign a public IP address to the instance in the VPC.
* * You can configure a health checker to check the health of an external resource that the
* instance relies on, such as a database server.
* * You can create a CloudWatch metric, associate an alarm with the metric, and then create a
* health check that is based on the state of the alarm. For example, you might create a CloudWatch
* metric that checks the status of the Amazon EC2 `StatusCheckFailed` metric, add an alarm to the
* metric, and then create a health check that is based on the state of the alarm. For information
* about creating CloudWatch metrics and alarms by using the CloudWatch console, see the [Amazon
* CloudWatch User
* Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/WhatIsCloudWatch.html) .
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.services.route53.*;
* CfnHealthCheck cfnHealthCheck = CfnHealthCheck.Builder.create(this, "MyCfnHealthCheck")
* .healthCheckConfig(HealthCheckConfigProperty.builder()
* .type("type")
* // the properties below are optional
* .alarmIdentifier(AlarmIdentifierProperty.builder()
* .name("name")
* .region("region")
* .build())
* .childHealthChecks(List.of("childHealthChecks"))
* .enableSni(false)
* .failureThreshold(123)
* .fullyQualifiedDomainName("fullyQualifiedDomainName")
* .healthThreshold(123)
* .insufficientDataHealthStatus("insufficientDataHealthStatus")
* .inverted(false)
* .ipAddress("ipAddress")
* .measureLatency(false)
* .port(123)
* .regions(List.of("regions"))
* .requestInterval(123)
* .resourcePath("resourcePath")
* .routingControlArn("routingControlArn")
* .searchString("searchString")
* .build())
* // the properties below are optional
* .healthCheckTags(List.of(HealthCheckTagProperty.builder()
* .key("key")
* .value("value")
* .build()))
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html)
*/
public open class CfnHealthCheck(
cdkObject: software.amazon.awscdk.services.route53.CfnHealthCheck,
) : CfnResource(cdkObject),
IInspectable {
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CfnHealthCheckProps,
) :
this(software.amazon.awscdk.services.route53.CfnHealthCheck(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id, props.let(CfnHealthCheckProps.Companion::unwrap))
)
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CfnHealthCheckProps.Builder.() -> Unit,
) : this(scope, id, CfnHealthCheckProps(props)
)
/**
* 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.
*/
public open fun attrHealthCheckId(): String = unwrap(this).getAttrHealthCheckId()
/**
* A complex type that contains detailed information about one health check.
*/
public open fun healthCheckConfig(): Any = unwrap(this).getHealthCheckConfig()
/**
* A complex type that contains detailed information about one health check.
*/
public open fun healthCheckConfig(`value`: IResolvable) {
unwrap(this).setHealthCheckConfig(`value`.let(IResolvable.Companion::unwrap))
}
/**
* A complex type that contains detailed information about one health check.
*/
public open fun healthCheckConfig(`value`: HealthCheckConfigProperty) {
unwrap(this).setHealthCheckConfig(`value`.let(HealthCheckConfigProperty.Companion::unwrap))
}
/**
* A complex type that contains detailed information about one health check.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("569eb2c9af72fd191e8dd3936c0a9b7373d37a3274cca2d72dcb60fa371c84a3")
public open fun healthCheckConfig(`value`: HealthCheckConfigProperty.Builder.() -> Unit): Unit =
healthCheckConfig(HealthCheckConfigProperty(`value`))
/**
* The `HealthCheckTags` property describes key-value pairs that are associated with an
* `AWS::Route53::HealthCheck` resource.
*/
public open fun healthCheckTags(): Any? = unwrap(this).getHealthCheckTags()
/**
* The `HealthCheckTags` property describes key-value pairs that are associated with an
* `AWS::Route53::HealthCheck` resource.
*/
public open fun healthCheckTags(`value`: IResolvable) {
unwrap(this).setHealthCheckTags(`value`.let(IResolvable.Companion::unwrap))
}
/**
* The `HealthCheckTags` property describes key-value pairs that are associated with an
* `AWS::Route53::HealthCheck` resource.
*/
public open fun healthCheckTags(`value`: List) {
unwrap(this).setHealthCheckTags(`value`.map{CdkObjectWrappers.unwrap(it)})
}
/**
* The `HealthCheckTags` property describes key-value pairs that are associated with an
* `AWS::Route53::HealthCheck` resource.
*/
public open fun healthCheckTags(vararg `value`: Any): Unit = healthCheckTags(`value`.toList())
/**
* Examines the CloudFormation resource and discloses attributes.
*
* @param inspector tree inspector to collect and process attributes.
*/
public override fun inspect(inspector: TreeInspector) {
unwrap(this).inspect(inspector.let(TreeInspector.Companion::unwrap))
}
/**
* A fluent builder for [io.cloudshiftdev.awscdk.services.route53.CfnHealthCheck].
*/
@CdkDslMarker
public interface Builder {
/**
* A complex type that contains detailed information about one health check.
*
* For the values to enter for `HealthCheckConfig` , see
* [HealthCheckConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html)
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthcheckconfig)
* @param healthCheckConfig A complex type that contains detailed information about one health
* check.
*/
public fun healthCheckConfig(healthCheckConfig: IResolvable)
/**
* A complex type that contains detailed information about one health check.
*
* For the values to enter for `HealthCheckConfig` , see
* [HealthCheckConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html)
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthcheckconfig)
* @param healthCheckConfig A complex type that contains detailed information about one health
* check.
*/
public fun healthCheckConfig(healthCheckConfig: HealthCheckConfigProperty)
/**
* A complex type that contains detailed information about one health check.
*
* For the values to enter for `HealthCheckConfig` , see
* [HealthCheckConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html)
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthcheckconfig)
* @param healthCheckConfig A complex type that contains detailed information about one health
* check.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("10eb564e26de9025530513c4b2ab1399372b7f9d1c8936dcaa5908f181227922")
public fun healthCheckConfig(healthCheckConfig: HealthCheckConfigProperty.Builder.() -> Unit)
/**
* The `HealthCheckTags` property describes key-value pairs that are associated with an
* `AWS::Route53::HealthCheck` resource.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthchecktags)
* @param healthCheckTags The `HealthCheckTags` property describes key-value pairs that are
* associated with an `AWS::Route53::HealthCheck` resource.
*/
public fun healthCheckTags(healthCheckTags: IResolvable)
/**
* The `HealthCheckTags` property describes key-value pairs that are associated with an
* `AWS::Route53::HealthCheck` resource.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthchecktags)
* @param healthCheckTags The `HealthCheckTags` property describes key-value pairs that are
* associated with an `AWS::Route53::HealthCheck` resource.
*/
public fun healthCheckTags(healthCheckTags: List)
/**
* The `HealthCheckTags` property describes key-value pairs that are associated with an
* `AWS::Route53::HealthCheck` resource.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthchecktags)
* @param healthCheckTags The `HealthCheckTags` property describes key-value pairs that are
* associated with an `AWS::Route53::HealthCheck` resource.
*/
public fun healthCheckTags(vararg healthCheckTags: Any)
}
private class BuilderImpl(
scope: SoftwareConstructsConstruct,
id: String,
) : Builder {
private val cdkBuilder: software.amazon.awscdk.services.route53.CfnHealthCheck.Builder =
software.amazon.awscdk.services.route53.CfnHealthCheck.Builder.create(scope, id)
/**
* A complex type that contains detailed information about one health check.
*
* For the values to enter for `HealthCheckConfig` , see
* [HealthCheckConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html)
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthcheckconfig)
* @param healthCheckConfig A complex type that contains detailed information about one health
* check.
*/
override fun healthCheckConfig(healthCheckConfig: IResolvable) {
cdkBuilder.healthCheckConfig(healthCheckConfig.let(IResolvable.Companion::unwrap))
}
/**
* A complex type that contains detailed information about one health check.
*
* For the values to enter for `HealthCheckConfig` , see
* [HealthCheckConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html)
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthcheckconfig)
* @param healthCheckConfig A complex type that contains detailed information about one health
* check.
*/
override fun healthCheckConfig(healthCheckConfig: HealthCheckConfigProperty) {
cdkBuilder.healthCheckConfig(healthCheckConfig.let(HealthCheckConfigProperty.Companion::unwrap))
}
/**
* A complex type that contains detailed information about one health check.
*
* For the values to enter for `HealthCheckConfig` , see
* [HealthCheckConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html)
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthcheckconfig)
* @param healthCheckConfig A complex type that contains detailed information about one health
* check.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("10eb564e26de9025530513c4b2ab1399372b7f9d1c8936dcaa5908f181227922")
override fun healthCheckConfig(healthCheckConfig: HealthCheckConfigProperty.Builder.() -> Unit):
Unit = healthCheckConfig(HealthCheckConfigProperty(healthCheckConfig))
/**
* The `HealthCheckTags` property describes key-value pairs that are associated with an
* `AWS::Route53::HealthCheck` resource.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthchecktags)
* @param healthCheckTags The `HealthCheckTags` property describes key-value pairs that are
* associated with an `AWS::Route53::HealthCheck` resource.
*/
override fun healthCheckTags(healthCheckTags: IResolvable) {
cdkBuilder.healthCheckTags(healthCheckTags.let(IResolvable.Companion::unwrap))
}
/**
* The `HealthCheckTags` property describes key-value pairs that are associated with an
* `AWS::Route53::HealthCheck` resource.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthchecktags)
* @param healthCheckTags The `HealthCheckTags` property describes key-value pairs that are
* associated with an `AWS::Route53::HealthCheck` resource.
*/
override fun healthCheckTags(healthCheckTags: List) {
cdkBuilder.healthCheckTags(healthCheckTags.map{CdkObjectWrappers.unwrap(it)})
}
/**
* The `HealthCheckTags` property describes key-value pairs that are associated with an
* `AWS::Route53::HealthCheck` resource.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthchecktags)
* @param healthCheckTags The `HealthCheckTags` property describes key-value pairs that are
* associated with an `AWS::Route53::HealthCheck` resource.
*/
override fun healthCheckTags(vararg healthCheckTags: Any): Unit =
healthCheckTags(healthCheckTags.toList())
public fun build(): software.amazon.awscdk.services.route53.CfnHealthCheck = cdkBuilder.build()
}
public companion object {
public val CFN_RESOURCE_TYPE_NAME: String =
software.amazon.awscdk.services.route53.CfnHealthCheck.CFN_RESOURCE_TYPE_NAME
public operator fun invoke(
scope: CloudshiftdevConstructsConstruct,
id: String,
block: Builder.() -> Unit = {},
): CfnHealthCheck {
val builderImpl = BuilderImpl(CloudshiftdevConstructsConstruct.unwrap(scope), id)
return CfnHealthCheck(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.route53.CfnHealthCheck):
CfnHealthCheck = CfnHealthCheck(cdkObject)
internal fun unwrap(wrapped: CfnHealthCheck):
software.amazon.awscdk.services.route53.CfnHealthCheck = wrapped.cdkObject as
software.amazon.awscdk.services.route53.CfnHealthCheck
}
/**
* 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.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.services.route53.*;
* AlarmIdentifierProperty alarmIdentifierProperty = AlarmIdentifierProperty.builder()
* .name("name")
* .region("region")
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html)
*/
public interface AlarmIdentifierProperty {
/**
* The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to
* determine whether this health check is healthy.
*
*
* Route 53 supports CloudWatch alarms with the following features:
*
* * Standard-resolution metrics. High-resolution metrics aren't supported. For more
* information, see [High-Resolution
* Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics)
* in the *Amazon CloudWatch User Guide* .
* * Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't
* supported.
*
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html#cfn-route53-healthcheck-alarmidentifier-name)
*/
public fun name(): String
/**
* For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether
* this health check is healthy, the region that the alarm was created in.
*
* For the current list of CloudWatch regions, see [Amazon CloudWatch endpoints and
* quotas](https://docs.aws.amazon.com/general/latest/gr/cw_region.html) in the *Amazon Web
* Services General Reference* .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html#cfn-route53-healthcheck-alarmidentifier-region)
*/
public fun region(): String
/**
* A builder for [AlarmIdentifierProperty]
*/
@CdkDslMarker
public interface Builder {
/**
* @param name The name of the CloudWatch alarm that you want Amazon Route 53 health checkers
* to use to determine whether this health check is healthy.
*
* Route 53 supports CloudWatch alarms with the following features:
*
* * Standard-resolution metrics. High-resolution metrics aren't supported. For more
* information, see [High-Resolution
* Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics)
* in the *Amazon CloudWatch User Guide* .
* * Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't
* supported.
*/
public fun name(name: String)
/**
* @param region For the CloudWatch alarm that you want Route 53 health checkers to use to
* determine whether this health check is healthy, the region that the alarm was created in.
* For the current list of CloudWatch regions, see [Amazon CloudWatch endpoints and
* quotas](https://docs.aws.amazon.com/general/latest/gr/cw_region.html) in the *Amazon Web
* Services General Reference* .
*/
public fun region(region: String)
}
private class BuilderImpl : Builder {
private val cdkBuilder:
software.amazon.awscdk.services.route53.CfnHealthCheck.AlarmIdentifierProperty.Builder =
software.amazon.awscdk.services.route53.CfnHealthCheck.AlarmIdentifierProperty.builder()
/**
* @param name The name of the CloudWatch alarm that you want Amazon Route 53 health checkers
* to use to determine whether this health check is healthy.
*
* Route 53 supports CloudWatch alarms with the following features:
*
* * Standard-resolution metrics. High-resolution metrics aren't supported. For more
* information, see [High-Resolution
* Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics)
* in the *Amazon CloudWatch User Guide* .
* * Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't
* supported.
*/
override fun name(name: String) {
cdkBuilder.name(name)
}
/**
* @param region For the CloudWatch alarm that you want Route 53 health checkers to use to
* determine whether this health check is healthy, the region that the alarm was created in.
* For the current list of CloudWatch regions, see [Amazon CloudWatch endpoints and
* quotas](https://docs.aws.amazon.com/general/latest/gr/cw_region.html) in the *Amazon Web
* Services General Reference* .
*/
override fun region(region: String) {
cdkBuilder.region(region)
}
public fun build():
software.amazon.awscdk.services.route53.CfnHealthCheck.AlarmIdentifierProperty =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.route53.CfnHealthCheck.AlarmIdentifierProperty,
) : CdkObject(cdkObject),
AlarmIdentifierProperty {
/**
* The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to
* determine whether this health check is healthy.
*
*
* Route 53 supports CloudWatch alarms with the following features:
*
* * Standard-resolution metrics. High-resolution metrics aren't supported. For more
* information, see [High-Resolution
* Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics)
* in the *Amazon CloudWatch User Guide* .
* * Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't
* supported.
*
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html#cfn-route53-healthcheck-alarmidentifier-name)
*/
override fun name(): String = unwrap(this).getName()
/**
* For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether
* this health check is healthy, the region that the alarm was created in.
*
* For the current list of CloudWatch regions, see [Amazon CloudWatch endpoints and
* quotas](https://docs.aws.amazon.com/general/latest/gr/cw_region.html) in the *Amazon Web
* Services General Reference* .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html#cfn-route53-healthcheck-alarmidentifier-region)
*/
override fun region(): String = unwrap(this).getRegion()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): AlarmIdentifierProperty {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.services.route53.CfnHealthCheck.AlarmIdentifierProperty):
AlarmIdentifierProperty = CdkObjectWrappers.wrap(cdkObject) as? AlarmIdentifierProperty ?:
Wrapper(cdkObject)
internal fun unwrap(wrapped: AlarmIdentifierProperty):
software.amazon.awscdk.services.route53.CfnHealthCheck.AlarmIdentifierProperty = (wrapped
as CdkObject).cdkObject as
software.amazon.awscdk.services.route53.CfnHealthCheck.AlarmIdentifierProperty
}
}
/**
* A complex type that contains information about the health check.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.services.route53.*;
* HealthCheckConfigProperty healthCheckConfigProperty = HealthCheckConfigProperty.builder()
* .type("type")
* // the properties below are optional
* .alarmIdentifier(AlarmIdentifierProperty.builder()
* .name("name")
* .region("region")
* .build())
* .childHealthChecks(List.of("childHealthChecks"))
* .enableSni(false)
* .failureThreshold(123)
* .fullyQualifiedDomainName("fullyQualifiedDomainName")
* .healthThreshold(123)
* .insufficientDataHealthStatus("insufficientDataHealthStatus")
* .inverted(false)
* .ipAddress("ipAddress")
* .measureLatency(false)
* .port(123)
* .regions(List.of("regions"))
* .requestInterval(123)
* .resourcePath("resourcePath")
* .routingControlArn("routingControlArn")
* .searchString("searchString")
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html)
*/
public interface HealthCheckConfigProperty {
/**
* 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.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-alarmidentifier)
*/
public fun alarmIdentifier(): Any? = unwrap(this).getAlarmIdentifier()
/**
* (CALCULATED Health Checks Only) A complex type that contains one `ChildHealthCheck` element
* for each health check that you want to associate with a `CALCULATED` health check.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-childhealthchecks)
*/
public fun childHealthChecks(): List = unwrap(this).getChildHealthChecks() ?:
emptyList()
/**
* 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.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-enablesni)
*/
public fun enableSni(): Any? = unwrap(this).getEnableSni()
/**
* 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](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html)
* in the *Amazon Route 53 Developer Guide* .
*
* If you don't specify a value for `FailureThreshold` , the default value is three health
* checks.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-failurethreshold)
*/
public fun failureThreshold(): Number? = unwrap(this).getFailureThreshold()
/**
* Amazon Route 53 behavior depends on whether you specify a value for `IPAddress` .
*
* *If you specify a value for* `IPAddress` :
*
* Amazon 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 preceding cases.
*
* *If you don't specify a value for `IPAddress`* :
*
* Route 53 sends a DNS request to the domain that you specify for `FullyQualifiedDomainName` at
* the interval that you specify for `RequestInterval` . Using an IPv4 address that DNS returns,
* 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 record 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 multiple records that have the same name and type, such as
* multiple weighted records, and if 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 records (www.example.com).
*
*
* In this configuration, if you create a health check for which the value of
* `FullyQualifiedDomainName` matches the name of the records and you then associate the health
* check with those records, health check results will be unpredictable.
*
*
* In addition, if the value that you specify for `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.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-fullyqualifieddomainname)
*/
public fun fullyQualifiedDomainName(): String? = unwrap(this).getFullyQualifiedDomainName()
/**
* The number of child health checks that are associated with a `CALCULATED` health check 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](https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-ChildHealthChecks)
* element.
*
* 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.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-healththreshold)
*/
public fun healthThreshold(): Number? = unwrap(this).getHealthThreshold()
/**
* 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 that
* 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.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-insufficientdatahealthstatus)
*/
public fun insufficientDataHealthStatus(): String? =
unwrap(this).getInsufficientDataHealthStatus()
/**
* 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.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-inverted)
*/
public fun inverted(): Any? = unwrap(this).getInverted()
/**
* The IPv4 or IPv6 IP address of 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 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 will never change.
*
* For more information, see
* [FullyQualifiedDomainName](https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-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](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc5735)
* * [RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address
* Space](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6598)
* * [RFC 5156, Special-Use IPv6
* Addresses](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc5156)
*
* When the value of `Type` is `CALCULATED` or `CLOUDWATCH_METRIC` , omit `IPAddress` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-ipaddress)
*/
public fun ipAddress(): String? = unwrap(this).getIpAddress()
/**
* Specify whether you want Amazon Route 53 to measure the latency between health checkers in
* multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the *Health
* Checks* page in the Route 53 console.
*
*
* You can't change the value of `MeasureLatency` after you create a health check.
*
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-measurelatency)
*/
public fun measureLatency(): Any? = unwrap(this).getMeasureLatency()
/**
* 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-type)
* of `CLOUDWATCH_METRIC` or `CALCULATED` .
*
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-port)
*/
public fun port(): Number? = unwrap(this).getPort()
/**
* A complex type that contains one `Region` element for each region from which you want Amazon
* Route 53 health checkers to check the specified endpoint.
*
* If you don't specify any regions, Route 53 health checkers automatically performs checks from
* all of the regions that are listed under *Valid Values* .
*
* If you update a health check to remove a region that has been performing health checks, Route
* 53 will briefly continue to perform checks from that region to ensure that some health checkers
* are always checking the endpoint (for example, if you replace three regions with four different
* regions).
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-regions)
*/
public fun regions(): List = unwrap(this).getRegions() ?: emptyList()
/**
* The number of seconds between the time that Amazon Route 53 gets a response from your
* endpoint and the time that it sends the next health check request.
*
* Each Route 53 health checker makes requests at this interval.
*
*
* You can't change the value of `RequestInterval` after you create a health check.
*
*
* If you don't specify a value for `RequestInterval` , the default value is `30` seconds.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-requestinterval)
*/
public fun requestInterval(): Number? = unwrap(this).getRequestInterval()
/**
* The path, if any, 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` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-resourcepath)
*/
public fun resourcePath(): String? = unwrap(this).getResourcePath()
/**
* The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing
* control.
*
* For more information about Route 53 Application Recovery Controller, see [Route 53
* Application Recovery Controller Developer
* Guide.](https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route-53-recovery.html) .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-routingcontrolarn)
*/
public fun routingControlArn(): String? = unwrap(this).getRoutingControlArn()
/**
* 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.
*
* Route 53 considers case when searching for `SearchString` in the response body.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-searchstring)
*/
public fun searchString(): String? = unwrap(this).getSearchString()
/**
* The type of health check that you want to create, which indicates how Amazon Route 53
* determines whether an endpoint is healthy.
*
*
* You can't change the value of `Type` after you create a health check.
*
*
* You can create the following types of health checks:
*
* * *HTTP* : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an
* HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
* * *HTTPS* : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an
* HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
*
*
* If you specify `HTTPS` for the value of `Type` , the endpoint must support TLS v1.0 or later.
*
*
* * *HTTP_STR_MATCH* : Route 53 tries to establish a TCP connection. If successful, Route 53
* submits an HTTP request and searches the first 5,120 bytes of the response body for the string
* that you specify in `SearchString` .
* * *HTTPS_STR_MATCH* : Route 53 tries to establish a TCP connection. If successful, Route 53
* submits an `HTTPS` request and searches the first 5,120 bytes of the response body for the
* string that you specify in `SearchString` .
* * *TCP* : Route 53 tries to establish a TCP connection.
* * *CLOUDWATCH_METRIC* : The health check is associated with a CloudWatch alarm. If the state
* of the alarm is `OK` , the health check is considered healthy. If the state is `ALARM` , the
* health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine
* whether the state is `OK` or `ALARM` , the health check status depends on the setting for
* `InsufficientDataHealthStatus` : `Healthy` , `Unhealthy` , or `LastKnownStatus` .
*
*
* Route 53 supports CloudWatch alarms with the following features:
*
* * Standard-resolution metrics. High-resolution metrics aren't supported. For more
* information, see [High-Resolution
* Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics)
* in the *Amazon CloudWatch User Guide* .
* * Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't
* supported.
*
*
* * *CALCULATED* : For health checks that monitor the status of other health checks, Route 53
* adds up the number of health checks that Route 53 health checkers consider to be healthy and
* compares that number with the value of `HealthThreshold` .
* * *RECOVERY_CONTROL* : The health check is assocated with a Route53 Application Recovery
* Controller routing control. If the routing control state is `ON` , the health check is
* considered healthy. If the state is `OFF` , the health check is considered unhealthy.
*
* For more information, see [How Route 53 Determines Whether an Endpoint Is
* Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html)
* in the *Amazon Route 53 Developer Guide* .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-type)
*/
public fun type(): String
/**
* A builder for [HealthCheckConfigProperty]
*/
@CdkDslMarker
public interface Builder {
/**
* @param alarmIdentifier 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.
*/
public fun alarmIdentifier(alarmIdentifier: IResolvable)
/**
* @param alarmIdentifier 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.
*/
public fun alarmIdentifier(alarmIdentifier: AlarmIdentifierProperty)
/**
* @param alarmIdentifier 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.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("ac412132c89e73ae908b1ecb7239f3b46dc7142b3ec016100beea46011eddae9")
public fun alarmIdentifier(alarmIdentifier: AlarmIdentifierProperty.Builder.() -> Unit)
/**
* @param childHealthChecks (CALCULATED Health Checks Only) A complex type that contains one
* `ChildHealthCheck` element for each health check that you want to associate with a
* `CALCULATED` health check.
*/
public fun childHealthChecks(childHealthChecks: List)
/**
* @param childHealthChecks (CALCULATED Health Checks Only) A complex type that contains one
* `ChildHealthCheck` element for each health check that you want to associate with a
* `CALCULATED` health check.
*/
public fun childHealthChecks(vararg childHealthChecks: String)
/**
* @param enableSni 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.
*/
public fun enableSni(enableSni: Boolean)
/**
* @param enableSni 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.
*/
public fun enableSni(enableSni: IResolvable)
/**
* @param failureThreshold 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](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html)
* in the *Amazon Route 53 Developer Guide* .
*
* If you don't specify a value for `FailureThreshold` , the default value is three health
* checks.
*/
public fun failureThreshold(failureThreshold: Number)
/**
* @param fullyQualifiedDomainName Amazon Route 53 behavior depends on whether you specify a
* value for `IPAddress` .
* *If you specify a value for* `IPAddress` :
*
* Amazon 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 preceding cases.
*
* *If you don't specify a value for `IPAddress`* :
*
* Route 53 sends a DNS request to the domain that you specify for `FullyQualifiedDomainName`
* at the interval that you specify for `RequestInterval` . Using an IPv4 address that DNS
* returns, 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 record 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 multiple records that have the same name and type, such
* as multiple weighted records, and if 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 records (www.example.com).
*
*
* In this configuration, if you create a health check for which the value of
* `FullyQualifiedDomainName` matches the name of the records and you then associate the health
* check with those records, health check results will be unpredictable.
*
*
* In addition, if the value that you specify for `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.
*/
public fun fullyQualifiedDomainName(fullyQualifiedDomainName: String)
/**
* @param healthThreshold The number of child health checks that are associated with a
* `CALCULATED` health check 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](https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-ChildHealthChecks)
* element.
*
* 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.
*/
public fun healthThreshold(healthThreshold: Number)
/**
* @param insufficientDataHealthStatus 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 that
* 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.
*/
public fun insufficientDataHealthStatus(insufficientDataHealthStatus: String)
/**
* @param inverted 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.
*/
public fun inverted(inverted: Boolean)
/**
* @param inverted 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.
*/
public fun inverted(inverted: IResolvable)
/**
* @param ipAddress The IPv4 or IPv6 IP address of 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 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 will never change.
*
* For more information, see
* [FullyQualifiedDomainName](https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-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](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc5735)
* * [RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address
* Space](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6598)
* * [RFC 5156, Special-Use IPv6
* Addresses](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc5156)
*
* When the value of `Type` is `CALCULATED` or `CLOUDWATCH_METRIC` , omit `IPAddress` .
*/
public fun ipAddress(ipAddress: String)
/**
* @param measureLatency Specify whether you want Amazon Route 53 to measure the latency
* between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch
* latency graphs on the *Health Checks* page in the Route 53 console.
*
* You can't change the value of `MeasureLatency` after you create a health check.
*/
public fun measureLatency(measureLatency: Boolean)
/**
* @param measureLatency Specify whether you want Amazon Route 53 to measure the latency
* between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch
* latency graphs on the *Health Checks* page in the Route 53 console.
*
* You can't change the value of `MeasureLatency` after you create a health check.
*/
public fun measureLatency(measureLatency: IResolvable)
/**
* @param port 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-type)
* of `CLOUDWATCH_METRIC` or `CALCULATED` .
*/
public fun port(port: Number)
/**
* @param regions A complex type that contains one `Region` element for each region from which
* you want Amazon Route 53 health checkers to check the specified endpoint.
* If you don't specify any regions, Route 53 health checkers automatically performs checks
* from all of the regions that are listed under *Valid Values* .
*
* If you update a health check to remove a region that has been performing health checks,
* Route 53 will briefly continue to perform checks from that region to ensure that some health
* checkers are always checking the endpoint (for example, if you replace three regions with four
* different regions).
*/
public fun regions(regions: List)
/**
* @param regions A complex type that contains one `Region` element for each region from which
* you want Amazon Route 53 health checkers to check the specified endpoint.
* If you don't specify any regions, Route 53 health checkers automatically performs checks
* from all of the regions that are listed under *Valid Values* .
*
* If you update a health check to remove a region that has been performing health checks,
* Route 53 will briefly continue to perform checks from that region to ensure that some health
* checkers are always checking the endpoint (for example, if you replace three regions with four
* different regions).
*/
public fun regions(vararg regions: String)
/**
* @param requestInterval The number of seconds between the time that Amazon Route 53 gets a
* response from your endpoint and the time that it sends the next health check request.
* Each Route 53 health checker makes requests at this interval.
*
*
* You can't change the value of `RequestInterval` after you create a health check.
*
*
* If you don't specify a value for `RequestInterval` , the default value is `30` seconds.
*/
public fun requestInterval(requestInterval: Number)
/**
* @param resourcePath The path, if any, 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`
* .
*/
public fun resourcePath(resourcePath: String)
/**
* @param routingControlArn The Amazon Resource Name (ARN) for the Route 53 Application
* Recovery Controller routing control.
* For more information about Route 53 Application Recovery Controller, see [Route 53
* Application Recovery Controller Developer
* Guide.](https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route-53-recovery.html) .
*/
public fun routingControlArn(routingControlArn: String)
/**
* @param searchString 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.
*
* Route 53 considers case when searching for `SearchString` in the response body.
*/
public fun searchString(searchString: String)
/**
* @param type The type of health check that you want to create, which indicates how Amazon
* Route 53 determines whether an endpoint is healthy.
*
* You can't change the value of `Type` after you create a health check.
*
*
* You can create the following types of health checks:
*
* * *HTTP* : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an
* HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
* * *HTTPS* : Route 53 tries to establish a TCP connection. If successful, Route 53 submits
* an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
*
*
* If you specify `HTTPS` for the value of `Type` , the endpoint must support TLS v1.0 or
* later.
*
*
* * *HTTP_STR_MATCH* : Route 53 tries to establish a TCP connection. If successful, Route 53
* submits an HTTP request and searches the first 5,120 bytes of the response body for the string
* that you specify in `SearchString` .
* * *HTTPS_STR_MATCH* : Route 53 tries to establish a TCP connection. If successful, Route 53
* submits an `HTTPS` request and searches the first 5,120 bytes of the response body for the
* string that you specify in `SearchString` .
* * *TCP* : Route 53 tries to establish a TCP connection.
* * *CLOUDWATCH_METRIC* : The health check is associated with a CloudWatch alarm. If the
* state of the alarm is `OK` , the health check is considered healthy. If the state is `ALARM` ,
* the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to
* determine whether the state is `OK` or `ALARM` , the health check status depends on the
* setting for `InsufficientDataHealthStatus` : `Healthy` , `Unhealthy` , or `LastKnownStatus` .
*
*
* Route 53 supports CloudWatch alarms with the following features:
*
* * Standard-resolution metrics. High-resolution metrics aren't supported. For more
* information, see [High-Resolution
* Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics)
* in the *Amazon CloudWatch User Guide* .
* * Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't
* supported.
*
*
* * *CALCULATED* : For health checks that monitor the status of other health checks, Route 53
* adds up the number of health checks that Route 53 health checkers consider to be healthy and
* compares that number with the value of `HealthThreshold` .
* * *RECOVERY_CONTROL* : The health check is assocated with a Route53 Application Recovery
* Controller routing control. If the routing control state is `ON` , the health check is
* considered healthy. If the state is `OFF` , the health check is considered unhealthy.
*
* For more information, see [How Route 53 Determines Whether an Endpoint Is
* Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html)
* in the *Amazon Route 53 Developer Guide* .
*/
public fun type(type: String)
}
private class BuilderImpl : Builder {
private val cdkBuilder:
software.amazon.awscdk.services.route53.CfnHealthCheck.HealthCheckConfigProperty.Builder =
software.amazon.awscdk.services.route53.CfnHealthCheck.HealthCheckConfigProperty.builder()
/**
* @param alarmIdentifier 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.
*/
override fun alarmIdentifier(alarmIdentifier: IResolvable) {
cdkBuilder.alarmIdentifier(alarmIdentifier.let(IResolvable.Companion::unwrap))
}
/**
* @param alarmIdentifier 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.
*/
override fun alarmIdentifier(alarmIdentifier: AlarmIdentifierProperty) {
cdkBuilder.alarmIdentifier(alarmIdentifier.let(AlarmIdentifierProperty.Companion::unwrap))
}
/**
* @param alarmIdentifier 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.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("ac412132c89e73ae908b1ecb7239f3b46dc7142b3ec016100beea46011eddae9")
override fun alarmIdentifier(alarmIdentifier: AlarmIdentifierProperty.Builder.() -> Unit):
Unit = alarmIdentifier(AlarmIdentifierProperty(alarmIdentifier))
/**
* @param childHealthChecks (CALCULATED Health Checks Only) A complex type that contains one
* `ChildHealthCheck` element for each health check that you want to associate with a
* `CALCULATED` health check.
*/
override fun childHealthChecks(childHealthChecks: List) {
cdkBuilder.childHealthChecks(childHealthChecks)
}
/**
* @param childHealthChecks (CALCULATED Health Checks Only) A complex type that contains one
* `ChildHealthCheck` element for each health check that you want to associate with a
* `CALCULATED` health check.
*/
override fun childHealthChecks(vararg childHealthChecks: String): Unit =
childHealthChecks(childHealthChecks.toList())
/**
* @param enableSni 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.
*/
override fun enableSni(enableSni: Boolean) {
cdkBuilder.enableSni(enableSni)
}
/**
* @param enableSni 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.
*/
override fun enableSni(enableSni: IResolvable) {
cdkBuilder.enableSni(enableSni.let(IResolvable.Companion::unwrap))
}
/**
* @param failureThreshold 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](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html)
* in the *Amazon Route 53 Developer Guide* .
*
* If you don't specify a value for `FailureThreshold` , the default value is three health
* checks.
*/
override fun failureThreshold(failureThreshold: Number) {
cdkBuilder.failureThreshold(failureThreshold)
}
/**
* @param fullyQualifiedDomainName Amazon Route 53 behavior depends on whether you specify a
* value for `IPAddress` .
* *If you specify a value for* `IPAddress` :
*
* Amazon 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 preceding cases.
*
* *If you don't specify a value for `IPAddress`* :
*
* Route 53 sends a DNS request to the domain that you specify for `FullyQualifiedDomainName`
* at the interval that you specify for `RequestInterval` . Using an IPv4 address that DNS
* returns, 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 record 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 multiple records that have the same name and type, such
* as multiple weighted records, and if 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 records (www.example.com).
*
*
* In this configuration, if you create a health check for which the value of
* `FullyQualifiedDomainName` matches the name of the records and you then associate the health
* check with those records, health check results will be unpredictable.
*
*
* In addition, if the value that you specify for `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.
*/
override fun fullyQualifiedDomainName(fullyQualifiedDomainName: String) {
cdkBuilder.fullyQualifiedDomainName(fullyQualifiedDomainName)
}
/**
* @param healthThreshold The number of child health checks that are associated with a
* `CALCULATED` health check 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](https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-ChildHealthChecks)
* element.
*
* 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.
*/
override fun healthThreshold(healthThreshold: Number) {
cdkBuilder.healthThreshold(healthThreshold)
}
/**
* @param insufficientDataHealthStatus 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 that
* 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.
*/
override fun insufficientDataHealthStatus(insufficientDataHealthStatus: String) {
cdkBuilder.insufficientDataHealthStatus(insufficientDataHealthStatus)
}
/**
* @param inverted 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.
*/
override fun inverted(inverted: Boolean) {
cdkBuilder.inverted(inverted)
}
/**
* @param inverted 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.
*/
override fun inverted(inverted: IResolvable) {
cdkBuilder.inverted(inverted.let(IResolvable.Companion::unwrap))
}
/**
* @param ipAddress The IPv4 or IPv6 IP address of 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 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 will never change.
*
* For more information, see
* [FullyQualifiedDomainName](https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-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](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc5735)
* * [RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address
* Space](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6598)
* * [RFC 5156, Special-Use IPv6
* Addresses](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc5156)
*
* When the value of `Type` is `CALCULATED` or `CLOUDWATCH_METRIC` , omit `IPAddress` .
*/
override fun ipAddress(ipAddress: String) {
cdkBuilder.ipAddress(ipAddress)
}
/**
* @param measureLatency Specify whether you want Amazon Route 53 to measure the latency
* between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch
* latency graphs on the *Health Checks* page in the Route 53 console.
*
* You can't change the value of `MeasureLatency` after you create a health check.
*/
override fun measureLatency(measureLatency: Boolean) {
cdkBuilder.measureLatency(measureLatency)
}
/**
* @param measureLatency Specify whether you want Amazon Route 53 to measure the latency
* between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch
* latency graphs on the *Health Checks* page in the Route 53 console.
*
* You can't change the value of `MeasureLatency` after you create a health check.
*/
override fun measureLatency(measureLatency: IResolvable) {
cdkBuilder.measureLatency(measureLatency.let(IResolvable.Companion::unwrap))
}
/**
* @param port 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-type)
* of `CLOUDWATCH_METRIC` or `CALCULATED` .
*/
override fun port(port: Number) {
cdkBuilder.port(port)
}
/**
* @param regions A complex type that contains one `Region` element for each region from which
* you want Amazon Route 53 health checkers to check the specified endpoint.
* If you don't specify any regions, Route 53 health checkers automatically performs checks
* from all of the regions that are listed under *Valid Values* .
*
* If you update a health check to remove a region that has been performing health checks,
* Route 53 will briefly continue to perform checks from that region to ensure that some health
* checkers are always checking the endpoint (for example, if you replace three regions with four
* different regions).
*/
override fun regions(regions: List) {
cdkBuilder.regions(regions)
}
/**
* @param regions A complex type that contains one `Region` element for each region from which
* you want Amazon Route 53 health checkers to check the specified endpoint.
* If you don't specify any regions, Route 53 health checkers automatically performs checks
* from all of the regions that are listed under *Valid Values* .
*
* If you update a health check to remove a region that has been performing health checks,
* Route 53 will briefly continue to perform checks from that region to ensure that some health
* checkers are always checking the endpoint (for example, if you replace three regions with four
* different regions).
*/
override fun regions(vararg regions: String): Unit = regions(regions.toList())
/**
* @param requestInterval The number of seconds between the time that Amazon Route 53 gets a
* response from your endpoint and the time that it sends the next health check request.
* Each Route 53 health checker makes requests at this interval.
*
*
* You can't change the value of `RequestInterval` after you create a health check.
*
*
* If you don't specify a value for `RequestInterval` , the default value is `30` seconds.
*/
override fun requestInterval(requestInterval: Number) {
cdkBuilder.requestInterval(requestInterval)
}
/**
* @param resourcePath The path, if any, 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`
* .
*/
override fun resourcePath(resourcePath: String) {
cdkBuilder.resourcePath(resourcePath)
}
/**
* @param routingControlArn The Amazon Resource Name (ARN) for the Route 53 Application
* Recovery Controller routing control.
* For more information about Route 53 Application Recovery Controller, see [Route 53
* Application Recovery Controller Developer
* Guide.](https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route-53-recovery.html) .
*/
override fun routingControlArn(routingControlArn: String) {
cdkBuilder.routingControlArn(routingControlArn)
}
/**
* @param searchString 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.
*
* Route 53 considers case when searching for `SearchString` in the response body.
*/
override fun searchString(searchString: String) {
cdkBuilder.searchString(searchString)
}
/**
* @param type The type of health check that you want to create, which indicates how Amazon
* Route 53 determines whether an endpoint is healthy.
*
* You can't change the value of `Type` after you create a health check.
*
*
* You can create the following types of health checks:
*
* * *HTTP* : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an
* HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
* * *HTTPS* : Route 53 tries to establish a TCP connection. If successful, Route 53 submits
* an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
*
*
* If you specify `HTTPS` for the value of `Type` , the endpoint must support TLS v1.0 or
* later.
*
*
* * *HTTP_STR_MATCH* : Route 53 tries to establish a TCP connection. If successful, Route 53
* submits an HTTP request and searches the first 5,120 bytes of the response body for the string
* that you specify in `SearchString` .
* * *HTTPS_STR_MATCH* : Route 53 tries to establish a TCP connection. If successful, Route 53
* submits an `HTTPS` request and searches the first 5,120 bytes of the response body for the
* string that you specify in `SearchString` .
* * *TCP* : Route 53 tries to establish a TCP connection.
* * *CLOUDWATCH_METRIC* : The health check is associated with a CloudWatch alarm. If the
* state of the alarm is `OK` , the health check is considered healthy. If the state is `ALARM` ,
* the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to
* determine whether the state is `OK` or `ALARM` , the health check status depends on the
* setting for `InsufficientDataHealthStatus` : `Healthy` , `Unhealthy` , or `LastKnownStatus` .
*
*
* Route 53 supports CloudWatch alarms with the following features:
*
* * Standard-resolution metrics. High-resolution metrics aren't supported. For more
* information, see [High-Resolution
* Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics)
* in the *Amazon CloudWatch User Guide* .
* * Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't
* supported.
*
*
* * *CALCULATED* : For health checks that monitor the status of other health checks, Route 53
* adds up the number of health checks that Route 53 health checkers consider to be healthy and
* compares that number with the value of `HealthThreshold` .
* * *RECOVERY_CONTROL* : The health check is assocated with a Route53 Application Recovery
* Controller routing control. If the routing control state is `ON` , the health check is
* considered healthy. If the state is `OFF` , the health check is considered unhealthy.
*
* For more information, see [How Route 53 Determines Whether an Endpoint Is
* Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html)
* in the *Amazon Route 53 Developer Guide* .
*/
override fun type(type: String) {
cdkBuilder.type(type)
}
public fun build():
software.amazon.awscdk.services.route53.CfnHealthCheck.HealthCheckConfigProperty =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.route53.CfnHealthCheck.HealthCheckConfigProperty,
) : CdkObject(cdkObject),
HealthCheckConfigProperty {
/**
* 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.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-alarmidentifier)
*/
override fun alarmIdentifier(): Any? = unwrap(this).getAlarmIdentifier()
/**
* (CALCULATED Health Checks Only) A complex type that contains one `ChildHealthCheck` element
* for each health check that you want to associate with a `CALCULATED` health check.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-childhealthchecks)
*/
override fun childHealthChecks(): List = unwrap(this).getChildHealthChecks() ?:
emptyList()
/**
* 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.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-enablesni)
*/
override fun enableSni(): Any? = unwrap(this).getEnableSni()
/**
* 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](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html)
* in the *Amazon Route 53 Developer Guide* .
*
* If you don't specify a value for `FailureThreshold` , the default value is three health
* checks.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-failurethreshold)
*/
override fun failureThreshold(): Number? = unwrap(this).getFailureThreshold()
/**
* Amazon Route 53 behavior depends on whether you specify a value for `IPAddress` .
*
* *If you specify a value for* `IPAddress` :
*
* Amazon 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 preceding cases.
*
* *If you don't specify a value for `IPAddress`* :
*
* Route 53 sends a DNS request to the domain that you specify for `FullyQualifiedDomainName`
* at the interval that you specify for `RequestInterval` . Using an IPv4 address that DNS
* returns, 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 record 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 multiple records that have the same name and type, such
* as multiple weighted records, and if 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 records (www.example.com).
*
*
* In this configuration, if you create a health check for which the value of
* `FullyQualifiedDomainName` matches the name of the records and you then associate the health
* check with those records, health check results will be unpredictable.
*
*
* In addition, if the value that you specify for `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.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-fullyqualifieddomainname)
*/
override fun fullyQualifiedDomainName(): String? = unwrap(this).getFullyQualifiedDomainName()
/**
* The number of child health checks that are associated with a `CALCULATED` health check 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](https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-ChildHealthChecks)
* element.
*
* 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.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-healththreshold)
*/
override fun healthThreshold(): Number? = unwrap(this).getHealthThreshold()
/**
* 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 that
* 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.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-insufficientdatahealthstatus)
*/
override fun insufficientDataHealthStatus(): String? =
unwrap(this).getInsufficientDataHealthStatus()
/**
* 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.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-inverted)
*/
override fun inverted(): Any? = unwrap(this).getInverted()
/**
* The IPv4 or IPv6 IP address of 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 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 will never change.
*
* For more information, see
* [FullyQualifiedDomainName](https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-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](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc5735)
* * [RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address
* Space](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6598)
* * [RFC 5156, Special-Use IPv6
* Addresses](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc5156)
*
* When the value of `Type` is `CALCULATED` or `CLOUDWATCH_METRIC` , omit `IPAddress` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-ipaddress)
*/
override fun ipAddress(): String? = unwrap(this).getIpAddress()
/**
* Specify whether you want Amazon Route 53 to measure the latency between health checkers in
* multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the
* *Health Checks* page in the Route 53 console.
*
*
* You can't change the value of `MeasureLatency` after you create a health check.
*
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-measurelatency)
*/
override fun measureLatency(): Any? = unwrap(this).getMeasureLatency()
/**
* 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-type)
* of `CLOUDWATCH_METRIC` or `CALCULATED` .
*
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-port)
*/
override fun port(): Number? = unwrap(this).getPort()
/**
* A complex type that contains one `Region` element for each region from which you want
* Amazon Route 53 health checkers to check the specified endpoint.
*
* If you don't specify any regions, Route 53 health checkers automatically performs checks
* from all of the regions that are listed under *Valid Values* .
*
* If you update a health check to remove a region that has been performing health checks,
* Route 53 will briefly continue to perform checks from that region to ensure that some health
* checkers are always checking the endpoint (for example, if you replace three regions with four
* different regions).
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-regions)
*/
override fun regions(): List = unwrap(this).getRegions() ?: emptyList()
/**
* The number of seconds between the time that Amazon Route 53 gets a response from your
* endpoint and the time that it sends the next health check request.
*
* Each Route 53 health checker makes requests at this interval.
*
*
* You can't change the value of `RequestInterval` after you create a health check.
*
*
* If you don't specify a value for `RequestInterval` , the default value is `30` seconds.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-requestinterval)
*/
override fun requestInterval(): Number? = unwrap(this).getRequestInterval()
/**
* The path, if any, 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`
* .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-resourcepath)
*/
override fun resourcePath(): String? = unwrap(this).getResourcePath()
/**
* The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing
* control.
*
* For more information about Route 53 Application Recovery Controller, see [Route 53
* Application Recovery Controller Developer
* Guide.](https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route-53-recovery.html) .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-routingcontrolarn)
*/
override fun routingControlArn(): String? = unwrap(this).getRoutingControlArn()
/**
* 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.
*
* Route 53 considers case when searching for `SearchString` in the response body.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-searchstring)
*/
override fun searchString(): String? = unwrap(this).getSearchString()
/**
* The type of health check that you want to create, which indicates how Amazon Route 53
* determines whether an endpoint is healthy.
*
*
* You can't change the value of `Type` after you create a health check.
*
*
* You can create the following types of health checks:
*
* * *HTTP* : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an
* HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
* * *HTTPS* : Route 53 tries to establish a TCP connection. If successful, Route 53 submits
* an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
*
*
* If you specify `HTTPS` for the value of `Type` , the endpoint must support TLS v1.0 or
* later.
*
*
* * *HTTP_STR_MATCH* : Route 53 tries to establish a TCP connection. If successful, Route 53
* submits an HTTP request and searches the first 5,120 bytes of the response body for the string
* that you specify in `SearchString` .
* * *HTTPS_STR_MATCH* : Route 53 tries to establish a TCP connection. If successful, Route 53
* submits an `HTTPS` request and searches the first 5,120 bytes of the response body for the
* string that you specify in `SearchString` .
* * *TCP* : Route 53 tries to establish a TCP connection.
* * *CLOUDWATCH_METRIC* : The health check is associated with a CloudWatch alarm. If the
* state of the alarm is `OK` , the health check is considered healthy. If the state is `ALARM` ,
* the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to
* determine whether the state is `OK` or `ALARM` , the health check status depends on the
* setting for `InsufficientDataHealthStatus` : `Healthy` , `Unhealthy` , or `LastKnownStatus` .
*
*
* Route 53 supports CloudWatch alarms with the following features:
*
* * Standard-resolution metrics. High-resolution metrics aren't supported. For more
* information, see [High-Resolution
* Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics)
* in the *Amazon CloudWatch User Guide* .
* * Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't
* supported.
*
*
* * *CALCULATED* : For health checks that monitor the status of other health checks, Route 53
* adds up the number of health checks that Route 53 health checkers consider to be healthy and
* compares that number with the value of `HealthThreshold` .
* * *RECOVERY_CONTROL* : The health check is assocated with a Route53 Application Recovery
* Controller routing control. If the routing control state is `ON` , the health check is
* considered healthy. If the state is `OFF` , the health check is considered unhealthy.
*
* For more information, see [How Route 53 Determines Whether an Endpoint Is
* Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html)
* in the *Amazon Route 53 Developer Guide* .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-type)
*/
override fun type(): String = unwrap(this).getType()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): HealthCheckConfigProperty {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.services.route53.CfnHealthCheck.HealthCheckConfigProperty):
HealthCheckConfigProperty = CdkObjectWrappers.wrap(cdkObject) as?
HealthCheckConfigProperty ?: Wrapper(cdkObject)
internal fun unwrap(wrapped: HealthCheckConfigProperty):
software.amazon.awscdk.services.route53.CfnHealthCheck.HealthCheckConfigProperty =
(wrapped as CdkObject).cdkObject as
software.amazon.awscdk.services.route53.CfnHealthCheck.HealthCheckConfigProperty
}
}
/**
* The `HealthCheckTag` property describes one key-value pair that is associated with an
* `AWS::Route53::HealthCheck` resource.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.services.route53.*;
* HealthCheckTagProperty healthCheckTagProperty = HealthCheckTagProperty.builder()
* .key("key")
* .value("value")
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html)
*/
public interface HealthCheckTagProperty {
/**
* The value of `Key` depends on the operation that you want to perform:.
*
* * *Add a tag to a health check or hosted zone* : `Key` is the name that you want to give the
* new tag.
* * *Edit a tag* : `Key` is the name of the tag that you want to change the `Value` for.
* * *Delete a key* : `Key` is the name of the tag you want to remove.
* * *Give a name to a health check* : Edit the default `Name` tag. In the Amazon Route 53
* console, the list of your health checks includes a *Name* column that lets you see the name that
* you've given to each health check.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html#cfn-route53-healthcheck-healthchecktag-key)
*/
public fun key(): String
/**
* The value of `Value` depends on the operation that you want to perform:.
*
* * *Add a tag to a health check or hosted zone* : `Value` is the value that you want to give
* the new tag.
* * *Edit a tag* : `Value` is the new value that you want to assign the tag.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html#cfn-route53-healthcheck-healthchecktag-value)
*/
public fun `value`(): String
/**
* A builder for [HealthCheckTagProperty]
*/
@CdkDslMarker
public interface Builder {
/**
* @param key The value of `Key` depends on the operation that you want to perform:.
* * *Add a tag to a health check or hosted zone* : `Key` is the name that you want to give
* the new tag.
* * *Edit a tag* : `Key` is the name of the tag that you want to change the `Value` for.
* * *Delete a key* : `Key` is the name of the tag you want to remove.
* * *Give a name to a health check* : Edit the default `Name` tag. In the Amazon Route 53
* console, the list of your health checks includes a *Name* column that lets you see the name
* that you've given to each health check.
*/
public fun key(key: String)
/**
* @param value The value of `Value` depends on the operation that you want to perform:.
* * *Add a tag to a health check or hosted zone* : `Value` is the value that you want to give
* the new tag.
* * *Edit a tag* : `Value` is the new value that you want to assign the tag.
*/
public fun `value`(`value`: String)
}
private class BuilderImpl : Builder {
private val cdkBuilder:
software.amazon.awscdk.services.route53.CfnHealthCheck.HealthCheckTagProperty.Builder =
software.amazon.awscdk.services.route53.CfnHealthCheck.HealthCheckTagProperty.builder()
/**
* @param key The value of `Key` depends on the operation that you want to perform:.
* * *Add a tag to a health check or hosted zone* : `Key` is the name that you want to give
* the new tag.
* * *Edit a tag* : `Key` is the name of the tag that you want to change the `Value` for.
* * *Delete a key* : `Key` is the name of the tag you want to remove.
* * *Give a name to a health check* : Edit the default `Name` tag. In the Amazon Route 53
* console, the list of your health checks includes a *Name* column that lets you see the name
* that you've given to each health check.
*/
override fun key(key: String) {
cdkBuilder.key(key)
}
/**
* @param value The value of `Value` depends on the operation that you want to perform:.
* * *Add a tag to a health check or hosted zone* : `Value` is the value that you want to give
* the new tag.
* * *Edit a tag* : `Value` is the new value that you want to assign the tag.
*/
override fun `value`(`value`: String) {
cdkBuilder.`value`(`value`)
}
public fun build():
software.amazon.awscdk.services.route53.CfnHealthCheck.HealthCheckTagProperty =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.route53.CfnHealthCheck.HealthCheckTagProperty,
) : CdkObject(cdkObject),
HealthCheckTagProperty {
/**
* The value of `Key` depends on the operation that you want to perform:.
*
* * *Add a tag to a health check or hosted zone* : `Key` is the name that you want to give
* the new tag.
* * *Edit a tag* : `Key` is the name of the tag that you want to change the `Value` for.
* * *Delete a key* : `Key` is the name of the tag you want to remove.
* * *Give a name to a health check* : Edit the default `Name` tag. In the Amazon Route 53
* console, the list of your health checks includes a *Name* column that lets you see the name
* that you've given to each health check.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html#cfn-route53-healthcheck-healthchecktag-key)
*/
override fun key(): String = unwrap(this).getKey()
/**
* The value of `Value` depends on the operation that you want to perform:.
*
* * *Add a tag to a health check or hosted zone* : `Value` is the value that you want to give
* the new tag.
* * *Edit a tag* : `Value` is the new value that you want to assign the tag.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html#cfn-route53-healthcheck-healthchecktag-value)
*/
override fun `value`(): String = unwrap(this).getValue()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): HealthCheckTagProperty {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.services.route53.CfnHealthCheck.HealthCheckTagProperty):
HealthCheckTagProperty = CdkObjectWrappers.wrap(cdkObject) as? HealthCheckTagProperty ?:
Wrapper(cdkObject)
internal fun unwrap(wrapped: HealthCheckTagProperty):
software.amazon.awscdk.services.route53.CfnHealthCheck.HealthCheckTagProperty = (wrapped
as CdkObject).cdkObject as
software.amazon.awscdk.services.route53.CfnHealthCheck.HealthCheckTagProperty
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy