com.pulumi.gcp.securitycenter.kotlin.EventThreatDetectionCustomModuleArgs.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.12.0.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.EventThreatDetectionCustomModuleArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName

/**
 * Represents an instance of an Event Threat Detection custom module, including
 * its full module name, display name, enablement state, andlast updated time.
 * You can create a custom module at the organization level only.
 * To get more information about EventThreatDetectionCustomModule, see:
 * * [API documentation](https://cloud.google.com/security-command-center/docs/reference/rest/v1/organizations.eventThreatDetectionSettings.customModules)
 * * How-to Guides
 *     * [Overview of custom modules for Event Threat Detection](https://cloud.google.com/security-command-center/docs/custom-modules-etd-overview)
 * ## Example Usage
 * ### Scc Event Threat Detection Custom Module
 * 
 * ```yaml
 * resources:
 *   example:
 *     type: gcp:securitycenter:EventThreatDetectionCustomModule
 *     properties:
 *       organization: '123456789'
 *       displayName: basic_custom_module
 *       enablementState: ENABLED
 *       type: CONFIGURABLE_BAD_IP
 *       description: My Event Threat Detection Custom Module
 *       config:
 *         fn::toJSON:
 *           metadata:
 *             severity: LOW
 *             description: Flagged by Forcepoint as malicious
 *             recommendation: Contact the owner of the relevant project.
 *           ips:
 *             - 192.0.2.1
 *             - 192.0.2.0/24
 * ```
 * 
 * ## Import
 * EventThreatDetectionCustomModule can be imported using any of these accepted formats:
 * * `organizations/{{organization}}/eventThreatDetectionSettings/customModules/{{name}}`
 * * `{{organization}}/{{name}}`
 * When using the `pulumi import` command, EventThreatDetectionCustomModule can be imported using one of the formats above. For example:
 * ```sh
 * $ pulumi import gcp:securitycenter/eventThreatDetectionCustomModule:EventThreatDetectionCustomModule default organizations/{{organization}}/eventThreatDetectionSettings/customModules/{{name}}
 * ```
 * ```sh
 * $ pulumi import gcp:securitycenter/eventThreatDetectionCustomModule:EventThreatDetectionCustomModule default {{organization}}/{{name}}
 * ```
 * @property config Config for the module. For the resident module, its config value is defined at this level.
 * For the inherited module, its config value is inherited from the ancestor module.
 * @property displayName The human readable name to be displayed for the module.
 * @property enablementState The state of enablement for the module at the given level of the hierarchy.
 * Possible values are: `ENABLED`, `DISABLED`.
 * @property organization Numerical ID of the parent organization.
 * - - -
 * @property type Immutable. Type for the module. e.g. CONFIGURABLE_BAD_IP.
 */
public data class EventThreatDetectionCustomModuleArgs(
    public val config: Output? = null,
    public val displayName: Output? = null,
    public val enablementState: Output? = null,
    public val organization: Output? = null,
    public val type: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.gcp.securitycenter.EventThreatDetectionCustomModuleArgs =
        com.pulumi.gcp.securitycenter.EventThreatDetectionCustomModuleArgs.builder()
            .config(config?.applyValue({ args0 -> args0 }))
            .displayName(displayName?.applyValue({ args0 -> args0 }))
            .enablementState(enablementState?.applyValue({ args0 -> args0 }))
            .organization(organization?.applyValue({ args0 -> args0 }))
            .type(type?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [EventThreatDetectionCustomModuleArgs].
 */
@PulumiTagMarker
public class EventThreatDetectionCustomModuleArgsBuilder internal constructor() {
    private var config: Output? = null

    private var displayName: Output? = null

    private var enablementState: Output? = null

    private var organization: Output? = null

    private var type: Output? = null

    /**
     * @param value Config for the module. For the resident module, its config value is defined at this level.
     * For the inherited module, its config value is inherited from the ancestor module.
     */
    @JvmName("qqbswnylysgwpwmn")
    public suspend fun config(`value`: Output) {
        this.config = value
    }

    /**
     * @param value The human readable name to be displayed for the module.
     */
    @JvmName("qiyvwguvlbyhjfur")
    public suspend fun displayName(`value`: Output) {
        this.displayName = value
    }

    /**
     * @param value The state of enablement for the module at the given level of the hierarchy.
     * Possible values are: `ENABLED`, `DISABLED`.
     */
    @JvmName("yuyvhomtmayoyqnn")
    public suspend fun enablementState(`value`: Output) {
        this.enablementState = value
    }

    /**
     * @param value Numerical ID of the parent organization.
     * - - -
     */
    @JvmName("yabpqewngpwvtrqp")
    public suspend fun organization(`value`: Output) {
        this.organization = value
    }

    /**
     * @param value Immutable. Type for the module. e.g. CONFIGURABLE_BAD_IP.
     */
    @JvmName("qudghficxkulagjc")
    public suspend fun type(`value`: Output) {
        this.type = value
    }

    /**
     * @param value Config for the module. For the resident module, its config value is defined at this level.
     * For the inherited module, its config value is inherited from the ancestor module.
     */
    @JvmName("rknaiqmxnmpcbvvp")
    public suspend fun config(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.config = mapped
    }

    /**
     * @param value The human readable name to be displayed for the module.
     */
    @JvmName("wuodaknfqhmgahmg")
    public suspend fun displayName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.displayName = mapped
    }

    /**
     * @param value The state of enablement for the module at the given level of the hierarchy.
     * Possible values are: `ENABLED`, `DISABLED`.
     */
    @JvmName("sninadxlsropctms")
    public suspend fun enablementState(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.enablementState = mapped
    }

    /**
     * @param value Numerical ID of the parent organization.
     * - - -
     */
    @JvmName("phvavumggagpqllw")
    public suspend fun organization(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.organization = mapped
    }

    /**
     * @param value Immutable. Type for the module. e.g. CONFIGURABLE_BAD_IP.
     */
    @JvmName("veiuocsvscvnbpqk")
    public suspend fun type(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.type = mapped
    }

    internal fun build(): EventThreatDetectionCustomModuleArgs = EventThreatDetectionCustomModuleArgs(
        config = config,
        displayName = displayName,
        enablementState = enablementState,
        organization = organization,
        type = type,
    )
}