software.amazon.awscdk.services.route53

Class CfnHealthCheck

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.route53.CfnHealthCheck

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.600Z")
 @Stability(value=Stable)
public class CfnHealthCheck
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Route53::HealthCheck`.

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 in ChangeResourceRecordSets .

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnHealthCheck.AlarmIdentifierProperty Example:
static class	CfnHealthCheck.Builder A fluent builder for CfnHealthCheck.
static interface	CfnHealthCheck.HealthCheckConfigProperty Example:
static interface	CfnHealthCheck.HealthCheckTagProperty The `HealthCheckTag` property describes one key-value pair that is associated with an `AWS::Route53::HealthCheck` resource.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnHealthCheck(software.constructs.Construct scope, String id, CfnHealthCheckProps props) Create a new `AWS::Route53::HealthCheck`.
protected	CfnHealthCheck(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnHealthCheck(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrHealthCheckId() The identifier that Amazon Route 53 assigned to the health check when you created it.
protected Map<String,Object>	getCfnProperties()
Object	getHealthCheckConfig() A complex type that contains detailed information about one health check.
Object	getHealthCheckTags() The `HealthCheckTags` property describes key-value pairs that are associated with an `AWS::Route53::HealthCheck` resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setHealthCheckConfig(CfnHealthCheck.HealthCheckConfigProperty value) A complex type that contains detailed information about one health check.
void	setHealthCheckConfig(IResolvable value) A complex type that contains detailed information about one health check.
void	setHealthCheckTags(IResolvable value) The `HealthCheckTags` property describes key-value pairs that are associated with an `AWS::Route53::HealthCheck` resource.
void	setHealthCheckTags(List<Object> value) The `HealthCheckTags` property describes key-value pairs that are associated with an `AWS::Route53::HealthCheck` resource.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnHealthCheck

protected CfnHealthCheck(software.amazon.jsii.JsiiObjectRef objRef)

CfnHealthCheck

protected CfnHealthCheck(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnHealthCheck

@Stability(value=Stable)
public CfnHealthCheck(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnHealthCheckProps props)

Create a new `AWS::Route53::HealthCheck`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrHealthCheckId

@Stability(value=Stable)
 @NotNull
public String getAttrHealthCheckId()

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.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getHealthCheckConfig

@Stability(value=Stable)
 @NotNull
public Object getHealthCheckConfig()

A complex type that contains detailed information about one health check.

For the values to enter for HealthCheckConfig , see HealthCheckConfig

setHealthCheckConfig

@Stability(value=Stable)
public void setHealthCheckConfig(@NotNull
                                                          CfnHealthCheck.HealthCheckConfigProperty value)

A complex type that contains detailed information about one health check.

For the values to enter for HealthCheckConfig , see HealthCheckConfig

setHealthCheckConfig

@Stability(value=Stable)
public void setHealthCheckConfig(@NotNull
                                                          IResolvable value)

A complex type that contains detailed information about one health check.

For the values to enter for HealthCheckConfig , see HealthCheckConfig

getHealthCheckTags

@Stability(value=Stable)
 @Nullable
public Object getHealthCheckTags()

The `HealthCheckTags` property describes key-value pairs that are associated with an `AWS::Route53::HealthCheck` resource.

setHealthCheckTags

@Stability(value=Stable)
public void setHealthCheckTags(@Nullable
                                                        IResolvable value)

The `HealthCheckTags` property describes key-value pairs that are associated with an `AWS::Route53::HealthCheck` resource.

setHealthCheckTags

@Stability(value=Stable)
public void setHealthCheckTags(@Nullable
                                                        List<Object> value)

The `HealthCheckTags` property describes key-value pairs that are associated with an `AWS::Route53::HealthCheck` resource.