1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. monitoring
  5. getClusterIstioService
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

gcp.monitoring.getClusterIstioService

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

    A Monitoring Service is the root resource under which operational aspects of a generic service are accessible. A service is some discrete, autonomous, and network-accessible unit, designed to solve an individual concern

    An Cluster Istio monitoring service is automatically created by GCP to monitor Cluster Istio services.

    To get more information about Service, see:

    Example Usage

    Monitoring Cluster Istio Service

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    // Monitors the default ClusterIstio service
    const default = gcp.monitoring.getClusterIstioService({
        location: "us-west2-a",
        clusterName: "west",
        serviceNamespace: "istio-system",
        serviceName: "istio-policy",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    # Monitors the default ClusterIstio service
    default = gcp.monitoring.get_cluster_istio_service(location="us-west2-a",
        cluster_name="west",
        service_namespace="istio-system",
        service_name="istio-policy")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/monitoring"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Monitors the default ClusterIstio service
    		_, err := monitoring.GetClusterIstioService(ctx, &monitoring.GetClusterIstioServiceArgs{
    			Location:         "us-west2-a",
    			ClusterName:      "west",
    			ServiceNamespace: "istio-system",
    			ServiceName:      "istio-policy",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        // Monitors the default ClusterIstio service
        var @default = Gcp.Monitoring.GetClusterIstioService.Invoke(new()
        {
            Location = "us-west2-a",
            ClusterName = "west",
            ServiceNamespace = "istio-system",
            ServiceName = "istio-policy",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.monitoring.MonitoringFunctions;
    import com.pulumi.gcp.monitoring.inputs.GetClusterIstioServiceArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            // Monitors the default ClusterIstio service
            final var default = MonitoringFunctions.getClusterIstioService(GetClusterIstioServiceArgs.builder()
                .location("us-west2-a")
                .clusterName("west")
                .serviceNamespace("istio-system")
                .serviceName("istio-policy")
                .build());
    
        }
    }
    
    variables:
      # Monitors the default ClusterIstio service
      default:
        fn::invoke:
          Function: gcp:monitoring:getClusterIstioService
          Arguments:
            location: us-west2-a
            clusterName: west
            serviceNamespace: istio-system
            serviceName: istio-policy
    

    Using getClusterIstioService

    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 getClusterIstioService(args: GetClusterIstioServiceArgs, opts?: InvokeOptions): Promise<GetClusterIstioServiceResult>
    function getClusterIstioServiceOutput(args: GetClusterIstioServiceOutputArgs, opts?: InvokeOptions): Output<GetClusterIstioServiceResult>
    def get_cluster_istio_service(cluster_name: Optional[str] = None,
                                  location: Optional[str] = None,
                                  project: Optional[str] = None,
                                  service_name: Optional[str] = None,
                                  service_namespace: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetClusterIstioServiceResult
    def get_cluster_istio_service_output(cluster_name: Optional[pulumi.Input[str]] = None,
                                  location: Optional[pulumi.Input[str]] = None,
                                  project: Optional[pulumi.Input[str]] = None,
                                  service_name: Optional[pulumi.Input[str]] = None,
                                  service_namespace: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetClusterIstioServiceResult]
    func GetClusterIstioService(ctx *Context, args *GetClusterIstioServiceArgs, opts ...InvokeOption) (*GetClusterIstioServiceResult, error)
    func GetClusterIstioServiceOutput(ctx *Context, args *GetClusterIstioServiceOutputArgs, opts ...InvokeOption) GetClusterIstioServiceResultOutput

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

    public static class GetClusterIstioService 
    {
        public static Task<GetClusterIstioServiceResult> InvokeAsync(GetClusterIstioServiceArgs args, InvokeOptions? opts = null)
        public static Output<GetClusterIstioServiceResult> Invoke(GetClusterIstioServiceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetClusterIstioServiceResult> getClusterIstioService(GetClusterIstioServiceArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: gcp:monitoring/getClusterIstioService:getClusterIstioService
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClusterName string
    The name of the Kubernetes cluster in which this Istio service is defined. Corresponds to the clusterName resource label in k8s_cluster resources.
    Location string
    The location of the Kubernetes cluster in which this Istio service is defined. Corresponds to the location resource label in k8s_cluster resources.
    ServiceName string

    The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics.


    Other optional fields include:

    ServiceNamespace string
    The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ClusterName string
    The name of the Kubernetes cluster in which this Istio service is defined. Corresponds to the clusterName resource label in k8s_cluster resources.
    Location string
    The location of the Kubernetes cluster in which this Istio service is defined. Corresponds to the location resource label in k8s_cluster resources.
    ServiceName string

    The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics.


    Other optional fields include:

    ServiceNamespace string
    The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    clusterName String
    The name of the Kubernetes cluster in which this Istio service is defined. Corresponds to the clusterName resource label in k8s_cluster resources.
    location String
    The location of the Kubernetes cluster in which this Istio service is defined. Corresponds to the location resource label in k8s_cluster resources.
    serviceName String

    The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics.


    Other optional fields include:

    serviceNamespace String
    The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    clusterName string
    The name of the Kubernetes cluster in which this Istio service is defined. Corresponds to the clusterName resource label in k8s_cluster resources.
    location string
    The location of the Kubernetes cluster in which this Istio service is defined. Corresponds to the location resource label in k8s_cluster resources.
    serviceName string

    The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics.


    Other optional fields include:

    serviceNamespace string
    The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    cluster_name str
    The name of the Kubernetes cluster in which this Istio service is defined. Corresponds to the clusterName resource label in k8s_cluster resources.
    location str
    The location of the Kubernetes cluster in which this Istio service is defined. Corresponds to the location resource label in k8s_cluster resources.
    service_name str

    The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics.


    Other optional fields include:

    service_namespace str
    The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    clusterName String
    The name of the Kubernetes cluster in which this Istio service is defined. Corresponds to the clusterName resource label in k8s_cluster resources.
    location String
    The location of the Kubernetes cluster in which this Istio service is defined. Corresponds to the location resource label in k8s_cluster resources.
    serviceName String

    The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics.


    Other optional fields include:

    serviceNamespace String
    The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    getClusterIstioService Result

    The following output properties are available:

    ClusterName string
    DisplayName string
    Name used for UI elements listing this (Monitoring) Service.
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    Name string
    The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
    ServiceId string
    ServiceName string
    ServiceNamespace string
    Telemetries List<GetClusterIstioServiceTelemetry>
    Configuration for how to query telemetry on the Service. Structure is documented below.
    UserLabels Dictionary<string, string>
    Project string
    ClusterName string
    DisplayName string
    Name used for UI elements listing this (Monitoring) Service.
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    Name string
    The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
    ServiceId string
    ServiceName string
    ServiceNamespace string
    Telemetries []GetClusterIstioServiceTelemetry
    Configuration for how to query telemetry on the Service. Structure is documented below.
    UserLabels map[string]string
    Project string
    clusterName String
    displayName String
    Name used for UI elements listing this (Monitoring) Service.
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    name String
    The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
    serviceId String
    serviceName String
    serviceNamespace String
    telemetries List<GetClusterIstioServiceTelemetry>
    Configuration for how to query telemetry on the Service. Structure is documented below.
    userLabels Map<String,String>
    project String
    clusterName string
    displayName string
    Name used for UI elements listing this (Monitoring) Service.
    id string
    The provider-assigned unique ID for this managed resource.
    location string
    name string
    The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
    serviceId string
    serviceName string
    serviceNamespace string
    telemetries GetClusterIstioServiceTelemetry[]
    Configuration for how to query telemetry on the Service. Structure is documented below.
    userLabels {[key: string]: string}
    project string
    cluster_name str
    display_name str
    Name used for UI elements listing this (Monitoring) Service.
    id str
    The provider-assigned unique ID for this managed resource.
    location str
    name str
    The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
    service_id str
    service_name str
    service_namespace str
    telemetries Sequence[GetClusterIstioServiceTelemetry]
    Configuration for how to query telemetry on the Service. Structure is documented below.
    user_labels Mapping[str, str]
    project str
    clusterName String
    displayName String
    Name used for UI elements listing this (Monitoring) Service.
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    name String
    The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
    serviceId String
    serviceName String
    serviceNamespace String
    telemetries List<Property Map>
    Configuration for how to query telemetry on the Service. Structure is documented below.
    userLabels Map<String>
    project String

    Supporting Types

    GetClusterIstioServiceTelemetry

    ResourceName string
    The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names.
    ResourceName string
    The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names.
    resourceName String
    The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names.
    resourceName string
    The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names.
    resource_name str
    The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names.
    resourceName String
    The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi