Docs Packages
  1. Packages
  2. SignalFx
  3. API Docs
  4. gcp
  5. Integration
SignalFx v7.1.7 published on Tuesday, Jul 16, 2024 by Pulumi
pulumi/pulumi-signalfx

signalfx.gcp.Integration

Explore with Pulumi AI

signalfx logo
SignalFx v7.1.7 published on Tuesday, Jul 16, 2024 by Pulumi
pulumi/pulumi-signalfx

    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

    resource "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 = "${file("/path/to/gcp_credentials_1.json")}"
  }
  project_service_keys {
    project_id  = "gcp_project_id_2"
    project_key = "${file("/path/to/gcp_credentials_2.json")}"
  }
}

    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,
                custom_metric_type_domains: 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,
                services: Optional[Sequence[str]] = None,
                use_metric_source_project_for_quota: Optional[bool] = 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,
    CustomMetricTypeDomains = new[]
    {
        "string",
    },
    ImportGcpMetrics = false,
    IncludeLists = new[]
    {
        "string",
    },
    Name = "string",
    NamedToken = "string",
    PollRate = 0,
    ProjectServiceKeys = new[]
    {
        new SignalFx.Gcp.Inputs.IntegrationProjectServiceKeyArgs
        {
            ProjectId = "string",
            ProjectKey = "string",
        },
    },
    Services = new[]
    {
        "string",
    },
    UseMetricSourceProjectForQuota = false,
});

    example, err := gcp.NewIntegration(ctx, "exampleintegrationResourceResourceFromGcpintegration", &gcp.IntegrationArgs{
	Enabled: pulumi.Bool(false),
	CustomMetricTypeDomains: pulumi.StringArray{
		pulumi.String("string"),
	},
	ImportGcpMetrics: pulumi.Bool(false),
	IncludeLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:       pulumi.String("string"),
	NamedToken: pulumi.String("string"),
	PollRate:   pulumi.Int(0),
	ProjectServiceKeys: gcp.IntegrationProjectServiceKeyArray{
		&gcp.IntegrationProjectServiceKeyArgs{
			ProjectId:  pulumi.String("string"),
			ProjectKey: pulumi.String("string"),
		},
	},
	Services: pulumi.StringArray{
		pulumi.String("string"),
	},
	UseMetricSourceProjectForQuota: pulumi.Bool(false),
})

    var exampleintegrationResourceResourceFromGcpintegration = new Integration("exampleintegrationResourceResourceFromGcpintegration", IntegrationArgs.builder()
    .enabled(false)
    .customMetricTypeDomains("string")
    .importGcpMetrics(false)
    .includeLists("string")
    .name("string")
    .namedToken("string")
    .pollRate(0)
    .projectServiceKeys(IntegrationProjectServiceKeyArgs.builder()
        .projectId("string")
        .projectKey("string")
        .build())
    .services("string")
    .useMetricSourceProjectForQuota(false)
    .build());

    exampleintegration_resource_resource_from_gcpintegration = signalfx.gcp.Integration("exampleintegrationResourceResourceFromGcpintegration",
    enabled=False,
    custom_metric_type_domains=["string"],
    import_gcp_metrics=False,
    include_lists=["string"],
    name="string",
    named_token="string",
    poll_rate=0,
    project_service_keys=[signalfx.gcp.IntegrationProjectServiceKeyArgs(
        project_id="string",
        project_key="string",
    )],
    services=["string"],
    use_metric_source_project_for_quota=False)

    const exampleintegrationResourceResourceFromGcpintegration = new signalfx.gcp.Integration("exampleintegrationResourceResourceFromGcpintegration", {
    enabled: false,
    customMetricTypeDomains: ["string"],
    importGcpMetrics: false,
    includeLists: ["string"],
    name: "string",
    namedToken: "string",
    pollRate: 0,
    projectServiceKeys: [{
        projectId: "string",
        projectKey: "string",
    }],
    services: ["string"],
    useMetricSourceProjectForQuota: false,
});

    type: signalfx:gcp:Integration
