Splunk Observability Cloud GCP Integration.
NOTE When managing integrations, use a session token of an administrator to authenticate the Splunk Observability Cloud provider. See Operations that require a session token for an administrator. Otherwise you’ll receive a 4xx error.
Example
import * as pulumi from "@pulumi/pulumi";
import * as signalfx from "@pulumi/signalfx";
import * as std from "@pulumi/std";
const gcpMyteam = new signalfx.gcp.Integration("gcp_myteam", {
name: "GCP - My Team",
enabled: true,
pollRate: 300,
services: ["compute"],
customMetricTypeDomains: ["istio.io"],
importGcpMetrics: true,
projectServiceKeys: [
{
projectId: "gcp_project_id_1",
projectKey: std.index.file({
input: "/path/to/gcp_credentials_1.json",
}).result,
},
{
projectId: "gcp_project_id_2",
projectKey: std.index.file({
input: "/path/to/gcp_credentials_2.json",
}).result,
},
],
});
import pulumi
import pulumi_signalfx as signalfx
import pulumi_std as std
gcp_myteam = signalfx.gcp.Integration("gcp_myteam",
name="GCP - My Team",
enabled=True,
poll_rate=300,
services=["compute"],
custom_metric_type_domains=["istio.io"],
import_gcp_metrics=True,
project_service_keys=[
{
"project_id": "gcp_project_id_1",
"project_key": std.index.file(input="/path/to/gcp_credentials_1.json")["result"],
},
{
"project_id": "gcp_project_id_2",
"project_key": std.index.file(input="/path/to/gcp_credentials_2.json")["result"],
},
])
package main
import (
"github.com/pulumi/pulumi-signalfx/sdk/v7/go/signalfx/gcp"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
invokeFile, err := std.File(ctx, map[string]interface{}{
"input": "/path/to/gcp_credentials_1.json",
}, nil)
if err != nil {
return err
}
invokeFile1, err := std.File(ctx, map[string]interface{}{
"input": "/path/to/gcp_credentials_2.json",
}, nil)
if err != nil {
return err
}
_, err = gcp.NewIntegration(ctx, "gcp_myteam", &gcp.IntegrationArgs{
Name: pulumi.String("GCP - My Team"),
Enabled: pulumi.Bool(true),
PollRate: pulumi.Int(300),
Services: pulumi.StringArray{
pulumi.String("compute"),
},
CustomMetricTypeDomains: pulumi.StringArray{
pulumi.String("istio.io"),
},
ImportGcpMetrics: pulumi.Bool(true),
ProjectServiceKeys: gcp.IntegrationProjectServiceKeyArray{
&gcp.IntegrationProjectServiceKeyArgs{
ProjectId: pulumi.String("gcp_project_id_1"),
ProjectKey: invokeFile.Result,
},
&gcp.IntegrationProjectServiceKeyArgs{
ProjectId: pulumi.String("gcp_project_id_2"),
ProjectKey: invokeFile1.Result,
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using SignalFx = Pulumi.SignalFx;
using Std = Pulumi.Std;
return await Deployment.RunAsync(() =>
{
var gcpMyteam = new SignalFx.Gcp.Integration("gcp_myteam", new()
{
Name = "GCP - My Team",
Enabled = true,
PollRate = 300,
Services = new[]
{
"compute",
},
CustomMetricTypeDomains = new[]
{
"istio.io",
},
ImportGcpMetrics = true,
ProjectServiceKeys = new[]
{
new SignalFx.Gcp.Inputs.IntegrationProjectServiceKeyArgs
{
ProjectId = "gcp_project_id_1",
ProjectKey = Std.Index.File.Invoke(new()
{
Input = "/path/to/gcp_credentials_1.json",
}).Result,
},
new SignalFx.Gcp.Inputs.IntegrationProjectServiceKeyArgs
{
ProjectId = "gcp_project_id_2",
ProjectKey = Std.Index.File.Invoke(new()
{
Input = "/path/to/gcp_credentials_2.json",
}).Result,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.signalfx.gcp.Integration;
import com.pulumi.signalfx.gcp.IntegrationArgs;
import com.pulumi.signalfx.gcp.inputs.IntegrationProjectServiceKeyArgs;
import com.pulumi.std.StdFunctions;
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 gcpMyteam = new Integration("gcpMyteam", IntegrationArgs.builder()
.name("GCP - My Team")
.enabled(true)
.pollRate(300)
.services("compute")
.customMetricTypeDomains("istio.io")
.importGcpMetrics(true)
.projectServiceKeys(
IntegrationProjectServiceKeyArgs.builder()
.projectId("gcp_project_id_1")
.projectKey(StdFunctions.file(Map.of("input", "/path/to/gcp_credentials_1.json")).result())
.build(),
IntegrationProjectServiceKeyArgs.builder()
.projectId("gcp_project_id_2")
.projectKey(StdFunctions.file(Map.of("input", "/path/to/gcp_credentials_2.json")).result())
.build())
.build());
}
}
resources:
gcpMyteam:
type: signalfx:gcp:Integration
name: gcp_myteam
properties:
name: GCP - My Team
enabled: true
pollRate: 300
services:
- compute
customMetricTypeDomains:
- istio.io
importGcpMetrics: true
projectServiceKeys:
- projectId: gcp_project_id_1
projectKey:
fn::invoke:
function: std:file
arguments:
input: /path/to/gcp_credentials_1.json
return: result
- projectId: gcp_project_id_2
projectKey:
fn::invoke:
function: std:file
arguments:
input: /path/to/gcp_credentials_2.json
return: result
Create Integration Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Integration(name: string, args: IntegrationArgs, opts?: CustomResourceOptions);@overload
def Integration(resource_name: str,
args: IntegrationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Integration(resource_name: str,
opts: Optional[ResourceOptions] = None,
enabled: Optional[bool] = None,
poll_rate: Optional[int] = None,
projects: Optional[IntegrationProjectsArgs] = None,
exclude_gce_instances_with_labels: Optional[Sequence[str]] = None,
import_gcp_metrics: Optional[bool] = None,
include_lists: Optional[Sequence[str]] = None,
name: Optional[str] = None,
custom_metric_type_domains: Optional[Sequence[str]] = None,
project_service_keys: Optional[Sequence[IntegrationProjectServiceKeyArgs]] = None,
named_token: Optional[str] = None,
project_wif_configs: Optional[Sequence[IntegrationProjectWifConfigArgs]] = None,
auth_method: Optional[str] = None,
services: Optional[Sequence[str]] = None,
use_metric_source_project_for_quota: Optional[bool] = None,
wif_splunk_identity: Optional[Mapping[str, str]] = None,
workload_identity_federation_config: Optional[str] = None)func NewIntegration(ctx *Context, name string, args IntegrationArgs, opts ...ResourceOption) (*Integration, error)public Integration(string name, IntegrationArgs args, CustomResourceOptions? opts = null)
public Integration(String name, IntegrationArgs args)
public Integration(String name, IntegrationArgs args, CustomResourceOptions options)
type: signalfx:gcp:Integration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args IntegrationArgs
- 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 IntegrationArgs
- 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 IntegrationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IntegrationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IntegrationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var exampleintegrationResourceResourceFromGcpintegration = new SignalFx.Gcp.Integration("exampleintegrationResourceResourceFromGcpintegration", new()
{
Enabled = false,
PollRate = 0,
Projects = new SignalFx.Gcp.Inputs.IntegrationProjectsArgs
{
SelectedProjectIds = new[]
{
"string",
},
SyncMode = "string",
},
ExcludeGceInstancesWithLabels = new[]
{
"string",
},
ImportGcpMetrics = false,
IncludeLists = new[]
{
"string",
},
Name = "string",
CustomMetricTypeDomains = new[]
{
"string",
},
ProjectServiceKeys = new[]
{
new SignalFx.Gcp.Inputs.IntegrationProjectServiceKeyArgs
{
ProjectId = "string",
ProjectKey = "string",
},
},
NamedToken = "string",
AuthMethod = "string",
Services = new[]
{
"string",
},
UseMetricSourceProjectForQuota = false,
WifSplunkIdentity =
{
{ "string", "string" },
},
WorkloadIdentityFederationConfig = "string",
});
example, err := gcp.NewIntegration(ctx, "exampleintegrationResourceResourceFromGcpintegration", &gcp.IntegrationArgs{
Enabled: pulumi.Bool(false),
PollRate: pulumi.Int(0),
Projects: &gcp.IntegrationProjectsArgs{
SelectedProjectIds: pulumi.StringArray{
pulumi.String("string"),
},
SyncMode: pulumi.String("string"),
},
ExcludeGceInstancesWithLabels: pulumi.StringArray{
pulumi.String("string"),
},
ImportGcpMetrics: pulumi.Bool(false),
IncludeLists: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
CustomMetricTypeDomains: pulumi.StringArray{
pulumi.String("string"),
},
ProjectServiceKeys: gcp.IntegrationProjectServiceKeyArray{
&gcp.IntegrationProjectServiceKeyArgs{
ProjectId: pulumi.String("string"),
ProjectKey: pulumi.String("string"),
},
},
NamedToken: pulumi.String("string"),
AuthMethod: pulumi.String("string"),
Services: pulumi.StringArray{
pulumi.String("string"),
},
UseMetricSourceProjectForQuota: pulumi.Bool(false),
WifSplunkIdentity: pulumi.StringMap{
"string": pulumi.String("string"),
},
WorkloadIdentityFederationConfig: pulumi.String("string"),
})
var exampleintegrationResourceResourceFromGcpintegration = new com.pulumi.signalfx.gcp.Integration("exampleintegrationResourceResourceFromGcpintegration", com.pulumi.signalfx.gcp.IntegrationArgs.builder()
.enabled(false)
.pollRate(0)
.projects(IntegrationProjectsArgs.builder()
.selectedProjectIds("string")
.syncMode("string")
.build())
.excludeGceInstancesWithLabels("string")
.importGcpMetrics(false)
.includeLists("string")
.name("string")
.customMetricTypeDomains("string")
.projectServiceKeys(IntegrationProjectServiceKeyArgs.builder()
.projectId("string")
.projectKey("string")
.build())
.namedToken("string")
.authMethod("string")
.services("string")
.useMetricSourceProjectForQuota(false)
.wifSplunkIdentity(Map.of("string", "string"))
.workloadIdentityFederationConfig("string")
.build());
exampleintegration_resource_resource_from_gcpintegration = signalfx.gcp.Integration("exampleintegrationResourceResourceFromGcpintegration",
enabled=False,
poll_rate=0,
projects={
"selected_project_ids": ["string"],
"sync_mode": "string",
},
exclude_gce_instances_with_labels=["string"],
import_gcp_metrics=False,
include_lists=["string"],
name="string",
custom_metric_type_domains=["string"],
project_service_keys=[{
"project_id": "string",
"project_key": "string",
}],
named_token="string",
auth_method="string",
services=["string"],
use_metric_source_project_for_quota=False,
wif_splunk_identity={
"string": "string",
},
workload_identity_federation_config="string")
const exampleintegrationResourceResourceFromGcpintegration = new signalfx.gcp.Integration("exampleintegrationResourceResourceFromGcpintegration", {
enabled: false,
pollRate: 0,
projects: {
selectedProjectIds: ["string"],
syncMode: "string",
},
excludeGceInstancesWithLabels: ["string"],
importGcpMetrics: false,
includeLists: ["string"],
name: "string",
customMetricTypeDomains: ["string"],
projectServiceKeys: [{
projectId: "string",
projectKey: "string",
}],
namedToken: "string",
authMethod: "string",
services: ["string"],
useMetricSourceProjectForQuota: false,
wifSplunkIdentity: {
string: "string",
},
workloadIdentityFederationConfig: "string",
});
type: signalfx:gcp:Integration
properties:
authMethod: string
customMetricTypeDomains:
- string
enabled: false
excludeGceInstancesWithLabels:
- string
importGcpMetrics: false
includeLists:
- string
name: string
namedToken: string
pollRate: 0
projectServiceKeys:
- projectId: string
projectKey: string
projects:
selectedProjectIds:
- string
syncMode: string
services:
- string
useMetricSourceProjectForQuota: false
wifSplunkIdentity:
string: string
workloadIdentityFederationConfig: string
Integration Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Integration resource accepts the following input properties:
- Enabled bool
- Whether the integration is enabled.
- Auth
Method string - Authentication method to use in this integration. If empty, Splunk Observability backend defaults to SERVICE_ACCOUNT_KEY
- Custom
Metric List<string>Type Domains - List of additional GCP service domain names that Splunk Observability Cloud will monitor. See Custom Metric Type Domains documentation
- Exclude
Gce List<string>Instances With Labels - List of label keys. GCP Compute Engine instances with any of these labels applied are excluded from metric sync. Requires the
compute.instances.listpermission on the project’s service account. - Import
Gcp boolMetrics - If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
- Include
Lists List<string> - Compute Metadata Include List.
- Name string
- Name of the integration.
- Named
Token string - Name of the org token to be used for data ingestion. If not specified then default access token is used.
- Poll
Rate int - GCP integration poll rate (in seconds). Value between
60and600. Default:300. - Project
Service List<Pulumi.Keys Signal Fx. Gcp. Inputs. Integration Project Service Key> - GCP projects to add.
- Project
Wif List<Pulumi.Configs Signal Fx. Gcp. Inputs. Integration Project Wif Config> - Please use
workload_identity_federation_configwithprojectsinstead. - Projects
Pulumi.
Signal Fx. Gcp. Inputs. Integration Projects - Object comprised of
sync_modeand optionalselected_project_ids. If you usesync_modeALL_REACHABLEthen Splunk Observability Cloud will automatically discover GCP projects that the provided WIF principal has permissions to query. Ifsync_modeisSELECTED, you need to provide a list of project ids in theselected_project_idsfield. - Services List<string>
- GCP service metrics to import. Can be an empty list, or not included, to import 'All services'. See Google Cloud Platform services for a list of valid values.
- Use
Metric boolSource Project For Quota - When this value is set to true Observability Cloud will force usage of a quota from the project where metrics are stored. For this to work the service account provided for the project needs to be provided with serviceusage.services.use permission or Service Usage Consumer role in this project. When set to false default quota settings are used.
- Wif
Splunk Dictionary<string, string>Identity - The Splunk Observability GCP identity to include in GCP WIF provider definition.
- Workload
Identity stringFederation Config - Your Workload Identity Federation config. To easily set up WIF you can use helpers provided in the gcp_workload_identity_federation repository.
- Enabled bool
- Whether the integration is enabled.
- Auth
Method string - Authentication method to use in this integration. If empty, Splunk Observability backend defaults to SERVICE_ACCOUNT_KEY
- Custom
Metric []stringType Domains - List of additional GCP service domain names that Splunk Observability Cloud will monitor. See Custom Metric Type Domains documentation
- Exclude
Gce []stringInstances With Labels - List of label keys. GCP Compute Engine instances with any of these labels applied are excluded from metric sync. Requires the
compute.instances.listpermission on the project’s service account. - Import
Gcp boolMetrics - If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
- Include
Lists []string - Compute Metadata Include List.
- Name string
- Name of the integration.
- Named
Token string - Name of the org token to be used for data ingestion. If not specified then default access token is used.
- Poll
Rate int - GCP integration poll rate (in seconds). Value between
60and600. Default:300. - Project
Service []IntegrationKeys Project Service Key Args - GCP projects to add.
- Project
Wif []IntegrationConfigs Project Wif Config Args - Please use
workload_identity_federation_configwithprojectsinstead. - Projects
Integration
Projects Args - Object comprised of
sync_modeand optionalselected_project_ids. If you usesync_modeALL_REACHABLEthen Splunk Observability Cloud will automatically discover GCP projects that the provided WIF principal has permissions to query. Ifsync_modeisSELECTED, you need to provide a list of project ids in theselected_project_idsfield. - Services []string
- GCP service metrics to import. Can be an empty list, or not included, to import 'All services'. See Google Cloud Platform services for a list of valid values.
- Use
Metric boolSource Project For Quota - When this value is set to true Observability Cloud will force usage of a quota from the project where metrics are stored. For this to work the service account provided for the project needs to be provided with serviceusage.services.use permission or Service Usage Consumer role in this project. When set to false default quota settings are used.
- Wif
Splunk map[string]stringIdentity - The Splunk Observability GCP identity to include in GCP WIF provider definition.
- Workload
Identity stringFederation Config - Your Workload Identity Federation config. To easily set up WIF you can use helpers provided in the gcp_workload_identity_federation repository.
- enabled Boolean
- Whether the integration is enabled.
- auth
Method String - Authentication method to use in this integration. If empty, Splunk Observability backend defaults to SERVICE_ACCOUNT_KEY
- custom
Metric List<String>Type Domains - List of additional GCP service domain names that Splunk Observability Cloud will monitor. See Custom Metric Type Domains documentation
- exclude
Gce List<String>Instances With Labels - List of label keys. GCP Compute Engine instances with any of these labels applied are excluded from metric sync. Requires the
compute.instances.listpermission on the project’s service account. - import
Gcp BooleanMetrics - If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
- include
Lists List<String> - Compute Metadata Include List.
- name String
- Name of the integration.
- named
Token String - Name of the org token to be used for data ingestion. If not specified then default access token is used.
- poll
Rate Integer - GCP integration poll rate (in seconds). Value between
60and600. Default:300. - project
Service List<IntegrationKeys Project Service Key> - GCP projects to add.
- project
Wif List<IntegrationConfigs Project Wif Config> - Please use
workload_identity_federation_configwithprojectsinstead. - projects
Integration
Projects - Object comprised of
sync_modeand optionalselected_project_ids. If you usesync_modeALL_REACHABLEthen Splunk Observability Cloud will automatically discover GCP projects that the provided WIF principal has permissions to query. Ifsync_modeisSELECTED, you need to provide a list of project ids in theselected_project_idsfield. - services List<String>
- GCP service metrics to import. Can be an empty list, or not included, to import 'All services'. See Google Cloud Platform services for a list of valid values.
- use
Metric BooleanSource Project For Quota - When this value is set to true Observability Cloud will force usage of a quota from the project where metrics are stored. For this to work the service account provided for the project needs to be provided with serviceusage.services.use permission or Service Usage Consumer role in this project. When set to false default quota settings are used.
- wif
Splunk Map<String,String>Identity - The Splunk Observability GCP identity to include in GCP WIF provider definition.
- workload
Identity StringFederation Config - Your Workload Identity Federation config. To easily set up WIF you can use helpers provided in the gcp_workload_identity_federation repository.
- enabled boolean
- Whether the integration is enabled.
- auth
Method string - Authentication method to use in this integration. If empty, Splunk Observability backend defaults to SERVICE_ACCOUNT_KEY
- custom
Metric string[]Type Domains - List of additional GCP service domain names that Splunk Observability Cloud will monitor. See Custom Metric Type Domains documentation
- exclude
Gce string[]Instances With Labels - List of label keys. GCP Compute Engine instances with any of these labels applied are excluded from metric sync. Requires the
compute.instances.listpermission on the project’s service account. - import
Gcp booleanMetrics - If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
- include
Lists string[] - Compute Metadata Include List.
- name string
- Name of the integration.
- named
Token string - Name of the org token to be used for data ingestion. If not specified then default access token is used.
- poll
Rate number - GCP integration poll rate (in seconds). Value between
60and600. Default:300. - project
Service IntegrationKeys Project Service Key[] - GCP projects to add.
- project
Wif IntegrationConfigs Project Wif Config[] - Please use
workload_identity_federation_configwithprojectsinstead. - projects
Integration
Projects - Object comprised of
sync_modeand optionalselected_project_ids. If you usesync_modeALL_REACHABLEthen Splunk Observability Cloud will automatically discover GCP projects that the provided WIF principal has permissions to query. Ifsync_modeisSELECTED, you need to provide a list of project ids in theselected_project_idsfield. - services string[]
- GCP service metrics to import. Can be an empty list, or not included, to import 'All services'. See Google Cloud Platform services for a list of valid values.
- use
Metric booleanSource Project For Quota - When this value is set to true Observability Cloud will force usage of a quota from the project where metrics are stored. For this to work the service account provided for the project needs to be provided with serviceusage.services.use permission or Service Usage Consumer role in this project. When set to false default quota settings are used.
- wif
Splunk {[key: string]: string}Identity - The Splunk Observability GCP identity to include in GCP WIF provider definition.
- workload
Identity stringFederation Config - Your Workload Identity Federation config. To easily set up WIF you can use helpers provided in the gcp_workload_identity_federation repository.
- enabled bool
- Whether the integration is enabled.
- auth_
method str - Authentication method to use in this integration. If empty, Splunk Observability backend defaults to SERVICE_ACCOUNT_KEY
- custom_
metric_ Sequence[str]type_ domains - List of additional GCP service domain names that Splunk Observability Cloud will monitor. See Custom Metric Type Domains documentation
- exclude_
gce_ Sequence[str]instances_ with_ labels - List of label keys. GCP Compute Engine instances with any of these labels applied are excluded from metric sync. Requires the
compute.instances.listpermission on the project’s service account. - import_
gcp_ boolmetrics - If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
- include_
lists Sequence[str] - Compute Metadata Include List.
- name str
- Name of the integration.
- named_
token str - Name of the org token to be used for data ingestion. If not specified then default access token is used.
- poll_
rate int - GCP integration poll rate (in seconds). Value between
60and600. Default:300. - project_
service_ Sequence[Integrationkeys Project Service Key Args] - GCP projects to add.
- project_
wif_ Sequence[Integrationconfigs Project Wif Config Args] - Please use
workload_identity_federation_configwithprojectsinstead. - projects
Integration
Projects Args - Object comprised of
sync_modeand optionalselected_project_ids. If you usesync_modeALL_REACHABLEthen Splunk Observability Cloud will automatically discover GCP projects that the provided WIF principal has permissions to query. Ifsync_modeisSELECTED, you need to provide a list of project ids in theselected_project_idsfield. - services Sequence[str]
- GCP service metrics to import. Can be an empty list, or not included, to import 'All services'. See Google Cloud Platform services for a list of valid values.
- use_
metric_ boolsource_ project_ for_ quota - When this value is set to true Observability Cloud will force usage of a quota from the project where metrics are stored. For this to work the service account provided for the project needs to be provided with serviceusage.services.use permission or Service Usage Consumer role in this project. When set to false default quota settings are used.
- wif_
splunk_ Mapping[str, str]identity - The Splunk Observability GCP identity to include in GCP WIF provider definition.
- workload_
identity_ strfederation_ config - Your Workload Identity Federation config. To easily set up WIF you can use helpers provided in the gcp_workload_identity_federation repository.
- enabled Boolean
- Whether the integration is enabled.
- auth
Method String - Authentication method to use in this integration. If empty, Splunk Observability backend defaults to SERVICE_ACCOUNT_KEY
- custom
Metric List<String>Type Domains - List of additional GCP service domain names that Splunk Observability Cloud will monitor. See Custom Metric Type Domains documentation
- exclude
Gce List<String>Instances With Labels - List of label keys. GCP Compute Engine instances with any of these labels applied are excluded from metric sync. Requires the
compute.instances.listpermission on the project’s service account. - import
Gcp BooleanMetrics - If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
- include
Lists List<String> - Compute Metadata Include List.
- name String
- Name of the integration.
- named
Token String - Name of the org token to be used for data ingestion. If not specified then default access token is used.
- poll
Rate Number - GCP integration poll rate (in seconds). Value between
60and600. Default:300. - project
Service List<Property Map>Keys - GCP projects to add.
- project
Wif List<Property Map>Configs - Please use
workload_identity_federation_configwithprojectsinstead. - projects Property Map
- Object comprised of
sync_modeand optionalselected_project_ids. If you usesync_modeALL_REACHABLEthen Splunk Observability Cloud will automatically discover GCP projects that the provided WIF principal has permissions to query. Ifsync_modeisSELECTED, you need to provide a list of project ids in theselected_project_idsfield. - services List<String>
- GCP service metrics to import. Can be an empty list, or not included, to import 'All services'. See Google Cloud Platform services for a list of valid values.
- use
Metric BooleanSource Project For Quota - When this value is set to true Observability Cloud will force usage of a quota from the project where metrics are stored. For this to work the service account provided for the project needs to be provided with serviceusage.services.use permission or Service Usage Consumer role in this project. When set to false default quota settings are used.
- wif
Splunk Map<String>Identity - The Splunk Observability GCP identity to include in GCP WIF provider definition.
- workload
Identity StringFederation Config - Your Workload Identity Federation config. To easily set up WIF you can use helpers provided in the gcp_workload_identity_federation repository.
Outputs
All input properties are implicitly available as output properties. Additionally, the Integration resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Integration Resource
Get an existing Integration 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?: IntegrationState, opts?: CustomResourceOptions): Integration@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auth_method: Optional[str] = None,
custom_metric_type_domains: Optional[Sequence[str]] = None,
enabled: Optional[bool] = None,
exclude_gce_instances_with_labels: Optional[Sequence[str]] = None,
import_gcp_metrics: Optional[bool] = None,
include_lists: Optional[Sequence[str]] = None,
name: Optional[str] = None,
named_token: Optional[str] = None,
poll_rate: Optional[int] = None,
project_service_keys: Optional[Sequence[IntegrationProjectServiceKeyArgs]] = None,
project_wif_configs: Optional[Sequence[IntegrationProjectWifConfigArgs]] = None,
projects: Optional[IntegrationProjectsArgs] = None,
services: Optional[Sequence[str]] = None,
use_metric_source_project_for_quota: Optional[bool] = None,
wif_splunk_identity: Optional[Mapping[str, str]] = None,
workload_identity_federation_config: Optional[str] = None) -> Integrationfunc GetIntegration(ctx *Context, name string, id IDInput, state *IntegrationState, opts ...ResourceOption) (*Integration, error)public static Integration Get(string name, Input<string> id, IntegrationState? state, CustomResourceOptions? opts = null)public static Integration get(String name, Output<String> id, IntegrationState state, CustomResourceOptions options)resources: _: type: signalfx:gcp:Integration get: id: ${id}- 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.
- Auth
Method string - Authentication method to use in this integration. If empty, Splunk Observability backend defaults to SERVICE_ACCOUNT_KEY
- Custom
Metric List<string>Type Domains - List of additional GCP service domain names that Splunk Observability Cloud will monitor. See Custom Metric Type Domains documentation
- Enabled bool
- Whether the integration is enabled.
- Exclude
Gce List<string>Instances With Labels - List of label keys. GCP Compute Engine instances with any of these labels applied are excluded from metric sync. Requires the
compute.instances.listpermission on the project’s service account. - Import
Gcp boolMetrics - If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
- Include
Lists List<string> - Compute Metadata Include List.
- Name string
- Name of the integration.
- Named
Token string - Name of the org token to be used for data ingestion. If not specified then default access token is used.
- Poll
Rate int - GCP integration poll rate (in seconds). Value between
60and600. Default:300. - Project
Service List<Pulumi.Keys Signal Fx. Gcp. Inputs. Integration Project Service Key> - GCP projects to add.
- Project
Wif List<Pulumi.Configs Signal Fx. Gcp. Inputs. Integration Project Wif Config> - Please use
workload_identity_federation_configwithprojectsinstead. - Projects
Pulumi.
Signal Fx. Gcp. Inputs. Integration Projects - Object comprised of
sync_modeand optionalselected_project_ids. If you usesync_modeALL_REACHABLEthen Splunk Observability Cloud will automatically discover GCP projects that the provided WIF principal has permissions to query. Ifsync_modeisSELECTED, you need to provide a list of project ids in theselected_project_idsfield. - Services List<string>
- GCP service metrics to import. Can be an empty list, or not included, to import 'All services'. See Google Cloud Platform services for a list of valid values.
- Use
Metric boolSource Project For Quota - When this value is set to true Observability Cloud will force usage of a quota from the project where metrics are stored. For this to work the service account provided for the project needs to be provided with serviceusage.services.use permission or Service Usage Consumer role in this project. When set to false default quota settings are used.
- Wif
Splunk Dictionary<string, string>Identity - The Splunk Observability GCP identity to include in GCP WIF provider definition.
- Workload
Identity stringFederation Config - Your Workload Identity Federation config. To easily set up WIF you can use helpers provided in the gcp_workload_identity_federation repository.
- Auth
Method string - Authentication method to use in this integration. If empty, Splunk Observability backend defaults to SERVICE_ACCOUNT_KEY
- Custom
Metric []stringType Domains - List of additional GCP service domain names that Splunk Observability Cloud will monitor. See Custom Metric Type Domains documentation
- Enabled bool
- Whether the integration is enabled.
- Exclude
Gce []stringInstances With Labels - List of label keys. GCP Compute Engine instances with any of these labels applied are excluded from metric sync. Requires the
compute.instances.listpermission on the project’s service account. - Import
Gcp boolMetrics - If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
- Include
Lists []string - Compute Metadata Include List.
- Name string
- Name of the integration.
- Named
Token string - Name of the org token to be used for data ingestion. If not specified then default access token is used.
- Poll
Rate int - GCP integration poll rate (in seconds). Value between
60and600. Default:300. - Project
Service []IntegrationKeys Project Service Key Args - GCP projects to add.
- Project
Wif []IntegrationConfigs Project Wif Config Args - Please use
workload_identity_federation_configwithprojectsinstead. - Projects
Integration
Projects Args - Object comprised of
sync_modeand optionalselected_project_ids. If you usesync_modeALL_REACHABLEthen Splunk Observability Cloud will automatically discover GCP projects that the provided WIF principal has permissions to query. Ifsync_modeisSELECTED, you need to provide a list of project ids in theselected_project_idsfield. - Services []string
- GCP service metrics to import. Can be an empty list, or not included, to import 'All services'. See Google Cloud Platform services for a list of valid values.
- Use
Metric boolSource Project For Quota - When this value is set to true Observability Cloud will force usage of a quota from the project where metrics are stored. For this to work the service account provided for the project needs to be provided with serviceusage.services.use permission or Service Usage Consumer role in this project. When set to false default quota settings are used.
- Wif
Splunk map[string]stringIdentity - The Splunk Observability GCP identity to include in GCP WIF provider definition.
- Workload
Identity stringFederation Config - Your Workload Identity Federation config. To easily set up WIF you can use helpers provided in the gcp_workload_identity_federation repository.
- auth
Method String - Authentication method to use in this integration. If empty, Splunk Observability backend defaults to SERVICE_ACCOUNT_KEY
- custom
Metric List<String>Type Domains - List of additional GCP service domain names that Splunk Observability Cloud will monitor. See Custom Metric Type Domains documentation
- enabled Boolean
- Whether the integration is enabled.
- exclude
Gce List<String>Instances With Labels - List of label keys. GCP Compute Engine instances with any of these labels applied are excluded from metric sync. Requires the
compute.instances.listpermission on the project’s service account. - import
Gcp BooleanMetrics - If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
- include
Lists List<String> - Compute Metadata Include List.
- name String
- Name of the integration.
- named
Token String - Name of the org token to be used for data ingestion. If not specified then default access token is used.
- poll
Rate Integer - GCP integration poll rate (in seconds). Value between
60and600. Default:300. - project
Service List<IntegrationKeys Project Service Key> - GCP projects to add.
- project
Wif List<IntegrationConfigs Project Wif Config> - Please use
workload_identity_federation_configwithprojectsinstead. - projects
Integration
Projects - Object comprised of
sync_modeand optionalselected_project_ids. If you usesync_modeALL_REACHABLEthen Splunk Observability Cloud will automatically discover GCP projects that the provided WIF principal has permissions to query. Ifsync_modeisSELECTED, you need to provide a list of project ids in theselected_project_idsfield. - services List<String>
- GCP service metrics to import. Can be an empty list, or not included, to import 'All services'. See Google Cloud Platform services for a list of valid values.
- use
Metric BooleanSource Project For Quota - When this value is set to true Observability Cloud will force usage of a quota from the project where metrics are stored. For this to work the service account provided for the project needs to be provided with serviceusage.services.use permission or Service Usage Consumer role in this project. When set to false default quota settings are used.
- wif
Splunk Map<String,String>Identity - The Splunk Observability GCP identity to include in GCP WIF provider definition.
- workload
Identity StringFederation Config - Your Workload Identity Federation config. To easily set up WIF you can use helpers provided in the gcp_workload_identity_federation repository.
- auth
Method string - Authentication method to use in this integration. If empty, Splunk Observability backend defaults to SERVICE_ACCOUNT_KEY
- custom
Metric string[]Type Domains - List of additional GCP service domain names that Splunk Observability Cloud will monitor. See Custom Metric Type Domains documentation
- enabled boolean
- Whether the integration is enabled.
- exclude
Gce string[]Instances With Labels - List of label keys. GCP Compute Engine instances with any of these labels applied are excluded from metric sync. Requires the
compute.instances.listpermission on the project’s service account. - import
Gcp booleanMetrics - If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
- include
Lists string[] - Compute Metadata Include List.
- name string
- Name of the integration.
- named
Token string - Name of the org token to be used for data ingestion. If not specified then default access token is used.
- poll
Rate number - GCP integration poll rate (in seconds). Value between
60and600. Default:300. - project
Service IntegrationKeys Project Service Key[] - GCP projects to add.
- project
Wif IntegrationConfigs Project Wif Config[] - Please use
workload_identity_federation_configwithprojectsinstead. - projects
Integration
Projects - Object comprised of
sync_modeand optionalselected_project_ids. If you usesync_modeALL_REACHABLEthen Splunk Observability Cloud will automatically discover GCP projects that the provided WIF principal has permissions to query. Ifsync_modeisSELECTED, you need to provide a list of project ids in theselected_project_idsfield. - services string[]
- GCP service metrics to import. Can be an empty list, or not included, to import 'All services'. See Google Cloud Platform services for a list of valid values.
- use
Metric booleanSource Project For Quota - When this value is set to true Observability Cloud will force usage of a quota from the project where metrics are stored. For this to work the service account provided for the project needs to be provided with serviceusage.services.use permission or Service Usage Consumer role in this project. When set to false default quota settings are used.
- wif
Splunk {[key: string]: string}Identity - The Splunk Observability GCP identity to include in GCP WIF provider definition.
- workload
Identity stringFederation Config - Your Workload Identity Federation config. To easily set up WIF you can use helpers provided in the gcp_workload_identity_federation repository.
- auth_
method str - Authentication method to use in this integration. If empty, Splunk Observability backend defaults to SERVICE_ACCOUNT_KEY
- custom_
metric_ Sequence[str]type_ domains - List of additional GCP service domain names that Splunk Observability Cloud will monitor. See Custom Metric Type Domains documentation
- enabled bool
- Whether the integration is enabled.
- exclude_
gce_ Sequence[str]instances_ with_ labels - List of label keys. GCP Compute Engine instances with any of these labels applied are excluded from metric sync. Requires the
compute.instances.listpermission on the project’s service account. - import_
gcp_ boolmetrics - If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
- include_
lists Sequence[str] - Compute Metadata Include List.
- name str
- Name of the integration.
- named_
token str - Name of the org token to be used for data ingestion. If not specified then default access token is used.
- poll_
rate int - GCP integration poll rate (in seconds). Value between
60and600. Default:300. - project_
service_ Sequence[Integrationkeys Project Service Key Args] - GCP projects to add.
- project_
wif_ Sequence[Integrationconfigs Project Wif Config Args] - Please use
workload_identity_federation_configwithprojectsinstead. - projects
Integration
Projects Args - Object comprised of
sync_modeand optionalselected_project_ids. If you usesync_modeALL_REACHABLEthen Splunk Observability Cloud will automatically discover GCP projects that the provided WIF principal has permissions to query. Ifsync_modeisSELECTED, you need to provide a list of project ids in theselected_project_idsfield. - services Sequence[str]
- GCP service metrics to import. Can be an empty list, or not included, to import 'All services'. See Google Cloud Platform services for a list of valid values.
- use_
metric_ boolsource_ project_ for_ quota - When this value is set to true Observability Cloud will force usage of a quota from the project where metrics are stored. For this to work the service account provided for the project needs to be provided with serviceusage.services.use permission or Service Usage Consumer role in this project. When set to false default quota settings are used.
- wif_
splunk_ Mapping[str, str]identity - The Splunk Observability GCP identity to include in GCP WIF provider definition.
- workload_
identity_ strfederation_ config - Your Workload Identity Federation config. To easily set up WIF you can use helpers provided in the gcp_workload_identity_federation repository.
- auth
Method String - Authentication method to use in this integration. If empty, Splunk Observability backend defaults to SERVICE_ACCOUNT_KEY
- custom
Metric List<String>Type Domains - List of additional GCP service domain names that Splunk Observability Cloud will monitor. See Custom Metric Type Domains documentation
- enabled Boolean
- Whether the integration is enabled.
- exclude
Gce List<String>Instances With Labels - List of label keys. GCP Compute Engine instances with any of these labels applied are excluded from metric sync. Requires the
compute.instances.listpermission on the project’s service account. - import
Gcp BooleanMetrics - If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
- include
Lists List<String> - Compute Metadata Include List.
- name String
- Name of the integration.
- named
Token String - Name of the org token to be used for data ingestion. If not specified then default access token is used.
- poll
Rate Number - GCP integration poll rate (in seconds). Value between
60and600. Default:300. - project
Service List<Property Map>Keys - GCP projects to add.
- project
Wif List<Property Map>Configs - Please use
workload_identity_federation_configwithprojectsinstead. - projects Property Map
- Object comprised of
sync_modeand optionalselected_project_ids. If you usesync_modeALL_REACHABLEthen Splunk Observability Cloud will automatically discover GCP projects that the provided WIF principal has permissions to query. Ifsync_modeisSELECTED, you need to provide a list of project ids in theselected_project_idsfield. - services List<String>
- GCP service metrics to import. Can be an empty list, or not included, to import 'All services'. See Google Cloud Platform services for a list of valid values.
- use
Metric BooleanSource Project For Quota - When this value is set to true Observability Cloud will force usage of a quota from the project where metrics are stored. For this to work the service account provided for the project needs to be provided with serviceusage.services.use permission or Service Usage Consumer role in this project. When set to false default quota settings are used.
- wif
Splunk Map<String>Identity - The Splunk Observability GCP identity to include in GCP WIF provider definition.
- workload
Identity StringFederation Config - Your Workload Identity Federation config. To easily set up WIF you can use helpers provided in the gcp_workload_identity_federation repository.
Supporting Types
IntegrationProjectServiceKey, IntegrationProjectServiceKeyArgs
- Project
Id string - Project
Key string
- Project
Id string - Project
Key string
- project
Id String - project
Key String
- project
Id string - project
Key string
- project_
id str - project_
key str
- project
Id String - project
Key String
IntegrationProjectWifConfig, IntegrationProjectWifConfigArgs
- project_
id str - wif_
config str
IntegrationProjects, IntegrationProjectsArgs
- Selected
Project List<string>Ids - List of project IDs to synchronize metrics and metadata from. Use only if you don't want to automatically synchronize all projects.
- Sync
Mode string - What mode of synchronizing projects should be used. Sync all tries to synchronize metrics and metadata from all discoverable projects.
- Selected
Project []stringIds - List of project IDs to synchronize metrics and metadata from. Use only if you don't want to automatically synchronize all projects.
- Sync
Mode string - What mode of synchronizing projects should be used. Sync all tries to synchronize metrics and metadata from all discoverable projects.
- selected
Project List<String>Ids - List of project IDs to synchronize metrics and metadata from. Use only if you don't want to automatically synchronize all projects.
- sync
Mode String - What mode of synchronizing projects should be used. Sync all tries to synchronize metrics and metadata from all discoverable projects.
- selected
Project string[]Ids - List of project IDs to synchronize metrics and metadata from. Use only if you don't want to automatically synchronize all projects.
- sync
Mode string - What mode of synchronizing projects should be used. Sync all tries to synchronize metrics and metadata from all discoverable projects.
- selected_
project_ Sequence[str]ids - List of project IDs to synchronize metrics and metadata from. Use only if you don't want to automatically synchronize all projects.
- sync_
mode str - What mode of synchronizing projects should be used. Sync all tries to synchronize metrics and metadata from all discoverable projects.
- selected
Project List<String>Ids - List of project IDs to synchronize metrics and metadata from. Use only if you don't want to automatically synchronize all projects.
- sync
Mode String - What mode of synchronizing projects should be used. Sync all tries to synchronize metrics and metadata from all discoverable projects.
Package Details
- Repository
- SignalFx pulumi/pulumi-signalfx
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
signalfxTerraform Provider.
