FolderSccBigQueryExport class

A Cloud Security Command Center (Cloud SCC) Big Query Export Config. It represents exporting Security Command Center data, including assets, findings, and security marks to a BigQuery instance.

> Note: In order to use Cloud SCC resources, your organization must be enrolled in SCC Standard/Premium. Without doing so, you may run into errors during resource creation.

To get more information about FolderSccBigQueryExport, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Scc Folder Big Query Export Config Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const folder = new gcp.organizations.Folder("folder", {
    parent: "organizations/123456789",
    displayName: "folder-name",
    deletionProtection: false,
});
const _default = new gcp.bigquery.Dataset("default", {
    datasetId: "my_dataset_id",
    friendlyName: "test",
    description: "This is a test description",
    location: "US",
    defaultTableExpirationMs: 3600000,
    defaultPartitionExpirationMs: null,
    labels: {
        env: "default",
    },
});
const customBigQueryExportConfig = new gcp.securitycenter.FolderSccBigQueryExport("custom_big_query_export_config", {
    bigQueryExportId: "my-export",
    folder: folder.folderId,
    dataset: _default.id,
    description: "Cloud Security Command Center Findings Big Query Export Config",
    filter: "state=\"ACTIVE\" AND NOT mute=\"MUTED\"",
});

import pulumi
import pulumi_gcp as gcp

folder = gcp.organizations.Folder("folder",
    parent="organizations/123456789",
    display_name="folder-name",
    deletion_protection=False)
default = gcp.bigquery.Dataset("default",
    dataset_id="my_dataset_id",
    friendly_name="test",
    description="This is a test description",
    location="US",
    default_table_expiration_ms=3600000,
    default_partition_expiration_ms=None,
    labels={
        "env": "default",
    })
custom_big_query_export_config = gcp.securitycenter.FolderSccBigQueryExport("custom_big_query_export_config",
    big_query_export_id="my-export",
    folder=folder.folder_id,
    dataset=default.id,
    description="Cloud Security Command Center Findings Big Query Export Config",
    filter="state=\"ACTIVE\" AND NOT mute=\"MUTED\"")

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

