InsightsDatasetConfig class

Represents a Storage Insights DatasetConfig.

To get more information about DatasetConfig, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Storage Insights Dataset Config Includes

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",
            },
        ],
    },
});

import pulumi
import pulumi_gcp as gcp

config_includes = gcp.storage.InsightsDatasetConfig("config_includes",
    location="us-central1",
    dataset_config_id="my_config_includes",
    retention_period_days=1,
    source_projects={
        "project_numbers": [
            "123",
            "456",
            "789",
        ],
    },
    identity={
        "type": "IDENTITY_TYPE_PER_CONFIG",
    },
    description="Sample Description",
    link_dataset=False,
    include_newly_created_buckets=True,
    include_cloud_storage_locations={
        "locations": ["us-east1"],
    },
    include_cloud_storage_buckets={
        "cloud_storage_buckets": [
            {
                "bucket_name": "sample-bucket",
            },
            {
                "bucket_name": "sample-regex",
            },
        ],
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var configIncludes = new Gcp.Storage.InsightsDatasetConfig("config_includes", new()
    {
        Location = "us-central1",
        DatasetConfigId = "my_config_includes",
        RetentionPeriodDays = 1,
        SourceProjects = new Gcp.Storage.Inputs.InsightsDatasetConfigSourceProjectsArgs
        {
            ProjectNumbers = new[]
            {
                "123",
                "456",
                "789",
            },
        },
        Identity = new Gcp.Storage.Inputs.InsightsDatasetConfigIdentityArgs
        {
            Type = "IDENTITY_TYPE_PER_CONFIG",
        },
        Description = "Sample Description",
        LinkDataset = false,
        IncludeNewlyCreatedBuckets = true,
        IncludeCloudStorageLocations = new Gcp.Storage.Inputs.InsightsDatasetConfigIncludeCloudStorageLocationsArgs
        {
            Locations = new[]
            {
                "us-east1",
            },
        },
        IncludeCloudStorageBuckets = new Gcp.Storage.Inputs.InsightsDatasetConfigIncludeCloudStorageBucketsArgs
        {
            CloudStorageBuckets = new[]
            {
                new Gcp.Storage.Inputs.InsightsDatasetConfigIncludeCloudStorageBucketsCloudStorageBucketArgs
                {
                    BucketName = "sample-bucket",
                },
                new Gcp.Storage.Inputs.InsightsDatasetConfigIncludeCloudStorageBucketsCloudStorageBucketArgs
                {
                    BucketName = "sample-regex",
                },
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storage.NewInsightsDatasetConfig(ctx, "config_includes", &storage.InsightsDatasetConfigArgs{
			Location:            pulumi.String("us-central1"),
			DatasetConfigId:     pulumi.String("my_config_includes"),
			RetentionPeriodDays: pulumi.Int(1),
			SourceProjects: &storage.InsightsDatasetConfigSourceProjectsArgs{
				ProjectNumbers: pulumi.StringArray{
					pulumi.String("123"),
					pulumi.String("456"),
					pulumi.String("789"),
				},
			},
			Identity: &storage.InsightsDatasetConfigIdentityArgs{
				Type: pulumi.String("IDENTITY_TYPE_PER_CONFIG"),
			},
			Description:                pulumi.String("Sample Description"),
			LinkDataset:                pulumi.Bool(false),
			IncludeNewlyCreatedBuckets: pulumi.Bool(true),
			IncludeCloudStorageLocations: &storage.InsightsDatasetConfigIncludeCloudStorageLocationsArgs{
				Locations: pulumi.StringArray{
					pulumi.String("us-east1"),
				},
			},
			IncludeCloudStorageBuckets: &storage.InsightsDatasetConfigIncludeCloudStorageBucketsArgs{
				CloudStorageBuckets: storage.InsightsDatasetConfigIncludeCloudStorageBucketsCloudStorageBucketArray{
					&storage.InsightsDatasetConfigIncludeCloudStorageBucketsCloudStorageBucketArgs{
						BucketName: pulumi.String("sample-bucket"),
					},
					&storage.InsightsDatasetConfigIncludeCloudStorageBucketsCloudStorageBucketArgs{
						BucketName: pulumi.String("sample-regex"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_storage_insightsdatasetconfig" "config_includes" {
  location              = "us-central1"
  dataset_config_id     = "my_config_includes"
  retention_period_days = 1
  source_projects = {
    project_numbers = ["123", "456", "789"]
  }
  identity = {
    type = "IDENTITY_TYPE_PER_CONFIG"
  }
  description                   = "Sample Description"
  link_dataset                  = false
  include_newly_created_buckets = true
  include_cloud_storage_locations = {
    locations = ["us-east1"]
  }
  include_cloud_storage_buckets = {
    cloud_storage_buckets = [{
      "bucketName" = "sample-bucket"
      }, {
      "bucketName" = "sample-regex"
    }]
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.storage.InsightsDatasetConfig;
import com.pulumi.gcp.storage.InsightsDatasetConfigArgs;
import com.pulumi.gcp.storage.inputs.InsightsDatasetConfigSourceProjectsArgs;
import com.pulumi.gcp.storage.inputs.InsightsDatasetConfigIdentityArgs;
import com.pulumi.gcp.storage.inputs.InsightsDatasetConfigIncludeCloudStorageLocationsArgs;
import com.pulumi.gcp.storage.inputs.InsightsDatasetConfigIncludeCloudStorageBucketsArgs;
import com.pulumi.gcp.storage.inputs.InsightsDatasetConfigIncludeCloudStorageBucketsCloudStorageBucketArgs;
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) {
        var configIncludes = new InsightsDatasetConfig("configIncludes", InsightsDatasetConfigArgs.builder()
            .location("us-central1")
            .datasetConfigId("my_config_includes")
            .retentionPeriodDays(1)
            .sourceProjects(InsightsDatasetConfigSourceProjectsArgs.builder()
                .projectNumbers(
                    "123",
                    "456",
                    "789")
                .build())
            .identity(InsightsDatasetConfigIdentityArgs.builder()
                .type("IDENTITY_TYPE_PER_CONFIG")
                .build())
            .description("Sample Description")
            .linkDataset(false)
            .includeNewlyCreatedBuckets(true)
            .includeCloudStorageLocations(InsightsDatasetConfigIncludeCloudStorageLocationsArgs.builder()
                .locations("us-east1")
                .build())
            .includeCloudStorageBuckets(InsightsDatasetConfigIncludeCloudStorageBucketsArgs.builder()
                .cloudStorageBuckets(
                    InsightsDatasetConfigIncludeCloudStorageBucketsCloudStorageBucketArgs.builder()
                        .bucketName("sample-bucket")
                        .build(),
                    InsightsDatasetConfigIncludeCloudStorageBucketsCloudStorageBucketArgs.builder()
                        .bucketName("sample-regex")
                        .build())
                .build())
            .build());

    }
}

resources:
  configIncludes:
    type: gcp:storage:InsightsDatasetConfig
    name: config_includes
    properties:
      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

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 pulumi
import pulumi_gcp as gcp

config_excludes = gcp.storage.InsightsDatasetConfig("config_excludes",
    location="us-central1",
    dataset_config_id="my_config_excludes",
    retention_period_days=1,
    activity_data_retention_period_days=2,
    organization_scope=True,
    identity={
        "type": "IDENTITY_TYPE_PER_PROJECT",
    },
    exclude_cloud_storage_locations={
        "locations": ["us-east1"],
    },
    exclude_cloud_storage_buckets={
        "cloud_storage_buckets": [
            {
                "bucket_name": "sample-bucket",
            },
            {
                "bucket_name": "sample-regex",
            },
        ],
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var configExcludes = new Gcp.Storage.InsightsDatasetConfig("config_excludes", new()
    {
        Location = "us-central1",
        DatasetConfigId = "my_config_excludes",
        RetentionPeriodDays = 1,
        ActivityDataRetentionPeriodDays = 2,
        OrganizationScope = true,
        Identity = new Gcp.Storage.Inputs.InsightsDatasetConfigIdentityArgs
        {
            Type = "IDENTITY_TYPE_PER_PROJECT",
        },
        ExcludeCloudStorageLocations = new Gcp.Storage.Inputs.InsightsDatasetConfigExcludeCloudStorageLocationsArgs
        {
            Locations = new[]
            {
                "us-east1",
            },
        },
        ExcludeCloudStorageBuckets = new Gcp.Storage.Inputs.InsightsDatasetConfigExcludeCloudStorageBucketsArgs
        {
            CloudStorageBuckets = new[]
            {
                new Gcp.Storage.Inputs.InsightsDatasetConfigExcludeCloudStorageBucketsCloudStorageBucketArgs
                {
                    BucketName = "sample-bucket",
                },
                new Gcp.Storage.Inputs.InsightsDatasetConfigExcludeCloudStorageBucketsCloudStorageBucketArgs
                {
                    BucketName = "sample-regex",
                },
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storage.NewInsightsDatasetConfig(ctx, "config_excludes", &storage.InsightsDatasetConfigArgs{
			Location:                        pulumi.String("us-central1"),
			DatasetConfigId:                 pulumi.String("my_config_excludes"),
			RetentionPeriodDays:             pulumi.Int(1),
			ActivityDataRetentionPeriodDays: pulumi.Int(2),
			OrganizationScope:               pulumi.Bool(true),
			Identity: &storage.InsightsDatasetConfigIdentityArgs{
				Type: pulumi.String("IDENTITY_TYPE_PER_PROJECT"),
			},
			ExcludeCloudStorageLocations: &storage.InsightsDatasetConfigExcludeCloudStorageLocationsArgs{
				Locations: pulumi.StringArray{
					pulumi.String("us-east1"),
				},
			},
			ExcludeCloudStorageBuckets: &storage.InsightsDatasetConfigExcludeCloudStorageBucketsArgs{
				CloudStorageBuckets: storage.InsightsDatasetConfigExcludeCloudStorageBucketsCloudStorageBucketArray{
					&storage.InsightsDatasetConfigExcludeCloudStorageBucketsCloudStorageBucketArgs{
						BucketName: pulumi.String("sample-bucket"),
					},
					&storage.InsightsDatasetConfigExcludeCloudStorageBucketsCloudStorageBucketArgs{
						BucketName: pulumi.String("sample-regex"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_storage_insightsdatasetconfig" "config_excludes" {
  location                            = "us-central1"
  dataset_config_id                   = "my_config_excludes"
  retention_period_days               = 1
  activity_data_retention_period_days = 2
  organization_scope                  = true
  identity = {
    type = "IDENTITY_TYPE_PER_PROJECT"
  }
  exclude_cloud_storage_locations = {
    locations = ["us-east1"]
  }
  exclude_cloud_storage_buckets = {
    cloud_storage_buckets = [{
      "bucketName" = "sample-bucket"
      }, {
      "bucketName" = "sample-regex"
    }]
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.storage.InsightsDatasetConfig;
import com.pulumi.gcp.storage.InsightsDatasetConfigArgs;
import com.pulumi.gcp.storage.inputs.InsightsDatasetConfigIdentityArgs;
import com.pulumi.gcp.storage.inputs.InsightsDatasetConfigExcludeCloudStorageLocationsArgs;
import com.pulumi.gcp.storage.inputs.InsightsDatasetConfigExcludeCloudStorageBucketsArgs;
import com.pulumi.gcp.storage.inputs.InsightsDatasetConfigExcludeCloudStorageBucketsCloudStorageBucketArgs;
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) {
        var configExcludes = new InsightsDatasetConfig("configExcludes", InsightsDatasetConfigArgs.builder()
            .location("us-central1")
            .datasetConfigId("my_config_excludes")
            .retentionPeriodDays(1)
            .activityDataRetentionPeriodDays(2)
            .organizationScope(true)
            .identity(InsightsDatasetConfigIdentityArgs.builder()
                .type("IDENTITY_TYPE_PER_PROJECT")
                .build())
            .excludeCloudStorageLocations(InsightsDatasetConfigExcludeCloudStorageLocationsArgs.builder()
                .locations("us-east1")
                .build())
            .excludeCloudStorageBuckets(InsightsDatasetConfigExcludeCloudStorageBucketsArgs.builder()
                .cloudStorageBuckets(
                    InsightsDatasetConfigExcludeCloudStorageBucketsCloudStorageBucketArgs.builder()
                        .bucketName("sample-bucket")
                        .build(),
                    InsightsDatasetConfigExcludeCloudStorageBucketsCloudStorageBucketArgs.builder()
                        .bucketName("sample-regex")
                        .build())
                .build())
            .build());

    }
}

resources:
  configExcludes:
    type: gcp:storage:InsightsDatasetConfig
    name: config_excludes
    properties:
      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:

$ 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}}

Constructors

InsightsDatasetConfig(String name, {InsightsDatasetConfigArgs? args, CustomResourceOptions? options})

Creates a new InsightsDatasetConfig. name The Pulumi resource name. args Arguments used to configure this InsightsDatasetConfig. The set of arguments for InsightsDatasetConfig. options Resource options controlling this resource's behavior.

InsightsDatasetConfig.reference(String urn)

Creates a typed reference to an existing InsightsDatasetConfig resource.

Properties

activityDataRetentionPeriodDays ↔ Output<int>

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.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

The UTC time at which the DatasetConfig was created. This is auto-populated.

late, final

datasetConfigId ↔ Output<String>

The user-defined ID of the DatasetConfig

late, final

datasetConfigState ↔ Output<String>

State of the DatasetConfig.

late, final

deletionPolicy ↔ 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.

late, final

description ↔ Output<String?>

An optional user-provided description for the dataset configuration with a maximum length of 256 characters.

late, final

excludeCloudStorageBuckets ↔ Output<InsightsDatasetConfigExcludeCloudStorageBuckets?>

Defined the options for excluding cloud storage buckets for the DatasetConfig. Structure is documented below.

late, final

excludeCloudStorageLocations ↔ Output<InsightsDatasetConfigExcludeCloudStorageLocations?>

Defines the options for excluding cloud storage locations for the DatasetConfig. Structure is documented below.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

identity ↔ Output<InsightsDatasetConfigIdentity>

Identity used by DatasetConfig. Structure is documented below.

late, final

includeCloudStorageBuckets ↔ Output<InsightsDatasetConfigIncludeCloudStorageBuckets?>

Defines the options for including cloud storage buckets for the DatasetConfig. Structure is documented below.

late, final

includeCloudStorageLocations ↔ Output<InsightsDatasetConfigIncludeCloudStorageLocations?>

Defines the options for including cloud storage locations for the DatasetConfig. Structure is documented below.

late, final

includeNewlyCreatedBuckets ↔ Output<bool?>

If set to true, the request includes all the newly created buckets in the dataset that meet the inclusion and exclusion rules.

late, final

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

linkDataset ↔ Output<bool?>

A boolean terraform only flag to link/unlink dataset.

late, final

links ↔ Output<List<InsightsDatasetConfigLink>>

Details of the linked DatasetConfig. Structure is documented below.

late, final

location ↔ Output<String>

The location of the DatasetConfig.

late, final

name ↔ Output<String>

The full canonical resource name of the DatasetConfig (e.g., projects/P/locations/L/datasetConfigs/ID).

late, final

organizationNumber ↔ Output<String>

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.

late, final

organizationScope ↔ Output<bool?>

Defines the options for providing a source organization for the DatasetConfig.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

retentionPeriodDays ↔ Output<int>

Number of days of history that must be retained.

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sourceFolders ↔ Output<InsightsDatasetConfigSourceFolders?>

Defines the options for providing source folders for the DatasetConfig. Structure is documented below.

late, final

sourceProjects ↔ Output<InsightsDatasetConfigSourceProjects?>

Defines the options for providing source projects for the DatasetConfig. Structure is documented below.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

uid ↔ Output<String>

System generated unique identifier for the resource.

late, final

updateTime ↔ Output<String>

The UTC time at which the DatasetConfig was updated. This is auto-populated.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {InsightsDatasetConfigState? state, CustomResourceOptions? options}) → InsightsDatasetConfig

Gets an existing InsightsDatasetConfig resource's state with the given name and id.