1. Packages
  2. Packages
  3. Google Cloud (GCP) Classic
  4. API Docs
  5. apigee
  6. DataCollector
Viewing docs for Google Cloud v9.24.0
published on Friday, May 22, 2026 by Pulumi
gcp logo
Viewing docs for Google Cloud v9.24.0
published on Friday, May 22, 2026 by Pulumi

    A DataCollector collects and stores data from the runtime for use in Analytics custom reports or API monetization. Data collectors are scoped to an Apigee organization.

    To get more information about DataCollector, see:

    Example Usage

    Apigee Data Collector Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const current = gcp.organizations.getClientConfig({});
    const apigeeNetwork = new gcp.compute.Network("apigee_network", {name: "apigee-network"});
    const apigeeRange = new gcp.compute.GlobalAddress("apigee_range", {
        name: "apigee-range",
        purpose: "VPC_PEERING",
        addressType: "INTERNAL",
        prefixLength: 16,
        network: apigeeNetwork.id,
    });
    const apigeeVpcConnection = new gcp.servicenetworking.Connection("apigee_vpc_connection", {
        network: apigeeNetwork.id,
        service: "servicenetworking.googleapis.com",
        reservedPeeringRanges: [apigeeRange.name],
    });
    const apigeeOrg = new gcp.apigee.Organization("apigee_org", {
        analyticsRegion: "us-central1",
        projectId: current.then(current => current.project),
        authorizedNetwork: apigeeNetwork.id,
    }, {
        dependsOn: [apigeeVpcConnection],
    });
    const apigeeDataCollector = new gcp.apigee.DataCollector("apigee_data_collector", {
        orgId: apigeeOrg.id,
        dataCollectorId: "dc_my_data_collector",
        description: "A data collector for custom analytics",
        type: "INTEGER",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    current = gcp.organizations.get_client_config()
    apigee_network = gcp.compute.Network("apigee_network", name="apigee-network")
    apigee_range = gcp.compute.GlobalAddress("apigee_range",
        name="apigee-range",
        purpose="VPC_PEERING",
        address_type="INTERNAL",
        prefix_length=16,
        network=apigee_network.id)
    apigee_vpc_connection = gcp.servicenetworking.Connection("apigee_vpc_connection",
        network=apigee_network.id,
        service="servicenetworking.googleapis.com",
        reserved_peering_ranges=[apigee_range.name])
    apigee_org = gcp.apigee.Organization("apigee_org",
        analytics_region="us-central1",
        project_id=current.project,
        authorized_network=apigee_network.id,
        opts = pulumi.ResourceOptions(depends_on=[apigee_vpc_connection]))
    apigee_data_collector = gcp.apigee.DataCollector("apigee_data_collector",
        org_id=apigee_org.id,
        data_collector_id="dc_my_data_collector",
        description="A data collector for custom analytics",
        type="INTEGER")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/apigee"
    	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
    	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/organizations"
    	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/servicenetworking"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		current, err := organizations.GetClientConfig(ctx, map[string]interface{}{}, nil)
    		if err != nil {
    			return err
    		}
    		apigeeNetwork, err := compute.NewNetwork(ctx, "apigee_network", &compute.NetworkArgs{
    			Name: pulumi.String("apigee-network"),
    		})
    		if err != nil {
    			return err
    		}
    		apigeeRange, err := compute.NewGlobalAddress(ctx, "apigee_range", &compute.GlobalAddressArgs{
    			Name:         pulumi.String("apigee-range"),
    			Purpose:      pulumi.String("VPC_PEERING"),
    			AddressType:  pulumi.String("INTERNAL"),
    			PrefixLength: pulumi.Int(16),
    			Network:      apigeeNetwork.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		apigeeVpcConnection, err := servicenetworking.NewConnection(ctx, "apigee_vpc_connection", &servicenetworking.ConnectionArgs{
    			Network: apigeeNetwork.ID(),
    			Service: pulumi.String("servicenetworking.googleapis.com"),
    			ReservedPeeringRanges: pulumi.StringArray{
    				apigeeRange.Name,
    			},
    		})
    		if err != nil {
    			return err
    		}
    		apigeeOrg, err := apigee.NewOrganization(ctx, "apigee_org", &apigee.OrganizationArgs{
    			AnalyticsRegion:   pulumi.String("us-central1"),
    			ProjectId:         pulumi.String(pulumi.String(current.Project)),
    			AuthorizedNetwork: apigeeNetwork.ID(),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			apigeeVpcConnection,
    		}))
    		if err != nil {
    			return err
    		}
    		_, err = apigee.NewDataCollector(ctx, "apigee_data_collector", &apigee.DataCollectorArgs{
    			OrgId:           apigeeOrg.ID(),
    			DataCollectorId: pulumi.String("dc_my_data_collector"),
    			Description:     pulumi.String("A data collector for custom analytics"),
    			Type:            pulumi.String("INTEGER"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var current = Gcp.Organizations.GetClientConfig.Invoke();
    
        var apigeeNetwork = new Gcp.Compute.Network("apigee_network", new()
        {
            Name = "apigee-network",
        });
    
        var apigeeRange = new Gcp.Compute.GlobalAddress("apigee_range", new()
        {
            Name = "apigee-range",
            Purpose = "VPC_PEERING",
            AddressType = "INTERNAL",
            PrefixLength = 16,
            Network = apigeeNetwork.Id,
        });
    
        var apigeeVpcConnection = new Gcp.ServiceNetworking.Connection("apigee_vpc_connection", new()
        {
            Network = apigeeNetwork.Id,
            Service = "servicenetworking.googleapis.com",
            ReservedPeeringRanges = new[]
            {
                apigeeRange.Name,
            },
        });
    
        var apigeeOrg = new Gcp.Apigee.Organization("apigee_org", new()
        {
            AnalyticsRegion = "us-central1",
            ProjectId = current.Apply(getClientConfigResult => getClientConfigResult.Project),
            AuthorizedNetwork = apigeeNetwork.Id,
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                apigeeVpcConnection,
            },
        });
    
        var apigeeDataCollector = new Gcp.Apigee.DataCollector("apigee_data_collector", new()
        {
            OrgId = apigeeOrg.Id,
            DataCollectorId = "dc_my_data_collector",
            Description = "A data collector for custom analytics",
            Type = "INTEGER",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.organizations.OrganizationsFunctions;
    import com.pulumi.gcp.compute.Network;
    import com.pulumi.gcp.compute.NetworkArgs;
    import com.pulumi.gcp.compute.GlobalAddress;
    import com.pulumi.gcp.compute.GlobalAddressArgs;
    import com.pulumi.gcp.servicenetworking.Connection;
    import com.pulumi.gcp.servicenetworking.ConnectionArgs;
    import com.pulumi.gcp.apigee.Organization;
    import com.pulumi.gcp.apigee.OrganizationArgs;
    import com.pulumi.gcp.apigee.DataCollector;
    import com.pulumi.gcp.apigee.DataCollectorArgs;
    import com.pulumi.resources.CustomResourceOptions;
    import java.util.ArrayList;
    import java.util.Arrays;
    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) {
            final var current = OrganizationsFunctions.getClientConfig(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference);
    
            var apigeeNetwork = new Network("apigeeNetwork", NetworkArgs.builder()
                .name("apigee-network")
                .build());
    
            var apigeeRange = new GlobalAddress("apigeeRange", GlobalAddressArgs.builder()
                .name("apigee-range")
                .purpose("VPC_PEERING")
                .addressType("INTERNAL")
                .prefixLength(16)
                .network(apigeeNetwork.id())
                .build());
    
            var apigeeVpcConnection = new Connection("apigeeVpcConnection", ConnectionArgs.builder()
                .network(apigeeNetwork.id())
                .service("servicenetworking.googleapis.com")
                .reservedPeeringRanges(apigeeRange.name())
                .build());
    
            var apigeeOrg = new Organization("apigeeOrg", OrganizationArgs.builder()
                .analyticsRegion("us-central1")
                .projectId(current.project())
                .authorizedNetwork(apigeeNetwork.id())
                .build(), CustomResourceOptions.builder()
                    .dependsOn(apigeeVpcConnection)
                    .build());
    
            var apigeeDataCollector = new DataCollector("apigeeDataCollector", DataCollectorArgs.builder()
                .orgId(apigeeOrg.id())
                .dataCollectorId("dc_my_data_collector")
                .description("A data collector for custom analytics")
                .type("INTEGER")
                .build());
    
        }
    }
    
    resources:
      apigeeNetwork:
        type: gcp:compute:Network
        name: apigee_network
        properties:
          name: apigee-network
      apigeeRange:
        type: gcp:compute:GlobalAddress
        name: apigee_range
        properties:
          name: apigee-range
          purpose: VPC_PEERING
          addressType: INTERNAL
          prefixLength: 16
          network: ${apigeeNetwork.id}
      apigeeVpcConnection:
        type: gcp:servicenetworking:Connection
        name: apigee_vpc_connection
        properties:
          network: ${apigeeNetwork.id}
          service: servicenetworking.googleapis.com
          reservedPeeringRanges:
            - ${apigeeRange.name}
      apigeeOrg:
        type: gcp:apigee:Organization
        name: apigee_org
        properties:
          analyticsRegion: us-central1
          projectId: ${current.project}
          authorizedNetwork: ${apigeeNetwork.id}
        options:
          dependsOn:
            - ${apigeeVpcConnection}
      apigeeDataCollector:
        type: gcp:apigee:DataCollector
        name: apigee_data_collector
        properties:
          orgId: ${apigeeOrg.id}
          dataCollectorId: dc_my_data_collector
          description: A data collector for custom analytics
          type: INTEGER
    variables:
      current:
        fn::invoke:
          function: gcp:organizations:getClientConfig
          arguments: {}
    
    Example coming soon!
    

    Create DataCollector Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DataCollector(name: string, args: DataCollectorArgs, opts?: CustomResourceOptions);
    @overload
    def DataCollector(resource_name: str,
                      args: DataCollectorArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def DataCollector(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      data_collector_id: Optional[str] = None,
                      org_id: Optional[str] = None,
                      type: Optional[str] = None,
                      deletion_policy: Optional[str] = None,
                      description: Optional[str] = None)
    func NewDataCollector(ctx *Context, name string, args DataCollectorArgs, opts ...ResourceOption) (*DataCollector, error)
    public DataCollector(string name, DataCollectorArgs args, CustomResourceOptions? opts = null)
    public DataCollector(String name, DataCollectorArgs args)
    public DataCollector(String name, DataCollectorArgs args, CustomResourceOptions options)
    
    type: gcp:apigee:DataCollector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "gcp_apigee_datacollector" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args DataCollectorArgs
    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 DataCollectorArgs
    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 DataCollectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataCollectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataCollectorArgs
    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 dataCollectorResource = new Gcp.Apigee.DataCollector("dataCollectorResource", new()
    {
        DataCollectorId = "string",
        OrgId = "string",
        Type = "string",
        DeletionPolicy = "string",
        Description = "string",
    });
    
    example, err := apigee.NewDataCollector(ctx, "dataCollectorResource", &apigee.DataCollectorArgs{
    	DataCollectorId: pulumi.String("string"),
    	OrgId:           pulumi.String("string"),
    	Type:            pulumi.String("string"),
    	DeletionPolicy:  pulumi.String("string"),
    	Description:     pulumi.String("string"),
    })
    
    resource "gcp_apigee_datacollector" "dataCollectorResource" {
      data_collector_id = "string"
      org_id            = "string"
      type              = "string"
      deletion_policy   = "string"
      description       = "string"
    }
    
    var dataCollectorResource = new DataCollector("dataCollectorResource", DataCollectorArgs.builder()
        .dataCollectorId("string")
        .orgId("string")
        .type("string")
        .deletionPolicy("string")
        .description("string")
        .build());
    
    data_collector_resource = gcp.apigee.DataCollector("dataCollectorResource",
        data_collector_id="string",
        org_id="string",
        type="string",
        deletion_policy="string",
        description="string")
    
    const dataCollectorResource = new gcp.apigee.DataCollector("dataCollectorResource", {
        dataCollectorId: "string",
        orgId: "string",
        type: "string",
        deletionPolicy: "string",
        description: "string",
    });
    
    type: gcp:apigee:DataCollector
    properties:
        dataCollectorId: string
        deletionPolicy: string
        description: string
        orgId: string
        type: string
    

    DataCollector 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 DataCollector resource accepts the following input properties:

    DataCollectorId string
    The ID for the data collector. Must begin with dc_.
    OrgId string
    The Apigee Organization associated with the Apigee data collector, in the format organizations/{{org_name}}.
    Type string
    The type of data this data collector will collect. Possible values are: BOOLEAN, DATETIME, FLOAT, INTEGER, STRING.
    DeletionPolicy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    Description string
    A description of the data collector.
    DataCollectorId string
    The ID for the data collector. Must begin with dc_.
    OrgId string
    The Apigee Organization associated with the Apigee data collector, in the format organizations/{{org_name}}.
    Type string
    The type of data this data collector will collect. Possible values are: BOOLEAN, DATETIME, FLOAT, INTEGER, STRING.
    DeletionPolicy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    Description string
    A description of the data collector.
    data_collector_id string
    The ID for the data collector. Must begin with dc_.
    org_id string
    The Apigee Organization associated with the Apigee data collector, in the format organizations/{{org_name}}.
    type string
    The type of data this data collector will collect. Possible values are: BOOLEAN, DATETIME, FLOAT, INTEGER, STRING.
    deletion_policy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description string
    A description of the data collector.
    dataCollectorId String
    The ID for the data collector. Must begin with dc_.
    orgId String
    The Apigee Organization associated with the Apigee data collector, in the format organizations/{{org_name}}.
    type String
    The type of data this data collector will collect. Possible values are: BOOLEAN, DATETIME, FLOAT, INTEGER, STRING.
    deletionPolicy String
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description String
    A description of the data collector.
    dataCollectorId string
    The ID for the data collector. Must begin with dc_.
    orgId string
    The Apigee Organization associated with the Apigee data collector, in the format organizations/{{org_name}}.
    type string
    The type of data this data collector will collect. Possible values are: BOOLEAN, DATETIME, FLOAT, INTEGER, STRING.
    deletionPolicy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description string
    A description of the data collector.
    data_collector_id str
    The ID for the data collector. Must begin with dc_.
    org_id str
    The Apigee Organization associated with the Apigee data collector, in the format organizations/{{org_name}}.
    type str
    The type of data this data collector will collect. Possible values are: BOOLEAN, DATETIME, FLOAT, INTEGER, STRING.
    deletion_policy str
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description str
    A description of the data collector.
    dataCollectorId String
    The ID for the data collector. Must begin with dc_.
    orgId String
    The Apigee Organization associated with the Apigee data collector, in the format organizations/{{org_name}}.
    type String
    The type of data this data collector will collect. Possible values are: BOOLEAN, DATETIME, FLOAT, INTEGER, STRING.
    deletionPolicy String
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description String
    A description of the data collector.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DataCollector resource produces the following output properties:

    CreatedAt string
    The time at which the data collector was created in milliseconds since the epoch.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedAt string
    The time at which the data collector was last modified in milliseconds since the epoch.
    Name string
    The resource name of the data collector, in the format organizations/{{org_name}}/datacollectors/{{data_collector_id}}.
    CreatedAt string
    The time at which the data collector was created in milliseconds since the epoch.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedAt string
    The time at which the data collector was last modified in milliseconds since the epoch.
    Name string
    The resource name of the data collector, in the format organizations/{{org_name}}/datacollectors/{{data_collector_id}}.
    created_at string
    The time at which the data collector was created in milliseconds since the epoch.
    id string
    The provider-assigned unique ID for this managed resource.
    last_modified_at string
    The time at which the data collector was last modified in milliseconds since the epoch.
    name string
    The resource name of the data collector, in the format organizations/{{org_name}}/datacollectors/{{data_collector_id}}.
    createdAt String
    The time at which the data collector was created in milliseconds since the epoch.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedAt String
    The time at which the data collector was last modified in milliseconds since the epoch.
    name String
    The resource name of the data collector, in the format organizations/{{org_name}}/datacollectors/{{data_collector_id}}.
    createdAt string
    The time at which the data collector was created in milliseconds since the epoch.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedAt string
    The time at which the data collector was last modified in milliseconds since the epoch.
    name string
    The resource name of the data collector, in the format organizations/{{org_name}}/datacollectors/{{data_collector_id}}.
    created_at str
    The time at which the data collector was created in milliseconds since the epoch.
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified_at str
    The time at which the data collector was last modified in milliseconds since the epoch.
    name str
    The resource name of the data collector, in the format organizations/{{org_name}}/datacollectors/{{data_collector_id}}.
    createdAt String
    The time at which the data collector was created in milliseconds since the epoch.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedAt String
    The time at which the data collector was last modified in milliseconds since the epoch.
    name String
    The resource name of the data collector, in the format organizations/{{org_name}}/datacollectors/{{data_collector_id}}.

    Look up Existing DataCollector Resource

    Get an existing DataCollector 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?: DataCollectorState, opts?: CustomResourceOptions): DataCollector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created_at: Optional[str] = None,
            data_collector_id: Optional[str] = None,
            deletion_policy: Optional[str] = None,
            description: Optional[str] = None,
            last_modified_at: Optional[str] = None,
            name: Optional[str] = None,
            org_id: Optional[str] = None,
            type: Optional[str] = None) -> DataCollector
    func GetDataCollector(ctx *Context, name string, id IDInput, state *DataCollectorState, opts ...ResourceOption) (*DataCollector, error)
    public static DataCollector Get(string name, Input<string> id, DataCollectorState? state, CustomResourceOptions? opts = null)
    public static DataCollector get(String name, Output<String> id, DataCollectorState state, CustomResourceOptions options)
    resources:  _:    type: gcp:apigee:DataCollector    get:      id: ${id}
    import {
      to = gcp_apigee_datacollector.example
      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.
    The following state arguments are supported:
    CreatedAt string
    The time at which the data collector was created in milliseconds since the epoch.
    DataCollectorId string
    The ID for the data collector. Must begin with dc_.
    DeletionPolicy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    Description string
    A description of the data collector.
    LastModifiedAt string
    The time at which the data collector was last modified in milliseconds since the epoch.
    Name string
    The resource name of the data collector, in the format organizations/{{org_name}}/datacollectors/{{data_collector_id}}.
    OrgId string
    The Apigee Organization associated with the Apigee data collector, in the format organizations/{{org_name}}.
    Type string
    The type of data this data collector will collect. Possible values are: BOOLEAN, DATETIME, FLOAT, INTEGER, STRING.
    CreatedAt string
    The time at which the data collector was created in milliseconds since the epoch.
    DataCollectorId string
    The ID for the data collector. Must begin with dc_.
    DeletionPolicy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    Description string
    A description of the data collector.
    LastModifiedAt string
    The time at which the data collector was last modified in milliseconds since the epoch.
    Name string
    The resource name of the data collector, in the format organizations/{{org_name}}/datacollectors/{{data_collector_id}}.
    OrgId string
    The Apigee Organization associated with the Apigee data collector, in the format organizations/{{org_name}}.
    Type string
    The type of data this data collector will collect. Possible values are: BOOLEAN, DATETIME, FLOAT, INTEGER, STRING.
    created_at string
    The time at which the data collector was created in milliseconds since the epoch.
    data_collector_id string
    The ID for the data collector. Must begin with dc_.
    deletion_policy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description string
    A description of the data collector.
    last_modified_at string
    The time at which the data collector was last modified in milliseconds since the epoch.
    name string
    The resource name of the data collector, in the format organizations/{{org_name}}/datacollectors/{{data_collector_id}}.
    org_id string
    The Apigee Organization associated with the Apigee data collector, in the format organizations/{{org_name}}.
    type string
    The type of data this data collector will collect. Possible values are: BOOLEAN, DATETIME, FLOAT, INTEGER, STRING.
    createdAt String
    The time at which the data collector was created in milliseconds since the epoch.
    dataCollectorId String
    The ID for the data collector. Must begin with dc_.
    deletionPolicy String
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description String
    A description of the data collector.
    lastModifiedAt String
    The time at which the data collector was last modified in milliseconds since the epoch.
    name String
    The resource name of the data collector, in the format organizations/{{org_name}}/datacollectors/{{data_collector_id}}.
    orgId String
    The Apigee Organization associated with the Apigee data collector, in the format organizations/{{org_name}}.
    type String
    The type of data this data collector will collect. Possible values are: BOOLEAN, DATETIME, FLOAT, INTEGER, STRING.
    createdAt string
    The time at which the data collector was created in milliseconds since the epoch.
    dataCollectorId string
    The ID for the data collector. Must begin with dc_.
    deletionPolicy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description string
    A description of the data collector.
    lastModifiedAt string
    The time at which the data collector was last modified in milliseconds since the epoch.
    name string
    The resource name of the data collector, in the format organizations/{{org_name}}/datacollectors/{{data_collector_id}}.
    orgId string
    The Apigee Organization associated with the Apigee data collector, in the format organizations/{{org_name}}.
    type string
    The type of data this data collector will collect. Possible values are: BOOLEAN, DATETIME, FLOAT, INTEGER, STRING.
    created_at str
    The time at which the data collector was created in milliseconds since the epoch.
    data_collector_id str
    The ID for the data collector. Must begin with dc_.
    deletion_policy str
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description str
    A description of the data collector.
    last_modified_at str
    The time at which the data collector was last modified in milliseconds since the epoch.
    name str
    The resource name of the data collector, in the format organizations/{{org_name}}/datacollectors/{{data_collector_id}}.
    org_id str
    The Apigee Organization associated with the Apigee data collector, in the format organizations/{{org_name}}.
    type str
    The type of data this data collector will collect. Possible values are: BOOLEAN, DATETIME, FLOAT, INTEGER, STRING.
    createdAt String
    The time at which the data collector was created in milliseconds since the epoch.
    dataCollectorId String
    The ID for the data collector. Must begin with dc_.
    deletionPolicy String
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description String
    A description of the data collector.
    lastModifiedAt String
    The time at which the data collector was last modified in milliseconds since the epoch.
    name String
    The resource name of the data collector, in the format organizations/{{org_name}}/datacollectors/{{data_collector_id}}.
    orgId String
    The Apigee Organization associated with the Apigee data collector, in the format organizations/{{org_name}}.
    type String
    The type of data this data collector will collect. Possible values are: BOOLEAN, DATETIME, FLOAT, INTEGER, STRING.

    Import

    DataCollector can be imported using any of these accepted formats:

    • {{org_id}}/datacollectors/{{data_collector_id}}
    • {{org_id}}/{{data_collector_id}}

    When using the pulumi import command, DataCollector can be imported using one of the formats above. For example:

    $ pulumi import gcp:apigee/dataCollector:DataCollector default {{org_id}}/datacollectors/{{data_collector_id}}
    $ pulumi import gcp:apigee/dataCollector:DataCollector default {{org_id}}/{{data_collector_id}}
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Viewing docs for Google Cloud v9.24.0
    published on Friday, May 22, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial