Class CfnHealthCheck
The AWS::Route53::HealthCheck
resource is a Route 53 resource type that contains settings for a Route 53 health check.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Route53
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnHealthCheck : CfnResource, IInspectable
Syntax (vb)
Public Class CfnHealthCheck
Inherits CfnResource
Implements IInspectable
Remarks
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:
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html
CloudformationResource: AWS::Route53::HealthCheck
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Route53;
var cfnHealthCheck = new CfnHealthCheck(this, "MyCfnHealthCheck", new CfnHealthCheckProps {
HealthCheckConfig = new HealthCheckConfigProperty {
Type = "type",
// the properties below are optional
AlarmIdentifier = new AlarmIdentifierProperty {
Name = "name",
Region = "region"
},
ChildHealthChecks = new [] { "childHealthChecks" },
EnableSni = false,
FailureThreshold = 123,
FullyQualifiedDomainName = "fullyQualifiedDomainName",
HealthThreshold = 123,
InsufficientDataHealthStatus = "insufficientDataHealthStatus",
Inverted = false,
IpAddress = "ipAddress",
MeasureLatency = false,
Port = 123,
Regions = new [] { "regions" },
RequestInterval = 123,
ResourcePath = "resourcePath",
RoutingControlArn = "routingControlArn",
SearchString = "searchString"
},
// the properties below are optional
HealthCheckTags = new [] { new HealthCheckTagProperty {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnHealthCheck(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnHealthCheck(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnHealthCheck(Construct, String, ICfnHealthCheckProps) |
Properties
AttrHealthCheckId | The identifier that Amazon Route 53 assigned to the health check when you created it. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
HealthCheckConfig | A complex type that contains detailed information about one health check. |
HealthCheckTags | The |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnHealthCheck(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnHealthCheck(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnHealthCheck(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnHealthCheck(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnHealthCheck(Construct, String, ICfnHealthCheckProps)
public CfnHealthCheck(Construct scope, string id, ICfnHealthCheckProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnHealthCheckProps
Resource properties.
Properties
AttrHealthCheckId
The identifier that Amazon Route 53 assigned to the health check when you created it.
public virtual string AttrHealthCheckId { get; }
Property Value
System.String
Remarks
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.
CloudformationAttribute: HealthCheckId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
HealthCheckConfig
A complex type that contains detailed information about one health check.
public virtual object HealthCheckConfig { get; set; }
Property Value
System.Object
HealthCheckTags
The HealthCheckTags
property describes key-value pairs that are associated with an AWS::Route53::HealthCheck
resource.
public virtual object HealthCheckTags { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>