@pulumi/gcp/apigee/dataCollector.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/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:
 *
 * * [API documentation](https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.datacollectors)
 * * How-to Guides
 *     * [Creating a data collector](https://cloud.google.com/apigee/docs/api-platform/analytics/custom-reports)
 *
 * ## Example Usage
 *
 * ### Apigee Data Collector Basic
 *
 * ```typescript
 * 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
 *
 * 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:
 *
 * ```sh
 * $ 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}}
 * ```
 */
export declare class DataCollector extends pulumi.CustomResource {
    /**
     * Get an existing DataCollector resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DataCollectorState, opts?: pulumi.CustomResourceOptions): DataCollector;
    /**
     * Returns true if the given object is an instance of DataCollector.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is DataCollector;
    /**
     * The time at which the data collector was created in milliseconds since the epoch.
     */
    readonly createdAt: pulumi.Output<string>;
    /**
     * The ID for the data collector. Must begin with `dc_`.
     */
    readonly dataCollectorId: pulumi.Output<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.
     */
    readonly deletionPolicy: pulumi.Output<string>;
    /**
     * A description of the data collector.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The time at which the data collector was last modified in milliseconds since the epoch.
     */
    readonly lastModifiedAt: pulumi.Output<string>;
    /**
     * The resource name of the data collector, in the format
     * `organizations/{{org_name}}/datacollectors/{{data_collector_id}}`.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The Apigee Organization associated with the Apigee data collector,
     * in the format `organizations/{{org_name}}`.
     */
    readonly orgId: pulumi.Output<string>;
    /**
     * The type of data this data collector will collect.
     * Possible values are: `BOOLEAN`, `DATETIME`, `FLOAT`, `INTEGER`, `STRING`.
     */
    readonly type: pulumi.Output<string>;
    /**
     * Create a DataCollector resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: DataCollectorArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering DataCollector resources.
 */
export interface DataCollectorState {
    /**
     * The time at which the data collector was created in milliseconds since the epoch.
     */
    createdAt?: pulumi.Input<string | undefined>;
    /**
     * The ID for the data collector. Must begin with `dc_`.
     */
    dataCollectorId?: pulumi.Input<string | undefined>;
    /**
     * 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.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * A description of the data collector.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * The time at which the data collector was last modified in milliseconds since the epoch.
     */
    lastModifiedAt?: pulumi.Input<string | undefined>;
    /**
     * The resource name of the data collector, in the format
     * `organizations/{{org_name}}/datacollectors/{{data_collector_id}}`.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The Apigee Organization associated with the Apigee data collector,
     * in the format `organizations/{{org_name}}`.
     */
    orgId?: pulumi.Input<string | undefined>;
    /**
     * The type of data this data collector will collect.
     * Possible values are: `BOOLEAN`, `DATETIME`, `FLOAT`, `INTEGER`, `STRING`.
     */
    type?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a DataCollector resource.
 */
export interface DataCollectorArgs {
    /**
     * The ID for the data collector. Must begin with `dc_`.
     */
    dataCollectorId: pulumi.Input<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.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * A description of the data collector.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * The Apigee Organization associated with the Apigee data collector,
     * in the format `organizations/{{org_name}}`.
     */
    orgId: pulumi.Input<string>;
    /**
     * The type of data this data collector will collect.
     * Possible values are: `BOOLEAN`, `DATETIME`, `FLOAT`, `INTEGER`, `STRING`.
     */
    type: pulumi.Input<string>;
}
//# sourceMappingURL=dataCollector.d.ts.map