@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)", date="2022-08-09T19:16:40.484Z") public class CfnHealthCheck extends CfnResource implements IInspectable
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:
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnHealthCheck(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrHealthCheckId()
The identifier that Amazon Route 53 assigned to the health check when you created it.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getHealthCheckConfig()
A complex type that contains detailed information about one health check.
|
java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.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(java.util.List<java.lang.Object> value)
The `HealthCheckTags` property describes key-value pairs that are associated with an `AWS::Route53::HealthCheck` resource.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnHealthCheck(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnHealthCheck(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnHealthCheck(Construct scope, java.lang.String id, CfnHealthCheckProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrHealthCheckId()
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.
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.Object getHealthCheckConfig()
For the values to enter for HealthCheckConfig
, see HealthCheckConfig
public void setHealthCheckConfig(IResolvable value)
For the values to enter for HealthCheckConfig
, see HealthCheckConfig
public void setHealthCheckConfig(CfnHealthCheck.HealthCheckConfigProperty value)
For the values to enter for HealthCheckConfig
, see HealthCheckConfig
public java.lang.Object getHealthCheckTags()
public void setHealthCheckTags(IResolvable value)
public void setHealthCheckTags(java.util.List<java.lang.Object> value)