Docs
Packagesgcp.monitoring.GenericService
Explore with Pulumi AI
A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern (Wikipedia). In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible
To get more information about GenericService, see:
Example Usage
Monitoring Service Example
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var myService = new Gcp.Monitoring.GenericService("myService", new()
{
BasicService = new Gcp.Monitoring.Inputs.GenericServiceBasicServiceArgs
{
ServiceLabels =
{
{ "moduleId", "another-module-id" },
},
ServiceType = "APP_ENGINE",
},
DisplayName = "My Service my-service",
ServiceId = "my-service",
UserLabels =
{
{ "my_key", "my_value" },
{ "my_other_key", "my_other_value" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/monitoring"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := monitoring.NewGenericService(ctx, "myService", &monitoring.GenericServiceArgs{
BasicService: &monitoring.GenericServiceBasicServiceArgs{
ServiceLabels: pulumi.StringMap{
"moduleId": pulumi.String("another-module-id"),
},
ServiceType: pulumi.String("APP_ENGINE"),
},
DisplayName: pulumi.String("My Service my-service"),
ServiceId: pulumi.String("my-service"),
UserLabels: pulumi.StringMap{
"my_key": pulumi.String("my_value"),
"my_other_key": pulumi.String("my_other_value"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.monitoring.GenericService;
import com.pulumi.gcp.monitoring.GenericServiceArgs;
import com.pulumi.gcp.monitoring.inputs.GenericServiceBasicServiceArgs;
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) {
var myService = new GenericService("myService", GenericServiceArgs.builder()
.basicService(GenericServiceBasicServiceArgs.builder()
.serviceLabels(Map.of("moduleId", "another-module-id"))
.serviceType("APP_ENGINE")
.build())
.displayName("My Service my-service")
.serviceId("my-service")
.userLabels(Map.ofEntries(
Map.entry("my_key", "my_value"),
Map.entry("my_other_key", "my_other_value")
))
.build());
}
}
import pulumi
import pulumi_gcp as gcp
my_service = gcp.monitoring.GenericService("myService",
basic_service=gcp.monitoring.GenericServiceBasicServiceArgs(
service_labels={
"moduleId": "another-module-id",
},
service_type="APP_ENGINE",
),
display_name="My Service my-service",
service_id="my-service",
user_labels={
"my_key": "my_value",
"my_other_key": "my_other_value",
})
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const myService = new gcp.monitoring.GenericService("myService", {
basicService: {
serviceLabels: {
moduleId: "another-module-id",
},
serviceType: "APP_ENGINE",
},
displayName: "My Service my-service",
serviceId: "my-service",
userLabels: {
my_key: "my_value",
my_other_key: "my_other_value",
},
});
resources:
myService:
type: gcp:monitoring:GenericService
properties:
basicService:
serviceLabels:
moduleId: another-module-id
serviceType: APP_ENGINE
displayName: My Service my-service
serviceId: my-service
userLabels:
my_key: my_value
my_other_key: my_other_value
Create GenericService Resource
new GenericService(name: string, args: GenericServiceArgs, opts?: CustomResourceOptions);@overload
def GenericService(resource_name: str,
opts: Optional[ResourceOptions] = None,
basic_service: Optional[GenericServiceBasicServiceArgs] = None,
display_name: Optional[str] = None,
project: Optional[str] = None,
service_id: Optional[str] = None,
user_labels: Optional[Mapping[str, str]] = None)
@overload
def GenericService(resource_name: str,
args: GenericServiceArgs,
opts: Optional[ResourceOptions] = None)func NewGenericService(ctx *Context, name string, args GenericServiceArgs, opts ...ResourceOption) (*GenericService, error)public GenericService(string name, GenericServiceArgs args, CustomResourceOptions? opts = null)
public GenericService(String name, GenericServiceArgs args)
public GenericService(String name, GenericServiceArgs args, CustomResourceOptions options)
type: gcp:monitoring:GenericService
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GenericServiceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GenericServiceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GenericServiceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GenericServiceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GenericServiceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
GenericService Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The GenericService resource accepts the following input properties:
- Service
Id string An optional service ID to use. If not given, the server will generate a service ID.
- Basic
Service GenericService Basic Service A well-known service type, defined by its service type and service labels. Valid values of service types and services labels are described at https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli Structure is documented below.
- Display
Name string Name used for UI elements listing this Service.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- User
Labels Dictionary<string, string> Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.
- Service
Id string An optional service ID to use. If not given, the server will generate a service ID.
- Basic
Service GenericService Basic Service Args A well-known service type, defined by its service type and service labels. Valid values of service types and services labels are described at https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli Structure is documented below.
- Display
Name string Name used for UI elements listing this Service.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- User
Labels map[string]string Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.
- service
Id String An optional service ID to use. If not given, the server will generate a service ID.
- basic
Service GenericService Basic Service A well-known service type, defined by its service type and service labels. Valid values of service types and services labels are described at https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli Structure is documented below.
- display
Name String Name used for UI elements listing this Service.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- user
Labels Map<String,String> Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.
- service
Id string An optional service ID to use. If not given, the server will generate a service ID.
- basic
Service GenericService Basic Service A well-known service type, defined by its service type and service labels. Valid values of service types and services labels are described at https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli Structure is documented below.
- display
Name string Name used for UI elements listing this Service.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- user
Labels {[key: string]: string} Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.
- service_
id str An optional service ID to use. If not given, the server will generate a service ID.
- basic_
service GenericService Basic Service Args A well-known service type, defined by its service type and service labels. Valid values of service types and services labels are described at https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli Structure is documented below.
- display_
name str Name used for UI elements listing this Service.
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- user_
labels Mapping[str, str] Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.
- service
Id String An optional service ID to use. If not given, the server will generate a service ID.
- basic
Service Property Map A well-known service type, defined by its service type and service labels. Valid values of service types and services labels are described at https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli Structure is documented below.
- display
Name String Name used for UI elements listing this Service.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- user
Labels Map<String> Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.
Outputs
All input properties are implicitly available as output properties. Additionally, the GenericService resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Name string
The full resource name for this service. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
- Telemetries
List<Generic
Service Telemetry> Configuration for how to query telemetry on a Service. Structure is documented below.
- Id string
The provider-assigned unique ID for this managed resource.
- Name string
The full resource name for this service. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
- Telemetries
[]Generic
Service Telemetry Configuration for how to query telemetry on a Service. Structure is documented below.
- id String
The provider-assigned unique ID for this managed resource.
- name String
The full resource name for this service. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
- telemetries
List<Generic
Service Telemetry> Configuration for how to query telemetry on a Service. Structure is documented below.
- id string
The provider-assigned unique ID for this managed resource.
- name string
The full resource name for this service. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
- telemetries
Generic
Service Telemetry[] Configuration for how to query telemetry on a Service. Structure is documented below.
- id str
The provider-assigned unique ID for this managed resource.
- name str
The full resource name for this service. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
- telemetries
Sequence[Generic
Service Telemetry] Configuration for how to query telemetry on a Service. Structure is documented below.
- id String
The provider-assigned unique ID for this managed resource.
- name String
The full resource name for this service. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
- telemetries List<Property Map>
Configuration for how to query telemetry on a Service. Structure is documented below.
Look up Existing GenericService Resource
Get an existing GenericService resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: GenericServiceState, opts?: CustomResourceOptions): GenericService@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
basic_service: Optional[GenericServiceBasicServiceArgs] = None,
display_name: Optional[str] = None,
name: Optional[str] = None,
project: Optional[str] = None,
service_id: Optional[str] = None,
telemetries: Optional[Sequence[GenericServiceTelemetryArgs]] = None,
user_labels: Optional[Mapping[str, str]] = None) -> GenericServicefunc GetGenericService(ctx *Context, name string, id IDInput, state *GenericServiceState, opts ...ResourceOption) (*GenericService, error)public static GenericService Get(string name, Input<string> id, GenericServiceState? state, CustomResourceOptions? opts = null)public static GenericService get(String name, Output<String> id, GenericServiceState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Basic
Service GenericService Basic Service A well-known service type, defined by its service type and service labels. Valid values of service types and services labels are described at https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli Structure is documented below.
- Display
Name string Name used for UI elements listing this Service.
- Name string
The full resource name for this service. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Service
Id string An optional service ID to use. If not given, the server will generate a service ID.
- Telemetries
List<Generic
Service Telemetry> Configuration for how to query telemetry on a Service. Structure is documented below.
- User
Labels Dictionary<string, string> Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.
- Basic
Service GenericService Basic Service Args A well-known service type, defined by its service type and service labels. Valid values of service types and services labels are described at https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli Structure is documented below.
- Display
Name string Name used for UI elements listing this Service.
- Name string
The full resource name for this service. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Service
Id string An optional service ID to use. If not given, the server will generate a service ID.
- Telemetries
[]Generic
Service Telemetry Args Configuration for how to query telemetry on a Service. Structure is documented below.
- User
Labels map[string]string Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.
- basic
Service GenericService Basic Service A well-known service type, defined by its service type and service labels. Valid values of service types and services labels are described at https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli Structure is documented below.
- display
Name String Name used for UI elements listing this Service.
- name String
The full resource name for this service. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- service
Id String An optional service ID to use. If not given, the server will generate a service ID.
- telemetries
List<Generic
Service Telemetry> Configuration for how to query telemetry on a Service. Structure is documented below.
- user
Labels Map<String,String> Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.
- basic
Service GenericService Basic Service A well-known service type, defined by its service type and service labels. Valid values of service types and services labels are described at https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli Structure is documented below.
- display
Name string Name used for UI elements listing this Service.
- name string
The full resource name for this service. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- service
Id string An optional service ID to use. If not given, the server will generate a service ID.
- telemetries
Generic
Service Telemetry[] Configuration for how to query telemetry on a Service. Structure is documented below.
- user
Labels {[key: string]: string} Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.
- basic_
service GenericService Basic Service Args A well-known service type, defined by its service type and service labels. Valid values of service types and services labels are described at https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli Structure is documented below.
- display_
name str Name used for UI elements listing this Service.
- name str
The full resource name for this service. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- service_
id str An optional service ID to use. If not given, the server will generate a service ID.
- telemetries
Sequence[Generic
Service Telemetry Args] Configuration for how to query telemetry on a Service. Structure is documented below.
- user_
labels Mapping[str, str] Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.
- basic
Service Property Map A well-known service type, defined by its service type and service labels. Valid values of service types and services labels are described at https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli Structure is documented below.
- display
Name String Name used for UI elements listing this Service.
- name String
The full resource name for this service. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- service
Id String An optional service ID to use. If not given, the server will generate a service ID.
- telemetries List<Property Map>
Configuration for how to query telemetry on a Service. Structure is documented below.
- user
Labels Map<String> Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.
Supporting Types
GenericServiceBasicService, GenericServiceBasicServiceArgs
- Service
Labels Dictionary<string, string> Labels that specify the resource that emits the monitoring data which is used for SLO reporting of this
Service.- Service
Type string The type of service that this basic service defines, e.g. APP_ENGINE service type
- Service
Labels map[string]string Labels that specify the resource that emits the monitoring data which is used for SLO reporting of this
Service.- Service
Type string The type of service that this basic service defines, e.g. APP_ENGINE service type
- service
Labels Map<String,String> Labels that specify the resource that emits the monitoring data which is used for SLO reporting of this
Service.- service
Type String The type of service that this basic service defines, e.g. APP_ENGINE service type
- service
Labels {[key: string]: string} Labels that specify the resource that emits the monitoring data which is used for SLO reporting of this
Service.- service
Type string The type of service that this basic service defines, e.g. APP_ENGINE service type
- service_
labels Mapping[str, str] Labels that specify the resource that emits the monitoring data which is used for SLO reporting of this
Service.- service_
type str The type of service that this basic service defines, e.g. APP_ENGINE service type
- service
Labels Map<String> Labels that specify the resource that emits the monitoring data which is used for SLO reporting of this
Service.- service
Type String The type of service that this basic service defines, e.g. APP_ENGINE service type
GenericServiceTelemetry, GenericServiceTelemetryArgs
- Resource
Name 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 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 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 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.
- resource
Name String The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names.
Import
GenericService can be imported using any of these accepted formats
$ pulumi import gcp:monitoring/genericService:GenericService default projects/{{project}}/services/{{service_id}}
$ pulumi import gcp:monitoring/genericService:GenericService default {{project}}/{{service_id}}
$ pulumi import gcp:monitoring/genericService:GenericService default {{service_id}}
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
google-betaTerraform Provider.