import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Represents a Storage Insights DatasetConfig. * * To get more information about DatasetConfig, see: * * * [API documentation](https://cloud.google.com/storage/docs/insights/reference/rest/v1/projects.locations.datasetConfigs) * * How-to Guides * * [Official Documentation](https://cloud.google.com/storage/docs/insights/datasets) * * ## Example Usage * * ### Storage Insights Dataset Config Includes * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const configIncludes = new gcp.storage.InsightsDatasetConfig("config_includes", { * location: "us-central1", * datasetConfigId: "my_config_includes", * retentionPeriodDays: 1, * sourceProjects: { * projectNumbers: [ * "123", * "456", * "789", * ], * }, * identity: { * type: "IDENTITY_TYPE_PER_CONFIG", * }, * description: "Sample Description", * linkDataset: false, * includeNewlyCreatedBuckets: true, * includeCloudStorageLocations: { * locations: ["us-east1"], * }, * includeCloudStorageBuckets: { * cloudStorageBuckets: [ * { * bucketName: "sample-bucket", * }, * { * bucketName: "sample-regex", * }, * ], * }, * }); * ``` * ### Storage Insights Dataset Config Excludes * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const configExcludes = new gcp.storage.InsightsDatasetConfig("config_excludes", { * location: "us-central1", * datasetConfigId: "my_config_excludes", * retentionPeriodDays: 1, * activityDataRetentionPeriodDays: 2, * organizationScope: true, * identity: { * type: "IDENTITY_TYPE_PER_PROJECT", * }, * excludeCloudStorageLocations: { * locations: ["us-east1"], * }, * excludeCloudStorageBuckets: { * cloudStorageBuckets: [ * { * bucketName: "sample-bucket", * }, * { * bucketName: "sample-regex", * }, * ], * }, * }); * ``` * * ## Import * * DatasetConfig can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/datasetConfigs/{{dataset_config_id}}` * * `{{project}}/{{location}}/{{dataset_config_id}}` * * `{{location}}/{{dataset_config_id}}` * * When using the `pulumi import` command, DatasetConfig can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:storage/insightsDatasetConfig:InsightsDatasetConfig default projects/{{project}}/locations/{{location}}/datasetConfigs/{{dataset_config_id}} * $ pulumi import gcp:storage/insightsDatasetConfig:InsightsDatasetConfig default {{project}}/{{location}}/{{dataset_config_id}} * $ pulumi import gcp:storage/insightsDatasetConfig:InsightsDatasetConfig default {{location}}/{{dataset_config_id}} * ``` */ export declare class InsightsDatasetConfig extends pulumi.CustomResource { /** * Get an existing InsightsDatasetConfig 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, state?: InsightsDatasetConfigState, opts?: pulumi.CustomResourceOptions): InsightsDatasetConfig; /** * Returns true if the given object is an instance of InsightsDatasetConfig. 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 InsightsDatasetConfig; /** * Number of days of activity data that must be retained. If not specified, retentionPeriodDays will be used. Set to 0 to turn off the activity data. */ readonly activityDataRetentionPeriodDays: pulumi.Output; /** * The UTC time at which the DatasetConfig was created. This is auto-populated. */ readonly createTime: pulumi.Output; /** * The user-defined ID of the DatasetConfig */ readonly datasetConfigId: pulumi.Output; /** * State of the DatasetConfig. */ readonly datasetConfigState: pulumi.Output; /** * 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; /** * An optional user-provided description for the dataset configuration with a maximum length of 256 characters. */ readonly description: pulumi.Output; /** * Defined the options for excluding cloud storage buckets for the DatasetConfig. * Structure is documented below. */ readonly excludeCloudStorageBuckets: pulumi.Output; /** * Defines the options for excluding cloud storage locations for the DatasetConfig. * Structure is documented below. */ readonly excludeCloudStorageLocations: pulumi.Output; /** * Identity used by DatasetConfig. * Structure is documented below. */ readonly identity: pulumi.Output; /** * Defines the options for including cloud storage buckets for the DatasetConfig. * Structure is documented below. */ readonly includeCloudStorageBuckets: pulumi.Output; /** * Defines the options for including cloud storage locations for the DatasetConfig. * Structure is documented below. */ readonly includeCloudStorageLocations: pulumi.Output; /** * If set to true, the request includes all the newly created buckets in the dataset that meet the inclusion and exclusion rules. */ readonly includeNewlyCreatedBuckets: pulumi.Output; /** * A boolean terraform only flag to link/unlink dataset. * * Setting this field to true while creation will automatically link the created dataset as an additional functionality. * > **Note** A dataset config resource can only be destroyed once it is unlinked, * so users must set this field to false to unlink the dataset and destroy the dataset config resource. */ readonly linkDataset: pulumi.Output; /** * Details of the linked DatasetConfig. * Structure is documented below. */ readonly links: pulumi.Output; /** * The location of the DatasetConfig. */ readonly location: pulumi.Output; /** * The full canonical resource name of the DatasetConfig (e.g., projects/P/locations/L/datasetConfigs/ID). */ readonly name: pulumi.Output; /** * Organization resource ID that the source projects should belong to. * Projects that do not belong to the provided organization are not considered when creating the dataset. */ readonly organizationNumber: pulumi.Output; /** * Defines the options for providing a source organization for the DatasetConfig. */ readonly organizationScope: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * Number of days of history that must be retained. */ readonly retentionPeriodDays: pulumi.Output; /** * Defines the options for providing source folders for the DatasetConfig. * Structure is documented below. */ readonly sourceFolders: pulumi.Output; /** * Defines the options for providing source projects for the DatasetConfig. * Structure is documented below. */ readonly sourceProjects: pulumi.Output; /** * System generated unique identifier for the resource. */ readonly uid: pulumi.Output; /** * The UTC time at which the DatasetConfig was updated. This is auto-populated. */ readonly updateTime: pulumi.Output; /** * Create a InsightsDatasetConfig 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: InsightsDatasetConfigArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering InsightsDatasetConfig resources. */ export interface InsightsDatasetConfigState { /** * Number of days of activity data that must be retained. If not specified, retentionPeriodDays will be used. Set to 0 to turn off the activity data. */ activityDataRetentionPeriodDays?: pulumi.Input; /** * The UTC time at which the DatasetConfig was created. This is auto-populated. */ createTime?: pulumi.Input; /** * The user-defined ID of the DatasetConfig */ datasetConfigId?: pulumi.Input; /** * State of the DatasetConfig. */ datasetConfigState?: pulumi.Input; /** * 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; /** * An optional user-provided description for the dataset configuration with a maximum length of 256 characters. */ description?: pulumi.Input; /** * Defined the options for excluding cloud storage buckets for the DatasetConfig. * Structure is documented below. */ excludeCloudStorageBuckets?: pulumi.Input; /** * Defines the options for excluding cloud storage locations for the DatasetConfig. * Structure is documented below. */ excludeCloudStorageLocations?: pulumi.Input; /** * Identity used by DatasetConfig. * Structure is documented below. */ identity?: pulumi.Input; /** * Defines the options for including cloud storage buckets for the DatasetConfig. * Structure is documented below. */ includeCloudStorageBuckets?: pulumi.Input; /** * Defines the options for including cloud storage locations for the DatasetConfig. * Structure is documented below. */ includeCloudStorageLocations?: pulumi.Input; /** * If set to true, the request includes all the newly created buckets in the dataset that meet the inclusion and exclusion rules. */ includeNewlyCreatedBuckets?: pulumi.Input; /** * A boolean terraform only flag to link/unlink dataset. * * Setting this field to true while creation will automatically link the created dataset as an additional functionality. * > **Note** A dataset config resource can only be destroyed once it is unlinked, * so users must set this field to false to unlink the dataset and destroy the dataset config resource. */ linkDataset?: pulumi.Input; /** * Details of the linked DatasetConfig. * Structure is documented below. */ links?: pulumi.Input[] | undefined>; /** * The location of the DatasetConfig. */ location?: pulumi.Input; /** * The full canonical resource name of the DatasetConfig (e.g., projects/P/locations/L/datasetConfigs/ID). */ name?: pulumi.Input; /** * Organization resource ID that the source projects should belong to. * Projects that do not belong to the provided organization are not considered when creating the dataset. */ organizationNumber?: pulumi.Input; /** * Defines the options for providing a source organization for the DatasetConfig. */ organizationScope?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * Number of days of history that must be retained. */ retentionPeriodDays?: pulumi.Input; /** * Defines the options for providing source folders for the DatasetConfig. * Structure is documented below. */ sourceFolders?: pulumi.Input; /** * Defines the options for providing source projects for the DatasetConfig. * Structure is documented below. */ sourceProjects?: pulumi.Input; /** * System generated unique identifier for the resource. */ uid?: pulumi.Input; /** * The UTC time at which the DatasetConfig was updated. This is auto-populated. */ updateTime?: pulumi.Input; } /** * The set of arguments for constructing a InsightsDatasetConfig resource. */ export interface InsightsDatasetConfigArgs { /** * Number of days of activity data that must be retained. If not specified, retentionPeriodDays will be used. Set to 0 to turn off the activity data. */ activityDataRetentionPeriodDays?: pulumi.Input; /** * The user-defined ID of the DatasetConfig */ datasetConfigId: pulumi.Input; /** * 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; /** * An optional user-provided description for the dataset configuration with a maximum length of 256 characters. */ description?: pulumi.Input; /** * Defined the options for excluding cloud storage buckets for the DatasetConfig. * Structure is documented below. */ excludeCloudStorageBuckets?: pulumi.Input; /** * Defines the options for excluding cloud storage locations for the DatasetConfig. * Structure is documented below. */ excludeCloudStorageLocations?: pulumi.Input; /** * Identity used by DatasetConfig. * Structure is documented below. */ identity: pulumi.Input; /** * Defines the options for including cloud storage buckets for the DatasetConfig. * Structure is documented below. */ includeCloudStorageBuckets?: pulumi.Input; /** * Defines the options for including cloud storage locations for the DatasetConfig. * Structure is documented below. */ includeCloudStorageLocations?: pulumi.Input; /** * If set to true, the request includes all the newly created buckets in the dataset that meet the inclusion and exclusion rules. */ includeNewlyCreatedBuckets?: pulumi.Input; /** * A boolean terraform only flag to link/unlink dataset. * * Setting this field to true while creation will automatically link the created dataset as an additional functionality. * > **Note** A dataset config resource can only be destroyed once it is unlinked, * so users must set this field to false to unlink the dataset and destroy the dataset config resource. */ linkDataset?: pulumi.Input; /** * The location of the DatasetConfig. */ location: pulumi.Input; /** * Organization resource ID that the source projects should belong to. * Projects that do not belong to the provided organization are not considered when creating the dataset. */ organizationNumber?: pulumi.Input; /** * Defines the options for providing a source organization for the DatasetConfig. */ organizationScope?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * Number of days of history that must be retained. */ retentionPeriodDays: pulumi.Input; /** * Defines the options for providing source folders for the DatasetConfig. * Structure is documented below. */ sourceFolders?: pulumi.Input; /** * Defines the options for providing source projects for the DatasetConfig. * Structure is documented below. */ sourceProjects?: pulumi.Input; } //# sourceMappingURL=insightsDatasetConfig.d.ts.map