1. Packages
  2. AWS Native
  3. API Docs
  4. route53
  5. getHealthCheck

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

aws-native.route53.getHealthCheck

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

    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:

    getHealthCheck Result

    The following output properties are available:

    HealthCheckConfig Pulumi.AwsNative.Route53.Outputs.HealthCheckConfigProperties
    A complex type that contains information about the health check.
    HealthCheckId string
    HealthCheckTags List<Pulumi.AwsNative.Route53.Outputs.HealthCheckTag>
    An array of key-value pairs to apply to this resource.
    HealthCheckConfig HealthCheckConfigProperties
    A complex type that contains information about the health check.
    HealthCheckId string
    HealthCheckTags []HealthCheckTag
    An array of key-value pairs to apply to this resource.
    healthCheckConfig HealthCheckConfigProperties
    A complex type that contains information about the health check.
    healthCheckId String
    healthCheckTags List<HealthCheckTag>
    An array of key-value pairs to apply to this resource.
    healthCheckConfig HealthCheckConfigProperties
    A complex type that contains information about the health check.
    healthCheckId string
    healthCheckTags HealthCheckTag[]
    An array of key-value pairs to apply to this resource.
    health_check_config HealthCheckConfigProperties
    A complex type that contains information about the health check.
    health_check_id str
    health_check_tags Sequence[HealthCheckTag]
    An array of key-value pairs to apply to this resource.
    healthCheckConfig Property Map
    A complex type that contains information about the health check.
    healthCheckId String
    healthCheckTags 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

    HealthCheckConfigPropertiesInsufficientDataHealthStatus

    HealthCheckConfigPropertiesType

    HealthCheckTag

    Key string
    The key name of the tag.
    Value string
    The value for the tag.
    Key string
    The key name of the tag.
    Value string
    The value for the tag.
    key String
    The key name of the tag.
    value String
    The value for the tag.
    key string
    The key name of the tag.
    value string
    The value for the tag.
    key str
    The key name of the tag.
    value str
    The value for the tag.
    key String
    The key name of the tag.
    value String
    The value for the tag.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi