com.pulumi.gcp.securitycenter.kotlin.V2OrganizationSccBigQueryExport.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.securitycenter.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
/**
* Builder for [V2OrganizationSccBigQueryExport].
*/
@PulumiTagMarker
public class V2OrganizationSccBigQueryExportResourceBuilder internal constructor() {
public var name: String? = null
public var args: V2OrganizationSccBigQueryExportArgs = V2OrganizationSccBigQueryExportArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend V2OrganizationSccBigQueryExportArgsBuilder.() -> Unit) {
val builder = V2OrganizationSccBigQueryExportArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): V2OrganizationSccBigQueryExport {
val builtJavaResource =
com.pulumi.gcp.securitycenter.V2OrganizationSccBigQueryExport(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return V2OrganizationSccBigQueryExport(builtJavaResource)
}
}
/**
* A Cloud Security Command Center (Cloud SCC) Big Query Export Config.
* It represents exporting Security Command Center data, including assets, findings, and security marks
* using gcloud scc bqexports
* > **Note:** In order to use Cloud SCC resources, your organization must be enrolled
* in [SCC Standard/Premium](https://cloud.google.com/security-command-center/docs/quickstart-security-command-center).
* Without doing so, you may run into errors during resource creation.
* To get more information about OrganizationSccBigQueryExport, see:
* * [API documentation](https://cloud.google.com/security-command-center/docs/reference/rest/v2/organizations.locations.bigQueryExports)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/security-command-center/docs/how-to-analyze-findings-in-big-query)
* ## Example Usage
* ### Scc V2 Organization Big Query Export Config Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const _default = new gcp.bigquery.Dataset("default", {
* datasetId: "",
* friendlyName: "test",
* description: "This is a test description",
* location: "US",
* defaultTableExpirationMs: 3600000,
* defaultPartitionExpirationMs: undefined,
* labels: {
* env: "default",
* },
* });
* const customBigQueryExportConfig = new gcp.securitycenter.V2OrganizationSccBigQueryExport("custom_big_query_export_config", {
* name: "my-export",
* bigQueryExportId: "my-export",
* organization: "123456789",
* dataset: _default.id,
* location: "global",
* description: "Cloud Security Command Center Findings Big Query Export Config",
* filter: "state=\"ACTIVE\" AND NOT mute=\"MUTED\"",
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* default = gcp.bigquery.Dataset("default",
* 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.V2OrganizationSccBigQueryExport("custom_big_query_export_config",
* name="my-export",
* big_query_export_id="my-export",
* organization="123456789",
* dataset=default.id,
* location="global",
* description="Cloud Security Command Center Findings Big Query Export Config",
* filter="state=\"ACTIVE\" AND NOT mute=\"MUTED\"")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var @default = new Gcp.BigQuery.Dataset("default", new()
* {
* DatasetId = "",
* FriendlyName = "test",
* Description = "This is a test description",
* Location = "US",
* DefaultTableExpirationMs = 3600000,
* DefaultPartitionExpirationMs = null,
* Labels =
* {
* { "env", "default" },
* },
* });
* var customBigQueryExportConfig = new Gcp.SecurityCenter.V2OrganizationSccBigQueryExport("custom_big_query_export_config", new()
* {
* Name = "my-export",
* BigQueryExportId = "my-export",
* Organization = "123456789",
* Dataset = @default.Id,
* Location = "global",
* Description = "Cloud Security Command Center Findings Big Query Export Config",
* Filter = "state=\"ACTIVE\" AND NOT mute=\"MUTED\"",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/bigquery"
* "github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/securitycenter"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := bigquery.NewDataset(ctx, "default", &bigquery.DatasetArgs{
* DatasetId: pulumi.String(""),
* 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.NewV2OrganizationSccBigQueryExport(ctx, "custom_big_query_export_config", &securitycenter.V2OrganizationSccBigQueryExportArgs{
* Name: pulumi.String("my-export"),
* BigQueryExportId: pulumi.String("my-export"),
* Organization: pulumi.String("123456789"),
* Dataset: _default.ID(),
* Location: pulumi.String("global"),
* 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
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.gcp.bigquery.Dataset;
* import com.pulumi.gcp.bigquery.DatasetArgs;
* import com.pulumi.gcp.securitycenter.V2OrganizationSccBigQueryExport;
* import com.pulumi.gcp.securitycenter.V2OrganizationSccBigQueryExportArgs;
* import java.util.List;
* import java.util.ArrayList;
* 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 default_ = new Dataset("default", DatasetArgs.builder()
* .datasetId("")
* .friendlyName("test")
* .description("This is a test description")
* .location("US")
* .defaultTableExpirationMs(3600000)
* .defaultPartitionExpirationMs(null)
* .labels(Map.of("env", "default"))
* .build());
* var customBigQueryExportConfig = new V2OrganizationSccBigQueryExport("customBigQueryExportConfig", V2OrganizationSccBigQueryExportArgs.builder()
* .name("my-export")
* .bigQueryExportId("my-export")
* .organization("123456789")
* .dataset(default_.id())
* .location("global")
* .description("Cloud Security Command Center Findings Big Query Export Config")
* .filter("state=\"ACTIVE\" AND NOT mute=\"MUTED\"")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* default:
* type: gcp:bigquery:Dataset
* properties:
* datasetId: ""
* friendlyName: test
* description: This is a test description
* location: US
* defaultTableExpirationMs: 3.6e+06
* defaultPartitionExpirationMs: null
* labels:
* env: default
* customBigQueryExportConfig:
* type: gcp:securitycenter:V2OrganizationSccBigQueryExport
* name: custom_big_query_export_config
* properties:
* name: my-export
* bigQueryExportId: my-export
* organization: '123456789'
* dataset: ${default.id}
* location: global
* description: Cloud Security Command Center Findings Big Query Export Config
* filter: state="ACTIVE" AND NOT mute="MUTED"
* ```
*
* ## Import
* OrganizationSccBigQueryExport can be imported using any of these accepted formats:
* * `organizations/{{organization}}/locations/{{location}}/bigQueryExports/{{big_query_export_id}}`
* * `{{organization}}/{{location}}/{{big_query_export_id}}`
* When using the `pulumi import` command, OrganizationSccBigQueryExport can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:securitycenter/v2OrganizationSccBigQueryExport:V2OrganizationSccBigQueryExport default organizations/{{organization}}/locations/{{location}}/bigQueryExports/{{big_query_export_id}}
* ```
* ```sh
* $ pulumi import gcp:securitycenter/v2OrganizationSccBigQueryExport:V2OrganizationSccBigQueryExport default {{organization}}/{{location}}/{{big_query_export_id}}
* ```
*/
public class V2OrganizationSccBigQueryExport internal constructor(
override val javaResource: com.pulumi.gcp.securitycenter.V2OrganizationSccBigQueryExport,
) : KotlinCustomResource(javaResource, V2OrganizationSccBigQueryExportMapper) {
/**
* This must be unique within the organization.
* - - -
*/
public val bigQueryExportId: Output
get() = javaResource.bigQueryExportId().applyValue({ args0 -> args0 })
/**
* The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation.
* 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".
*/
public val createTime: Output
get() = javaResource.createTime().applyValue({ args0 -> args0 })
/**
* The dataset to write findings' updates to.
* Its format is "projects/[projectId]/datasets/[bigquery_dataset_id]".
* BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).
*/
public val dataset: Output?
get() = javaResource.dataset().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The description of the notification config (max of 1024 characters).
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* 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 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:
* * = for all value types.
* * >, <, >=, <= for integer values.
* * :, meaning substring matching, for strings.
* The supported value types are:
* * string literals in quotes.
* * integer literals without quotes.
* * boolean literals true and false without quotes.
* See
* [Filtering notifications](https://cloud.google.com/security-command-center/docs/how-to-api-filter-notifications)
* for information on how to write a filter.
*/
public val filter: Output?
get() = javaResource.filter().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* location Id is provided by organization. If not provided, Use global as default.
*/
public val location: Output?
get() = javaResource.location().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Email address of the user who last edited the BigQuery export.
* This field is set by the server and will be ignored if provided on export creation or update.
*/
public val mostRecentEditor: Output
get() = javaResource.mostRecentEditor().applyValue({ args0 -> args0 })
/**
* The resource name of this export, in the format
* `organizations/{{organization}}/locations/{{location}}/bigQueryExports/{{big_query_export_id}}`.
* This field is provided in responses, and is ignored when provided in create requests.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The organization whose Cloud Security Command Center the Big Query Export
* Config lives in.
*/
public val organization: Output
get() = javaResource.organization().applyValue({ args0 -> args0 })
/**
* The service account that needs permission to create table and upload data to the BigQuery dataset.
*/
public val principal: Output
get() = javaResource.principal().applyValue({ args0 -> args0 })
/**
* The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update.
* 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".
*/
public val updateTime: Output
get() = javaResource.updateTime().applyValue({ args0 -> args0 })
}
public object V2OrganizationSccBigQueryExportMapper :
ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.securitycenter.V2OrganizationSccBigQueryExport::class == javaResource::class
override fun map(javaResource: Resource): V2OrganizationSccBigQueryExport =
V2OrganizationSccBigQueryExport(
javaResource as
com.pulumi.gcp.securitycenter.V2OrganizationSccBigQueryExport,
)
}
/**
* @see [V2OrganizationSccBigQueryExport].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [V2OrganizationSccBigQueryExport].
*/
public suspend fun v2OrganizationSccBigQueryExport(
name: String,
block: suspend V2OrganizationSccBigQueryExportResourceBuilder.() -> Unit,
): V2OrganizationSccBigQueryExport {
val builder = V2OrganizationSccBigQueryExportResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [V2OrganizationSccBigQueryExport].
* @param name The _unique_ name of the resulting resource.
*/
public fun v2OrganizationSccBigQueryExport(name: String): V2OrganizationSccBigQueryExport {
val builder = V2OrganizationSccBigQueryExportResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy