Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cyral Provider
  3. API Docs
  4. getSidecarHealth
cyral 4.16.3 published on Monday, Apr 14, 2025 by cyralinc
cyralinc/terraform-provider-cyral

cyral.getSidecarHealth

Explore with Pulumi AI

cyral logo
cyral 4.16.3 published on Monday, Apr 14, 2025 by cyralinc
cyralinc/terraform-provider-cyral

    Retrieve aggregated information about the sidecar’s health, considering all instances of the sidecar.

    Using getSidecarHealth

    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 getSidecarHealth(args: GetSidecarHealthArgs, opts?: InvokeOptions): Promise<GetSidecarHealthResult>
function getSidecarHealthOutput(args: GetSidecarHealthOutputArgs, opts?: InvokeOptions): Output<GetSidecarHealthResult>
    def get_sidecar_health(sidecar_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetSidecarHealthResult
def get_sidecar_health_output(sidecar_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetSidecarHealthResult]
    func GetSidecarHealth(ctx *Context, args *GetSidecarHealthArgs, opts ...InvokeOption) (*GetSidecarHealthResult, error)
func GetSidecarHealthOutput(ctx *Context, args *GetSidecarHealthOutputArgs, opts ...InvokeOption) GetSidecarHealthResultOutput

    > Note: This function is named GetSidecarHealth in the Go SDK.

    public static class GetSidecarHealth 
{
    public static Task<GetSidecarHealthResult> InvokeAsync(GetSidecarHealthArgs args, InvokeOptions? opts = null)
    public static Output<GetSidecarHealthResult> Invoke(GetSidecarHealthInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSidecarHealthResult> getSidecarHealth(GetSidecarHealthArgs args, InvokeOptions options)
public static Output<GetSidecarHealthResult> getSidecarHealth(GetSidecarHealthArgs args, InvokeOptions options)

    fn::invoke:
  function: cyral:index/getSidecarHealth:getSidecarHealth
  arguments:
    # arguments dictionary

    The following arguments are supported:

    SidecarId string
    ID of the Sidecar that will be used to retrieve health information.
    SidecarId string
    ID of the Sidecar that will be used to retrieve health information.
    sidecarId String
    ID of the Sidecar that will be used to retrieve health information.
    sidecarId string
    ID of the Sidecar that will be used to retrieve health information.
    sidecar_id str
    ID of the Sidecar that will be used to retrieve health information.
    sidecarId String
    ID of the Sidecar that will be used to retrieve health information.

    getSidecarHealth Result

    The following output properties are available:

    Id string
    Data source identifier.
    SidecarId string
    ID of the Sidecar that will be used to retrieve health information.
    Status string
    Sidecar health status. Possible values are: HEALTHY, DEGRADED, UNHEALTHY and UNKNOWN. For more information, see Sidecar Status.
    Id string
    Data source identifier.
    SidecarId string
    ID of the Sidecar that will be used to retrieve health information.
    Status string
    Sidecar health status. Possible values are: HEALTHY, DEGRADED, UNHEALTHY and UNKNOWN. For more information, see Sidecar Status.
    id String
    Data source identifier.
    sidecarId String
    ID of the Sidecar that will be used to retrieve health information.
    status String
    Sidecar health status. Possible values are: HEALTHY, DEGRADED, UNHEALTHY and UNKNOWN. For more information, see Sidecar Status.
    id string
    Data source identifier.
    sidecarId string
    ID of the Sidecar that will be used to retrieve health information.
    status string
    Sidecar health status. Possible values are: HEALTHY, DEGRADED, UNHEALTHY and UNKNOWN. For more information, see Sidecar Status.
    id str
    Data source identifier.
    sidecar_id str
    ID of the Sidecar that will be used to retrieve health information.
    status str
    Sidecar health status. Possible values are: HEALTHY, DEGRADED, UNHEALTHY and UNKNOWN. For more information, see Sidecar Status.
    id String
    Data source identifier.
    sidecarId String
    ID of the Sidecar that will be used to retrieve health information.
    status String
    Sidecar health status. Possible values are: HEALTHY, DEGRADED, UNHEALTHY and UNKNOWN. For more information, see Sidecar Status.

    Package Details

    Repository
    cyral cyralinc/terraform-provider-cyral
    License
    Notes
    This Pulumi package is based on the cyral Terraform Provider.
    cyral logo
    cyral 4.16.3 published on Monday, Apr 14, 2025 by cyralinc
    cyralinc/terraform-provider-cyral