properties:
    customMetricTypeDomains:
        - string
    enabled: false
    importGcpMetrics: false
    includeLists:
        - string
    name: string
    namedToken: string
    pollRate: 0
    projectServiceKeys:
        - projectId: string
          projectKey: string
    services:
        - string
    useMetricSourceProjectForQuota: false

    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

    The Integration resource accepts the following input properties:

    Enabled bool
    Whether the integration is enabled.
    CustomMetricTypeDomains List<string>
    List of additional GCP service domain names that Splunk Observability Cloud will monitor. See Custom Metric Type Domains documentation
    ImportGcpMetrics bool
    If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
    IncludeLists List<string>
    Compute Metadata Include List.
    Name string
    Name of the integration.
    NamedToken string
    Name of the org token to be used for data ingestion. If not specified then default access token is used.
    PollRate int
    GCP integration poll rate (in seconds). Value between 60 and 600. Default: 300.
    ProjectServiceKeys List<Pulumi.SignalFx.Gcp.Inputs.IntegrationProjectServiceKey>
    GCP projects to add.
    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.
    UseMetricSourceProjectForQuota bool
    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.
    Enabled bool
    Whether the integration is enabled.
    CustomMetricTypeDomains []string
    List of additional GCP service domain names that Splunk Observability Cloud will monitor. See Custom Metric Type Domains documentation
    ImportGcpMetrics bool
    If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
    IncludeLists []string
    Compute Metadata Include List.
    Name string
    Name of the integration.
    NamedToken string
    Name of the org token to be used for data ingestion. If not specified then default access token is used.
    PollRate int
    GCP integration poll rate (in seconds). Value between 60 and 600. Default: 300.
    ProjectServiceKeys []IntegrationProjectServiceKeyArgs
    GCP projects to add.
    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.
    UseMetricSourceProjectForQuota bool
    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.
    enabled Boolean
    Whether the integration is enabled.
    customMetricTypeDomains List<String>
    List of additional GCP service domain names that Splunk Observability Cloud will monitor. See Custom Metric Type Domains documentation
    importGcpMetrics Boolean
    If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
    includeLists List<String>
    Compute Metadata Include List.
    name String
    Name of the integration.
    namedToken String
    Name of the org token to be used for data ingestion. If not specified then default access token is used.
    pollRate Integer
    GCP integration poll rate (in seconds). Value between 60 and 600. Default: 300.
    projectServiceKeys List<IntegrationProjectServiceKey>
    GCP projects to add.
    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.
    useMetricSourceProjectForQuota Boolean
    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.
    enabled boolean
    Whether the integration is enabled.
    customMetricTypeDomains string[]
    List of additional GCP service domain names that Splunk Observability Cloud will monitor. See Custom Metric Type Domains documentation
    importGcpMetrics boolean
    If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
    includeLists string[]
    Compute Metadata Include List.
    name string
    Name of the integration.
    namedToken string
    Name of the org token to be used for data ingestion. If not specified then default access token is used.
    pollRate number
    GCP integration poll rate (in seconds). Value between 60 and 600. Default: 300.
    projectServiceKeys IntegrationProjectServiceKey[]
    GCP projects to add.
    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.
    useMetricSourceProjectForQuota boolean
    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.
    enabled bool
    Whether the integration is enabled.
    custom_metric_type_domains Sequence[str]
    List of additional GCP service domain names that Splunk Observability Cloud will monitor. See Custom Metric Type Domains documentation
    import_gcp_metrics bool
    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 60 and 600. Default: 300.
    project_service_keys Sequence[IntegrationProjectServiceKeyArgs]
    GCP projects to add.
    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_source_project_for_quota bool
    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.
    enabled Boolean
    Whether the integration is enabled.
    customMetricTypeDomains List<String>
    List of additional GCP service domain names that Splunk Observability Cloud will monitor. See Custom Metric Type Domains documentation
    importGcpMetrics Boolean
    If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
    includeLists List<String>
    Compute Metadata Include List.
    name String
    Name of the integration.
    namedToken String
    Name of the org token to be used for data ingestion. If not specified then default access token is used.
    pollRate Number
    GCP integration poll rate (in seconds). Value between 60 and 600. Default: 300.
    projectServiceKeys List<Property Map>
    GCP projects to add.
    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.
    useMetricSourceProjectForQuota Boolean
    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.

    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,
        custom_metric_type_domains: Optional[Sequence[str]] = None,
        enabled: Optional[bool] = 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,
        services: Optional[Sequence[str]] = None,
        use_metric_source_project_for_quota: Optional[bool] = None) -> Integration
    func 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)
    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.
    The following state arguments are supported:
    CustomMetricTypeDomains List<string>
    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.
    ImportGcpMetrics bool
    If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
    IncludeLists List<string>
    Compute Metadata Include List.
    Name string
    Name of the integration.
    NamedToken string
    Name of the org token to be used for data ingestion. If not specified then default access token is used.
    PollRate int
    GCP integration poll rate (in seconds). Value between 60 and 600. Default: 300.
    ProjectServiceKeys List<Pulumi.SignalFx.Gcp.Inputs.IntegrationProjectServiceKey>
    GCP projects to add.
    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.
    UseMetricSourceProjectForQuota bool
    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.
    CustomMetricTypeDomains []string
    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.
    ImportGcpMetrics bool
    If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
    IncludeLists []string
    Compute Metadata Include List.
    Name string
    Name of the integration.
    NamedToken string
    Name of the org token to be used for data ingestion. If not specified then default access token is used.
    PollRate int
    GCP integration poll rate (in seconds). Value between 60 and 600. Default: 300.
    ProjectServiceKeys []IntegrationProjectServiceKeyArgs
    GCP projects to add.
    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.
    UseMetricSourceProjectForQuota bool
    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.
    customMetricTypeDomains List<String>
    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.
    importGcpMetrics Boolean
    If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
    includeLists List<String>
    Compute Metadata Include List.
    name String
    Name of the integration.
    namedToken String
    Name of the org token to be used for data ingestion. If not specified then default access token is used.
    pollRate Integer
    GCP integration poll rate (in seconds). Value between 60 and 600. Default: 300.
    projectServiceKeys List<IntegrationProjectServiceKey>
    GCP projects to add.
    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.
    useMetricSourceProjectForQuota Boolean
    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.
    customMetricTypeDomains string[]
    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.
    importGcpMetrics boolean
    If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
    includeLists string[]
    Compute Metadata Include List.
    name string
    Name of the integration.
    namedToken string
    Name of the org token to be used for data ingestion. If not specified then default access token is used.
    pollRate number
    GCP integration poll rate (in seconds). Value between 60 and 600. Default: 300.
    projectServiceKeys IntegrationProjectServiceKey[]
    GCP projects to add.
    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.
    useMetricSourceProjectForQuota boolean
    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.
    custom_metric_type_domains Sequence[str]
    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.
    import_gcp_metrics bool
    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 60 and 600. Default: 300.
    project_service_keys Sequence[IntegrationProjectServiceKeyArgs]
    GCP projects to add.
    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_source_project_for_quota bool
    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.
    customMetricTypeDomains List<String>
    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.
    importGcpMetrics Boolean
    If enabled, Splunk Observability Cloud will sync also Google Cloud Monitoring data. If disabled, Splunk Observability Cloud will import only metadata. Defaults to true.
    includeLists List<String>
    Compute Metadata Include List.
    name String
    Name of the integration.
    namedToken String
    Name of the org token to be used for data ingestion. If not specified then default access token is used.
    pollRate Number
    GCP integration poll rate (in seconds). Value between 60 and 600. Default: 300.
    projectServiceKeys List<Property Map>
    GCP projects to add.
    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.
    useMetricSourceProjectForQuota Boolean
    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.

    Supporting Types

    IntegrationProjectServiceKey, IntegrationProjectServiceKeyArgs

    ProjectId string
    ProjectKey string
    ProjectId string
    ProjectKey string
    projectId String
    projectKey String
    projectId string
    projectKey string
    projectId String
    projectKey String

    Package Details

    Repository
    SignalFx pulumi/pulumi-signalfx
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the signalfx Terraform Provider.
    signalfx logo
    SignalFx v7.1.7 published on Tuesday, Jul 16, 2024 by Pulumi
    pulumi/pulumi-signalfx