AWS Native is in preview. AWS Classic is fully supported.
aws-native.route53.getHealthCheck
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Resource schema for AWS::Route53::HealthCheck.
Using getHealthCheck
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getHealthCheck(args: GetHealthCheckArgs, opts?: InvokeOptions): Promise<GetHealthCheckResult>
function getHealthCheckOutput(args: GetHealthCheckOutputArgs, opts?: InvokeOptions): Output<GetHealthCheckResult>
def get_health_check(health_check_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetHealthCheckResult
def get_health_check_output(health_check_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetHealthCheckResult]
func LookupHealthCheck(ctx *Context, args *LookupHealthCheckArgs, opts ...InvokeOption) (*LookupHealthCheckResult, error)
func LookupHealthCheckOutput(ctx *Context, args *LookupHealthCheckOutputArgs, opts ...InvokeOption) LookupHealthCheckResultOutput
> Note: This function is named LookupHealthCheck
in the Go SDK.
public static class GetHealthCheck
{
public static Task<GetHealthCheckResult> InvokeAsync(GetHealthCheckArgs args, InvokeOptions? opts = null)
public static Output<GetHealthCheckResult> Invoke(GetHealthCheckInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetHealthCheckResult> getHealthCheck(GetHealthCheckArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:route53:getHealthCheck
arguments:
# arguments dictionary
The following arguments are supported:
- Health
Check stringId
- Health
Check stringId
- health
Check StringId
- health
Check stringId
- health_
check_ strid
- health
Check StringId
getHealthCheck Result
The following output properties are available:
- Health
Check Pulumi.Config Aws Native. Route53. Outputs. Health Check Config Properties A complex type that contains information about the health check.
- Health
Check stringId - List<Pulumi.
Aws Native. Route53. Outputs. Health Check Tag> An array of key-value pairs to apply to this resource.
- Health
Check HealthConfig Check Config Properties A complex type that contains information about the health check.
- Health
Check stringId - []Health
Check Tag An array of key-value pairs to apply to this resource.
- health
Check HealthConfig Check Config Properties A complex type that contains information about the health check.
- health
Check StringId - List<Health
Check Tag> An array of key-value pairs to apply to this resource.
- health
Check HealthConfig Check Config Properties A complex type that contains information about the health check.
- health
Check stringId - Health
Check Tag[] An array of key-value pairs to apply to this resource.
- health_
check_ Healthconfig Check Config Properties A complex type that contains information about the health check.
- health_
check_ strid - Sequence[Health
Check Tag] An array of key-value pairs to apply to this resource.
- health
Check Property MapConfig A complex type that contains information about the health check.
- health
Check StringId - List<Property Map>
An array of key-value pairs to apply to this resource.
Supporting Types
HealthCheckAlarmIdentifier
- Name string
The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
- Region 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.
- Name string
The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
- Region 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.
- name String
The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
- region 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.
- name string
The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
- region 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.
- name str
The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
- region str
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.
- name String
The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
- region 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.
HealthCheckConfigProperties
- Type
Pulumi.
Aws Native. Route53. Health Check Config Properties Type - Alarm
Identifier Pulumi.Aws Native. Route53. Inputs. Health Check Alarm Identifier - Child
Health List<string>Checks - Enable
Sni bool - Failure
Threshold int - Fully
Qualified stringDomain Name - Health
Threshold int - Insufficient
Data Pulumi.Health Status Aws Native. Route53. Health Check Config Properties Insufficient Data Health Status - Inverted bool
- Ip
Address string - Measure
Latency bool - Port int
- Regions List<string>
- Request
Interval int - Resource
Path string - Routing
Control stringArn - Search
String string
- Type
Health
Check Config Properties Type - Alarm
Identifier HealthCheck Alarm Identifier - Child
Health []stringChecks - Enable
Sni bool - Failure
Threshold int - Fully
Qualified stringDomain Name - Health
Threshold int - Insufficient
Data HealthHealth Status Check Config Properties Insufficient Data Health Status - Inverted bool
- Ip
Address string - Measure
Latency bool - Port int
- Regions []string
- Request
Interval int - Resource
Path string - Routing
Control stringArn - Search
String string
- type
Health
Check Config Properties Type - alarm
Identifier HealthCheck Alarm Identifier - child
Health List<String>Checks - enable
Sni Boolean - failure
Threshold Integer - fully
Qualified StringDomain Name - health
Threshold Integer - insufficient
Data HealthHealth Status Check Config Properties Insufficient Data Health Status - inverted Boolean
- ip
Address String - measure
Latency Boolean - port Integer
- regions List<String>
- request
Interval Integer - resource
Path String - routing
Control StringArn - search
String String
- type
Health
Check Config Properties Type - alarm
Identifier HealthCheck Alarm Identifier - child
Health string[]Checks - enable
Sni boolean - failure
Threshold number - fully
Qualified stringDomain Name - health
Threshold number - insufficient
Data HealthHealth Status Check Config Properties Insufficient Data Health Status - inverted boolean
- ip
Address string - measure
Latency boolean - port number
- regions string[]
- request
Interval number - resource
Path string - routing
Control stringArn - search
String string
- type
Health
Check Config Properties Type - alarm_
identifier HealthCheck Alarm Identifier - child_
health_ Sequence[str]checks - enable_
sni bool - failure_
threshold int - fully_
qualified_ strdomain_ name - health_
threshold int - insufficient_
data_ Healthhealth_ status Check Config Properties Insufficient Data Health Status - inverted bool
- ip_
address str - measure_
latency bool - port int
- regions Sequence[str]
- request_
interval int - resource_
path str - routing_
control_ strarn - search_
string str
- type "CALCULATED" | "CLOUDWATCH_METRIC" | "HTTP" | "HTTP_STR_MATCH" | "HTTPS" | "HTTPS_STR_MATCH" | "TCP" | "RECOVERY_CONTROL"
- alarm
Identifier Property Map - child
Health List<String>Checks - enable
Sni Boolean - failure
Threshold Number - fully
Qualified StringDomain Name - health
Threshold Number - insufficient
Data "Healthy" | "LastHealth Status Known Status" | "Unhealthy" - inverted Boolean
- ip
Address String - measure
Latency Boolean - port Number
- regions List<String>
- request
Interval Number - resource
Path String - routing
Control StringArn - search
String String
HealthCheckConfigPropertiesInsufficientDataHealthStatus
HealthCheckConfigPropertiesType
HealthCheckTag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.