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

cyral.getSidecarInstance

Explore with Pulumi AI

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

    # cyral.getSidecarInstance (Data Source)

    Retrieve sidecar instances.

    Using getSidecarInstance

    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 getSidecarInstance(args: GetSidecarInstanceArgs, opts?: InvokeOptions): Promise<GetSidecarInstanceResult>
function getSidecarInstanceOutput(args: GetSidecarInstanceOutputArgs, opts?: InvokeOptions): Output<GetSidecarInstanceResult>
    def get_sidecar_instance(sidecar_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetSidecarInstanceResult
def get_sidecar_instance_output(sidecar_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetSidecarInstanceResult]
    func GetSidecarInstance(ctx *Context, args *GetSidecarInstanceArgs, opts ...InvokeOption) (*GetSidecarInstanceResult, error)
func GetSidecarInstanceOutput(ctx *Context, args *GetSidecarInstanceOutputArgs, opts ...InvokeOption) GetSidecarInstanceResultOutput

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

    public static class GetSidecarInstance 
{
    public static Task<GetSidecarInstanceResult> InvokeAsync(GetSidecarInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetSidecarInstanceResult> Invoke(GetSidecarInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSidecarInstanceResult> getSidecarInstance(GetSidecarInstanceArgs args, InvokeOptions options)
public static Output<GetSidecarInstanceResult> getSidecarInstance(GetSidecarInstanceArgs args, InvokeOptions options)

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

    The following arguments are supported:

    SidecarId string
    Sidecar identifier.
    SidecarId string
    Sidecar identifier.
    sidecarId String
    Sidecar identifier.
    sidecarId string
    Sidecar identifier.
    sidecar_id str
    Sidecar identifier.
    sidecarId String
    Sidecar identifier.

    getSidecarInstance Result

    The following output properties are available:

    Id string
    Data source identifier.
    InstanceLists List<GetSidecarInstanceInstanceList>
    List of existing sidecar instances.
    SidecarId string
    Sidecar identifier.
    Id string
    Data source identifier.
    InstanceLists []GetSidecarInstanceInstanceList
    List of existing sidecar instances.
    SidecarId string
    Sidecar identifier.
    id String
    Data source identifier.
    instanceLists List<GetSidecarInstanceInstanceList>
    List of existing sidecar instances.
    sidecarId String
    Sidecar identifier.
    id string
    Data source identifier.
    instanceLists GetSidecarInstanceInstanceList[]
    List of existing sidecar instances.
    sidecarId string
    Sidecar identifier.
    id str
    Data source identifier.
    instance_lists Sequence[GetSidecarInstanceInstanceList]
    List of existing sidecar instances.
    sidecar_id str
    Sidecar identifier.
    id String
    Data source identifier.
    instanceLists List<Property Map>
    List of existing sidecar instances.
    sidecarId String
    Sidecar identifier.

    Supporting Types

    GetSidecarInstanceInstanceList

    Id string
    Instance identifier. Varies according to the computing platform that the sidecar is deployed to.
    Metadatas List<GetSidecarInstanceInstanceListMetadata>
    Instance metadata.
    Monitorings List<GetSidecarInstanceInstanceListMonitoring>
    Instance monitoring information, such as its overall health.
    Id string
    Instance identifier. Varies according to the computing platform that the sidecar is deployed to.
    Metadatas []GetSidecarInstanceInstanceListMetadata
    Instance metadata.
    Monitorings []GetSidecarInstanceInstanceListMonitoring
    Instance monitoring information, such as its overall health.
    id String
    Instance identifier. Varies according to the computing platform that the sidecar is deployed to.
    metadatas List<GetSidecarInstanceInstanceListMetadata>
    Instance metadata.
    monitorings List<GetSidecarInstanceInstanceListMonitoring>
    Instance monitoring information, such as its overall health.
    id string
    Instance identifier. Varies according to the computing platform that the sidecar is deployed to.
    metadatas GetSidecarInstanceInstanceListMetadata[]
    Instance metadata.
    monitorings GetSidecarInstanceInstanceListMonitoring[]
    Instance monitoring information, such as its overall health.
    id str
    Instance identifier. Varies according to the computing platform that the sidecar is deployed to.
    metadatas Sequence[GetSidecarInstanceInstanceListMetadata]
    Instance metadata.
    monitorings Sequence[GetSidecarInstanceInstanceListMonitoring]
    Instance monitoring information, such as its overall health.
    id String
    Instance identifier. Varies according to the computing platform that the sidecar is deployed to.
    metadatas List<Property Map>
    Instance metadata.
    monitorings List<Property Map>
    Instance monitoring information, such as its overall health.

    GetSidecarInstanceInstanceListMetadata

    Capabilities List<GetSidecarInstanceInstanceListMetadataCapability>
    Set of capabilities that can be enabled or disabled. Note: This field is per-instance, not per-sidecar, because not all sidecar instances might be in sync at some point in time.
    DynamicVersion bool
    If true, indicates that the instance has dynamic versioning, that means that the version is not fixed at template level and it can be automatically upgraded.
    LastRegistration string
    The last time the instance reported to the Control Plane.
    Recycling bool
    Indicates whether the Control Plane has asked the instance to mark itself unhealthy so that it is recycled by the infrastructure.
    StartTimestamp string
    The time when the instance started.
    Version string
    Sidecar version that the instance is using.
    Capabilities []GetSidecarInstanceInstanceListMetadataCapability
    Set of capabilities that can be enabled or disabled. Note: This field is per-instance, not per-sidecar, because not all sidecar instances might be in sync at some point in time.
    DynamicVersion bool
    If true, indicates that the instance has dynamic versioning, that means that the version is not fixed at template level and it can be automatically upgraded.
    LastRegistration string
    The last time the instance reported to the Control Plane.
    Recycling bool
    Indicates whether the Control Plane has asked the instance to mark itself unhealthy so that it is recycled by the infrastructure.
    StartTimestamp string
    The time when the instance started.
    Version string
    Sidecar version that the instance is using.
    capabilities List<GetSidecarInstanceInstanceListMetadataCapability>
    Set of capabilities that can be enabled or disabled. Note: This field is per-instance, not per-sidecar, because not all sidecar instances might be in sync at some point in time.
    dynamicVersion Boolean
    If true, indicates that the instance has dynamic versioning, that means that the version is not fixed at template level and it can be automatically upgraded.
    lastRegistration String
    The last time the instance reported to the Control Plane.
    recycling Boolean
    Indicates whether the Control Plane has asked the instance to mark itself unhealthy so that it is recycled by the infrastructure.
    startTimestamp String
    The time when the instance started.
    version String
    Sidecar version that the instance is using.
    capabilities GetSidecarInstanceInstanceListMetadataCapability[]
    Set of capabilities that can be enabled or disabled. Note: This field is per-instance, not per-sidecar, because not all sidecar instances might be in sync at some point in time.
    dynamicVersion boolean
    If true, indicates that the instance has dynamic versioning, that means that the version is not fixed at template level and it can be automatically upgraded.
    lastRegistration string
    The last time the instance reported to the Control Plane.
    recycling boolean
    Indicates whether the Control Plane has asked the instance to mark itself unhealthy so that it is recycled by the infrastructure.
    startTimestamp string
    The time when the instance started.
    version string
    Sidecar version that the instance is using.
    capabilities Sequence[GetSidecarInstanceInstanceListMetadataCapability]
    Set of capabilities that can be enabled or disabled. Note: This field is per-instance, not per-sidecar, because not all sidecar instances might be in sync at some point in time.
    dynamic_version bool
    If true, indicates that the instance has dynamic versioning, that means that the version is not fixed at template level and it can be automatically upgraded.
    last_registration str
    The last time the instance reported to the Control Plane.
    recycling bool
    Indicates whether the Control Plane has asked the instance to mark itself unhealthy so that it is recycled by the infrastructure.
    start_timestamp str
    The time when the instance started.
    version str
    Sidecar version that the instance is using.
    capabilities List<Property Map>
    Set of capabilities that can be enabled or disabled. Note: This field is per-instance, not per-sidecar, because not all sidecar instances might be in sync at some point in time.
    dynamicVersion Boolean
    If true, indicates that the instance has dynamic versioning, that means that the version is not fixed at template level and it can be automatically upgraded.
    lastRegistration String
    The last time the instance reported to the Control Plane.
    recycling Boolean
    Indicates whether the Control Plane has asked the instance to mark itself unhealthy so that it is recycled by the infrastructure.
    startTimestamp String
    The time when the instance started.
    version String
    Sidecar version that the instance is using.

    GetSidecarInstanceInstanceListMetadataCapability

    Recyclable bool
    Indicates if sidecar instance will be recycled (e.g., by an ASG) if it reports itself as unhealthy.
    Recyclable bool
    Indicates if sidecar instance will be recycled (e.g., by an ASG) if it reports itself as unhealthy.
    recyclable Boolean
    Indicates if sidecar instance will be recycled (e.g., by an ASG) if it reports itself as unhealthy.
    recyclable boolean
    Indicates if sidecar instance will be recycled (e.g., by an ASG) if it reports itself as unhealthy.
    recyclable bool
    Indicates if sidecar instance will be recycled (e.g., by an ASG) if it reports itself as unhealthy.
    recyclable Boolean
    Indicates if sidecar instance will be recycled (e.g., by an ASG) if it reports itself as unhealthy.

    GetSidecarInstanceInstanceListMonitoring

    Services Dictionary<string, ImmutableArray<GetSidecarInstanceInstanceListMonitoringServices>>
    Sidecar instance services monitoring information.
    Status string
    Aggregated status of all the sidecar services.
    Services map[string][]GetSidecarInstanceInstanceListMonitoringServices
    Sidecar instance services monitoring information.
    Status string
    Aggregated status of all the sidecar services.
    services Map<String,List<GetSidecarInstanceInstanceListMonitoringServices>>
    Sidecar instance services monitoring information.
    status String
    Aggregated status of all the sidecar services.
    services {[key: string]: GetSidecarInstanceInstanceListMonitoringServices[]}
    Sidecar instance services monitoring information.
    status string
    Aggregated status of all the sidecar services.
    services Mapping[str, Sequence[GetSidecarInstanceInstanceListMonitoringServices]]
    Sidecar instance services monitoring information.
    status str
    Aggregated status of all the sidecar services.
    services Map<List<Property Map>>
    Sidecar instance services monitoring information.
    status String
    Aggregated status of all the sidecar services.

    GetSidecarInstanceInstanceListMonitoringServices

    Components Dictionary<string, ImmutableArray<GetSidecarInstanceInstanceListMonitoringServicesComponents>>
    Map of name to monitoring component. A component is a monitored check on the service that has its own status.
    Host string
    Service host on the deployment.
    MetricsPort double
    Metrics port for service monitoring.
    Status string
    Aggregated status of sidecar service.
    Components map[string][]GetSidecarInstanceInstanceListMonitoringServicesComponents
    Map of name to monitoring component. A component is a monitored check on the service that has its own status.
    Host string
    Service host on the deployment.
    MetricsPort float64
    Metrics port for service monitoring.
    Status string
    Aggregated status of sidecar service.
    components Map<String,List<GetSidecarInstanceInstanceListMonitoringServicesComponents>>
    Map of name to monitoring component. A component is a monitored check on the service that has its own status.
    host String
    Service host on the deployment.
    metricsPort Double
    Metrics port for service monitoring.
    status String
    Aggregated status of sidecar service.
    components {[key: string]: GetSidecarInstanceInstanceListMonitoringServicesComponents[]}
    Map of name to monitoring component. A component is a monitored check on the service that has its own status.
    host string
    Service host on the deployment.
    metricsPort number
    Metrics port for service monitoring.
    status string
    Aggregated status of sidecar service.
    components Mapping[str, Sequence[GetSidecarInstanceInstanceListMonitoringServicesComponents]]
    Map of name to monitoring component. A component is a monitored check on the service that has its own status.
    host str
    Service host on the deployment.
    metrics_port float
    Metrics port for service monitoring.
    status str
    Aggregated status of sidecar service.
    components Map<List<Property Map>>
    Map of name to monitoring component. A component is a monitored check on the service that has its own status.
    host String
    Service host on the deployment.
    metricsPort Number
    Metrics port for service monitoring.
    status String
    Aggregated status of sidecar service.

    GetSidecarInstanceInstanceListMonitoringServicesComponents

    Description string
    Describes what the type of check the component represents.
    Error string
    Error that describes what caused the current status.
    Status string
    Component status.
    Description string
    Describes what the type of check the component represents.
    Error string
    Error that describes what caused the current status.
    Status string
    Component status.
    description String
    Describes what the type of check the component represents.
    error String
    Error that describes what caused the current status.
    status String
    Component status.
    description string
    Describes what the type of check the component represents.
    error string
    Error that describes what caused the current status.
    status string
    Component status.
    description str
    Describes what the type of check the component represents.
    error str
    Error that describes what caused the current status.
    status str
    Component status.
    description String
    Describes what the type of check the component represents.
    error String
    Error that describes what caused the current status.
    status String
    Component 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