return await Deployment.RunAsync(() =>
{
    var folder = new Gcp.Organizations.Folder("folder", new()
    {
        Parent = "organizations/123456789",
        DisplayName = "folder-name",
        DeletionProtection = false,
    });

    var @default = new Gcp.BigQuery.Dataset("default", new()
    {
        DatasetId = "my_dataset_id",
        FriendlyName = "test",
        Description = "This is a test description",
        Location = "US",
        DefaultTableExpirationMs = 3600000,
        DefaultPartitionExpirationMs = null,
        Labels =
        {
            { "env", "default" },
        },
    });

    var customBigQueryExportConfig = new Gcp.SecurityCenter.FolderSccBigQueryExport("custom_big_query_export_config", new()
    {
        BigQueryExportId = "my-export",
        Folder = folder.FolderId,
        Dataset = @default.Id,
        Description = "Cloud Security Command Center Findings Big Query Export Config",
        Filter = "state=\"ACTIVE\" AND NOT mute=\"MUTED\"",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/bigquery"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/organizations"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/securitycenter"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		folder, err := organizations.NewFolder(ctx, "folder", &organizations.FolderArgs{
			Parent:             pulumi.String("organizations/123456789"),
			DisplayName:        pulumi.String("folder-name"),
			DeletionProtection: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		_default, err := bigquery.NewDataset(ctx, "default", &bigquery.DatasetArgs{
			DatasetId:                    pulumi.String("my_dataset_id"),
			FriendlyName:                 pulumi.String("test"),
			Description:                  pulumi.String("This is a test description"),
			Location:                     pulumi.String("US"),
			DefaultTableExpirationMs:     pulumi.Int(3600000),
			DefaultPartitionExpirationMs: nil,
			Labels: pulumi.StringMap{
				"env": pulumi.String("default"),
			},
		})
		if err != nil {
			return err
		}
		_, err = securitycenter.NewFolderSccBigQueryExport(ctx, "custom_big_query_export_config", &securitycenter.FolderSccBigQueryExportArgs{
			BigQueryExportId: pulumi.String("my-export"),
			Folder:           folder.FolderId,
			Dataset:          _default.ID().ToIDOutput().ToStringOutput(),
			Description:      pulumi.String("Cloud Security Command Center Findings Big Query Export Config"),
			Filter:           pulumi.String("state=\"ACTIVE\" AND NOT mute=\"MUTED\""),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_organizations_folder" "folder" {
  parent              = "organizations/123456789"
  display_name        = "folder-name"
  deletion_protection = false
}
resource "gcp_bigquery_dataset" "default" {
  dataset_id                      = "my_dataset_id"
  friendly_name                   = "test"
  description                     = "This is a test description"
  location                        = "US"
  default_table_expiration_ms     = 3600000
  default_partition_expiration_ms = null
  labels = {
    "env" = "default"
  }
}
resource "gcp_securitycenter_foldersccbigqueryexport" "custom_big_query_export_config" {
  big_query_export_id = "my-export"
  folder              = gcp_organizations_folder.folder.folder_id
  dataset             = gcp_bigquery_dataset.default.id
  description         = "Cloud Security Command Center Findings Big Query Export Config"
  filter              = "state=\"ACTIVE\" AND NOT mute=\"MUTED\""
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.Folder;
import com.pulumi.gcp.organizations.FolderArgs;
import com.pulumi.gcp.bigquery.Dataset;
import com.pulumi.gcp.bigquery.DatasetArgs;
import com.pulumi.gcp.securitycenter.FolderSccBigQueryExport;
import com.pulumi.gcp.securitycenter.FolderSccBigQueryExportArgs;
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 folder = new Folder("folder", FolderArgs.builder()
            .parent("organizations/123456789")
            .displayName("folder-name")
            .deletionProtection(false)
            .build());

        var default_ = new Dataset("default", DatasetArgs.builder()
            .datasetId("my_dataset_id")
            .friendlyName("test")
            .description("This is a test description")
            .location("US")
            .defaultTableExpirationMs(3600000)
            .defaultPartitionExpirationMs(null)
            .labels(Map.of("env", "default"))
            .build());

        var customBigQueryExportConfig = new FolderSccBigQueryExport("customBigQueryExportConfig", FolderSccBigQueryExportArgs.builder()
            .bigQueryExportId("my-export")
            .folder(folder.folderId())
            .dataset(default_.id())
            .description("Cloud Security Command Center Findings Big Query Export Config")
            .filter("state=\"ACTIVE\" AND NOT mute=\"MUTED\"")
            .build());

    }
}

resources:
  folder:
    type: gcp:organizations:Folder
    properties:
      parent: organizations/123456789
      displayName: folder-name
      deletionProtection: false
  default:
    type: gcp:bigquery:Dataset
    properties:
      datasetId: my_dataset_id
      friendlyName: test
      description: This is a test description
      location: US
      defaultTableExpirationMs: 3.6e+06
      defaultPartitionExpirationMs: null
      labels:
        env: default
  customBigQueryExportConfig:
    type: gcp:securitycenter:FolderSccBigQueryExport
    name: custom_big_query_export_config
    properties:
      bigQueryExportId: my-export
      folder: ${folder.folderId}
      dataset: ${default.id}
      description: Cloud Security Command Center Findings Big Query Export Config
      filter: state="ACTIVE" AND NOT mute="MUTED"

Import

FolderSccBigQueryExport can be imported using any of these accepted formats:

• folders/{{folder}}/bigQueryExports/{{big_query_export_id}}
• {{folder}}/{{big_query_export_id}}

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

$ pulumi import gcp:securitycenter/folderSccBigQueryExport:FolderSccBigQueryExport default folders/{{folder}}/bigQueryExports/{{big_query_export_id}}
$ pulumi import gcp:securitycenter/folderSccBigQueryExport:FolderSccBigQueryExport default {{folder}}/{{big_query_export_id}}

Constructors

FolderSccBigQueryExport(String name, {FolderSccBigQueryExportArgs? args, CustomResourceOptions? options})

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

FolderSccBigQueryExport.reference(String urn)

Creates a typed reference to an existing FolderSccBigQueryExport resource.

Properties

bigQueryExportId ↔ Output<String>

This must be unique within the organization.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

The time at which the BigQuery export was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

late, final

dataset ↔ Output<String>

The dataset to write findings' updates to. Its format is "projects/projectId/datasets/bigqueryDatasetId". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).

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>

The description of the export (max of 1024 characters).

late, final

filter ↔ Output<String>

Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators AND and OR. Parentheses are supported, and OR has higher precedence than AND. Restrictions have the form <field> <operator> <value> and may have a - character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are:

late, final

folder ↔ Output<String>

The folder where Cloud Security Command Center Big Query Export Config lives in.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

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

mostRecentEditor ↔ Output<String>

Email address of the user who last edited the BigQuery export.

late, final

name ↔ Output<String>

The resource name of this export, in the format projects/{{project}}/bigQueryExports/{{big_query_export_id}}. This field is provided in responses, and is ignored when provided in create requests.

late, final

principal ↔ Output<String>

The service account that needs permission to create table and upload data to the BigQuery dataset.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updateTime ↔ Output<String>

The most recent time at which the BigQuery export was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

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, {FolderSccBigQueryExportState? state, CustomResourceOptions? options}) → FolderSccBigQueryExport

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