com.pulumi.gcp.securitycenter.kotlin.ProjectSccBigQueryExportArgs.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 8.13.1.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.securitycenter.kotlin

import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.securitycenter.ProjectSccBigQueryExportArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName

/**
 * 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 ProjectSccBigQueryExport, see:
 * * [API documentation](https://cloud.google.com/security-command-center/docs/reference/rest/v1/projects.bigQueryExports)
 * * How-to Guides
 *     * [Official Documentation](https://cloud.google.com/security-command-center/docs/how-to-analyze-findings-in-big-query)
 * ## Example Usage
 * ### Scc Project Big Query Export Config Basic
 * 
 * ```yaml
 * resources:
 *   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:ProjectSccBigQueryExport
 *     name: custom_big_query_export_config
 *     properties:
 *       name: my-export
 *       bigQueryExportId: my-export
 *       project: my-project-name
 *       dataset: ${default.id}
 *       description: Cloud Security Command Center Findings Big Query Export Config
 *       filter: state="ACTIVE" AND NOT mute="MUTED"
 * ```
 * 
 * ## Import
 * ProjectSccBigQueryExport can be imported using any of these accepted formats:
 * * `projects/{{project}}/bigQueryExports/{{big_query_export_id}}`
 * * `{{project}}/{{big_query_export_id}}`
 * * `{{big_query_export_id}}`
 * When using the `pulumi import` command, ProjectSccBigQueryExport can be imported using one of the formats above. For example:
 * ```sh
 * $ pulumi import gcp:securitycenter/projectSccBigQueryExport:ProjectSccBigQueryExport default projects/{{project}}/bigQueryExports/{{big_query_export_id}}
 * ```
 * ```sh
 * $ pulumi import gcp:securitycenter/projectSccBigQueryExport:ProjectSccBigQueryExport default {{project}}/{{big_query_export_id}}
 * ```
 * ```sh
 * $ pulumi import gcp:securitycenter/projectSccBigQueryExport:ProjectSccBigQueryExport default {{big_query_export_id}}
 * ```
 * @property bigQueryExportId This must be unique within the organization.
 * - - -
 * @property dataset 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 (_).
 * @property description The description of the notification config (max of 1024 characters).
 * @property filter 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.
 * @property project The ID of the project in which the resource belongs.
 * If it is not provided, the provider project is used.
 */
public data class ProjectSccBigQueryExportArgs(
    public val bigQueryExportId: Output? = null,
    public val dataset: Output? = null,
    public val description: Output? = null,
    public val filter: Output? = null,
    public val project: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.gcp.securitycenter.ProjectSccBigQueryExportArgs =
        com.pulumi.gcp.securitycenter.ProjectSccBigQueryExportArgs.builder()
            .bigQueryExportId(bigQueryExportId?.applyValue({ args0 -> args0 }))
            .dataset(dataset?.applyValue({ args0 -> args0 }))
            .description(description?.applyValue({ args0 -> args0 }))
            .filter(filter?.applyValue({ args0 -> args0 }))
            .project(project?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [ProjectSccBigQueryExportArgs].
 */
@PulumiTagMarker
public class ProjectSccBigQueryExportArgsBuilder internal constructor() {
    private var bigQueryExportId: Output? = null

    private var dataset: Output? = null

    private var description: Output? = null

    private var filter: Output? = null

    private var project: Output? = null

    /**
     * @param value This must be unique within the organization.
     * - - -
     */
    @JvmName("fkppxblqqdunfreb")
    public suspend fun bigQueryExportId(`value`: Output) {
        this.bigQueryExportId = value
    }

    /**
     * @param value 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 (_).
     */
    @JvmName("snyhbfeflymtrbpg")
    public suspend fun dataset(`value`: Output) {
        this.dataset = value
    }

    /**
     * @param value The description of the notification config (max of 1024 characters).
     */
    @JvmName("rclprcccwmcxbdpu")
    public suspend fun description(`value`: Output) {
        this.description = value
    }

    /**
     * @param value 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.
     */
    @JvmName("jepsbavxhgfhqilx")
    public suspend fun filter(`value`: Output) {
        this.filter = value
    }

    /**
     * @param value The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    @JvmName("ddnhkojaqjqerqex")
    public suspend fun project(`value`: Output) {
        this.project = value
    }

    /**
     * @param value This must be unique within the organization.
     * - - -
     */
    @JvmName("bevpvihdvfstusfd")
    public suspend fun bigQueryExportId(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.bigQueryExportId = mapped
    }

    /**
     * @param value 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 (_).
     */
    @JvmName("mjwybeoxcjadfdnb")
    public suspend fun dataset(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.dataset = mapped
    }

    /**
     * @param value The description of the notification config (max of 1024 characters).
     */
    @JvmName("bwbjaxejgpsmwhlx")
    public suspend fun description(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.description = mapped
    }

    /**
     * @param value 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.
     */
    @JvmName("vkcgajvvkqlfkdbt")
    public suspend fun filter(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.filter = mapped
    }

    /**
     * @param value The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    @JvmName("ptonylxywmkxridh")
    public suspend fun project(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.project = mapped
    }

    internal fun build(): ProjectSccBigQueryExportArgs = ProjectSccBigQueryExportArgs(
        bigQueryExportId = bigQueryExportId,
        dataset = dataset,
        description = description,
        filter = filter,
        project = project,
    )
}