com.pulumi.gcp.securitycenter.kotlin.OrganizationCustomModuleArgs.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
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.
@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.OrganizationCustomModuleArgs.builder
import com.pulumi.gcp.securitycenter.kotlin.inputs.OrganizationCustomModuleCustomConfigArgs
import com.pulumi.gcp.securitycenter.kotlin.inputs.OrganizationCustomModuleCustomConfigArgsBuilder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.jvm.JvmName
/**
* Represents an instance of a Security Health Analytics custom module, including
* its full module name, display name, enablement state, and last updated time.
* You can create a custom module at the organization, folder, or project level.
* Custom modules that you create at the organization or folder level are inherited
* by the child folders and projects.
* To get more information about OrganizationCustomModule, see:
* * [API documentation](https://cloud.google.com/security-command-center/docs/reference/rest/v1/organizations.securityHealthAnalyticsSettings.customModules)
* * How-to Guides
* * [Overview of custom modules for Security Health Analytics](https://cloud.google.com/security-command-center/docs/custom-modules-sha-overview)
* ## Example Usage
* ### Scc Organization Custom Module Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const example = new gcp.securitycenter.OrganizationCustomModule("example", {
* organization: "123456789",
* displayName: "basic_custom_module",
* enablementState: "ENABLED",
* customConfig: {
* predicate: {
* expression: "resource.rotationPeriod > duration(\"2592000s\")",
* },
* resourceSelector: {
* resourceTypes: ["cloudkms.googleapis.com/CryptoKey"],
* },
* description: "The rotation period of the identified cryptokey resource exceeds 30 days.",
* recommendation: "Set the rotation period to at most 30 days.",
* severity: "MEDIUM",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* example = gcp.securitycenter.OrganizationCustomModule("example",
* organization="123456789",
* display_name="basic_custom_module",
* enablement_state="ENABLED",
* custom_config={
* "predicate": {
* "expression": "resource.rotationPeriod > duration(\"2592000s\")",
* },
* "resource_selector": {
* "resource_types": ["cloudkms.googleapis.com/CryptoKey"],
* },
* "description": "The rotation period of the identified cryptokey resource exceeds 30 days.",
* "recommendation": "Set the rotation period to at most 30 days.",
* "severity": "MEDIUM",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var example = new Gcp.SecurityCenter.OrganizationCustomModule("example", new()
* {
* Organization = "123456789",
* DisplayName = "basic_custom_module",
* EnablementState = "ENABLED",
* CustomConfig = new Gcp.SecurityCenter.Inputs.OrganizationCustomModuleCustomConfigArgs
* {
* Predicate = new Gcp.SecurityCenter.Inputs.OrganizationCustomModuleCustomConfigPredicateArgs
* {
* Expression = "resource.rotationPeriod > duration(\"2592000s\")",
* },
* ResourceSelector = new Gcp.SecurityCenter.Inputs.OrganizationCustomModuleCustomConfigResourceSelectorArgs
* {
* ResourceTypes = new[]
* {
* "cloudkms.googleapis.com/CryptoKey",
* },
* },
* Description = "The rotation period of the identified cryptokey resource exceeds 30 days.",
* Recommendation = "Set the rotation period to at most 30 days.",
* Severity = "MEDIUM",
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/securitycenter"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := securitycenter.NewOrganizationCustomModule(ctx, "example", &securitycenter.OrganizationCustomModuleArgs{
* Organization: pulumi.String("123456789"),
* DisplayName: pulumi.String("basic_custom_module"),
* EnablementState: pulumi.String("ENABLED"),
* CustomConfig: &securitycenter.OrganizationCustomModuleCustomConfigArgs{
* Predicate: &securitycenter.OrganizationCustomModuleCustomConfigPredicateArgs{
* Expression: pulumi.String("resource.rotationPeriod > duration(\"2592000s\")"),
* },
* ResourceSelector: &securitycenter.OrganizationCustomModuleCustomConfigResourceSelectorArgs{
* ResourceTypes: pulumi.StringArray{
* pulumi.String("cloudkms.googleapis.com/CryptoKey"),
* },
* },
* Description: pulumi.String("The rotation period of the identified cryptokey resource exceeds 30 days."),
* Recommendation: pulumi.String("Set the rotation period to at most 30 days."),
* Severity: pulumi.String("MEDIUM"),
* },
* })
* 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.securitycenter.OrganizationCustomModule;
* import com.pulumi.gcp.securitycenter.OrganizationCustomModuleArgs;
* import com.pulumi.gcp.securitycenter.inputs.OrganizationCustomModuleCustomConfigArgs;
* import com.pulumi.gcp.securitycenter.inputs.OrganizationCustomModuleCustomConfigPredicateArgs;
* import com.pulumi.gcp.securitycenter.inputs.OrganizationCustomModuleCustomConfigResourceSelectorArgs;
* 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 example = new OrganizationCustomModule("example", OrganizationCustomModuleArgs.builder()
* .organization("123456789")
* .displayName("basic_custom_module")
* .enablementState("ENABLED")
* .customConfig(OrganizationCustomModuleCustomConfigArgs.builder()
* .predicate(OrganizationCustomModuleCustomConfigPredicateArgs.builder()
* .expression("resource.rotationPeriod > duration(\"2592000s\")")
* .build())
* .resourceSelector(OrganizationCustomModuleCustomConfigResourceSelectorArgs.builder()
* .resourceTypes("cloudkms.googleapis.com/CryptoKey")
* .build())
* .description("The rotation period of the identified cryptokey resource exceeds 30 days.")
* .recommendation("Set the rotation period to at most 30 days.")
* .severity("MEDIUM")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: gcp:securitycenter:OrganizationCustomModule
* properties:
* organization: '123456789'
* displayName: basic_custom_module
* enablementState: ENABLED
* customConfig:
* predicate:
* expression: resource.rotationPeriod > duration("2592000s")
* resourceSelector:
* resourceTypes:
* - cloudkms.googleapis.com/CryptoKey
* description: The rotation period of the identified cryptokey resource exceeds 30 days.
* recommendation: Set the rotation period to at most 30 days.
* severity: MEDIUM
* ```
*
* ### Scc Organization Custom Module Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const example = new gcp.securitycenter.OrganizationCustomModule("example", {
* organization: "123456789",
* displayName: "full_custom_module",
* enablementState: "ENABLED",
* customConfig: {
* predicate: {
* expression: "resource.rotationPeriod > duration(\"2592000s\")",
* title: "Purpose of the expression",
* description: "description of the expression",
* location: "location of the expression",
* },
* customOutput: {
* properties: [{
* name: "duration",
* valueExpression: {
* expression: "resource.rotationPeriod",
* title: "Purpose of the expression",
* description: "description of the expression",
* location: "location of the expression",
* },
* }],
* },
* resourceSelector: {
* resourceTypes: ["cloudkms.googleapis.com/CryptoKey"],
* },
* severity: "LOW",
* description: "Description of the custom module",
* recommendation: "Steps to resolve violation",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* example = gcp.securitycenter.OrganizationCustomModule("example",
* organization="123456789",
* display_name="full_custom_module",
* enablement_state="ENABLED",
* custom_config={
* "predicate": {
* "expression": "resource.rotationPeriod > duration(\"2592000s\")",
* "title": "Purpose of the expression",
* "description": "description of the expression",
* "location": "location of the expression",
* },
* "custom_output": {
* "properties": [{
* "name": "duration",
* "value_expression": {
* "expression": "resource.rotationPeriod",
* "title": "Purpose of the expression",
* "description": "description of the expression",
* "location": "location of the expression",
* },
* }],
* },
* "resource_selector": {
* "resource_types": ["cloudkms.googleapis.com/CryptoKey"],
* },
* "severity": "LOW",
* "description": "Description of the custom module",
* "recommendation": "Steps to resolve violation",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var example = new Gcp.SecurityCenter.OrganizationCustomModule("example", new()
* {
* Organization = "123456789",
* DisplayName = "full_custom_module",
* EnablementState = "ENABLED",
* CustomConfig = new Gcp.SecurityCenter.Inputs.OrganizationCustomModuleCustomConfigArgs
* {
* Predicate = new Gcp.SecurityCenter.Inputs.OrganizationCustomModuleCustomConfigPredicateArgs
* {
* Expression = "resource.rotationPeriod > duration(\"2592000s\")",
* Title = "Purpose of the expression",
* Description = "description of the expression",
* Location = "location of the expression",
* },
* CustomOutput = new Gcp.SecurityCenter.Inputs.OrganizationCustomModuleCustomConfigCustomOutputArgs
* {
* Properties = new[]
* {
* new Gcp.SecurityCenter.Inputs.OrganizationCustomModuleCustomConfigCustomOutputPropertyArgs
* {
* Name = "duration",
* ValueExpression = new Gcp.SecurityCenter.Inputs.OrganizationCustomModuleCustomConfigCustomOutputPropertyValueExpressionArgs
* {
* Expression = "resource.rotationPeriod",
* Title = "Purpose of the expression",
* Description = "description of the expression",
* Location = "location of the expression",
* },
* },
* },
* },
* ResourceSelector = new Gcp.SecurityCenter.Inputs.OrganizationCustomModuleCustomConfigResourceSelectorArgs
* {
* ResourceTypes = new[]
* {
* "cloudkms.googleapis.com/CryptoKey",
* },
* },
* Severity = "LOW",
* Description = "Description of the custom module",
* Recommendation = "Steps to resolve violation",
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/securitycenter"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := securitycenter.NewOrganizationCustomModule(ctx, "example", &securitycenter.OrganizationCustomModuleArgs{
* Organization: pulumi.String("123456789"),
* DisplayName: pulumi.String("full_custom_module"),
* EnablementState: pulumi.String("ENABLED"),
* CustomConfig: &securitycenter.OrganizationCustomModuleCustomConfigArgs{
* Predicate: &securitycenter.OrganizationCustomModuleCustomConfigPredicateArgs{
* Expression: pulumi.String("resource.rotationPeriod > duration(\"2592000s\")"),
* Title: pulumi.String("Purpose of the expression"),
* Description: pulumi.String("description of the expression"),
* Location: pulumi.String("location of the expression"),
* },
* CustomOutput: securitycenter.OrganizationCustomModuleCustomConfigCustomOutputArgs{
* Properties: securitycenter.OrganizationCustomModuleCustomConfigCustomOutputPropertyArray{
* &securitycenter.OrganizationCustomModuleCustomConfigCustomOutputPropertyArgs{
* Name: pulumi.String("duration"),
* ValueExpression: &securitycenter.OrganizationCustomModuleCustomConfigCustomOutputPropertyValueExpressionArgs{
* Expression: pulumi.String("resource.rotationPeriod"),
* Title: pulumi.String("Purpose of the expression"),
* Description: pulumi.String("description of the expression"),
* Location: pulumi.String("location of the expression"),
* },
* },
* },
* },
* ResourceSelector: &securitycenter.OrganizationCustomModuleCustomConfigResourceSelectorArgs{
* ResourceTypes: pulumi.StringArray{
* pulumi.String("cloudkms.googleapis.com/CryptoKey"),
* },
* },
* Severity: pulumi.String("LOW"),
* Description: pulumi.String("Description of the custom module"),
* Recommendation: pulumi.String("Steps to resolve violation"),
* },
* })
* 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.securitycenter.OrganizationCustomModule;
* import com.pulumi.gcp.securitycenter.OrganizationCustomModuleArgs;
* import com.pulumi.gcp.securitycenter.inputs.OrganizationCustomModuleCustomConfigArgs;
* import com.pulumi.gcp.securitycenter.inputs.OrganizationCustomModuleCustomConfigPredicateArgs;
* import com.pulumi.gcp.securitycenter.inputs.OrganizationCustomModuleCustomConfigCustomOutputArgs;
* import com.pulumi.gcp.securitycenter.inputs.OrganizationCustomModuleCustomConfigResourceSelectorArgs;
* 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 example = new OrganizationCustomModule("example", OrganizationCustomModuleArgs.builder()
* .organization("123456789")
* .displayName("full_custom_module")
* .enablementState("ENABLED")
* .customConfig(OrganizationCustomModuleCustomConfigArgs.builder()
* .predicate(OrganizationCustomModuleCustomConfigPredicateArgs.builder()
* .expression("resource.rotationPeriod > duration(\"2592000s\")")
* .title("Purpose of the expression")
* .description("description of the expression")
* .location("location of the expression")
* .build())
* .customOutput(OrganizationCustomModuleCustomConfigCustomOutputArgs.builder()
* .properties(OrganizationCustomModuleCustomConfigCustomOutputPropertyArgs.builder()
* .name("duration")
* .valueExpression(OrganizationCustomModuleCustomConfigCustomOutputPropertyValueExpressionArgs.builder()
* .expression("resource.rotationPeriod")
* .title("Purpose of the expression")
* .description("description of the expression")
* .location("location of the expression")
* .build())
* .build())
* .build())
* .resourceSelector(OrganizationCustomModuleCustomConfigResourceSelectorArgs.builder()
* .resourceTypes("cloudkms.googleapis.com/CryptoKey")
* .build())
* .severity("LOW")
* .description("Description of the custom module")
* .recommendation("Steps to resolve violation")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: gcp:securitycenter:OrganizationCustomModule
* properties:
* organization: '123456789'
* displayName: full_custom_module
* enablementState: ENABLED
* customConfig:
* predicate:
* expression: resource.rotationPeriod > duration("2592000s")
* title: Purpose of the expression
* description: description of the expression
* location: location of the expression
* customOutput:
* properties:
* - name: duration
* valueExpression:
* expression: resource.rotationPeriod
* title: Purpose of the expression
* description: description of the expression
* location: location of the expression
* resourceSelector:
* resourceTypes:
* - cloudkms.googleapis.com/CryptoKey
* severity: LOW
* description: Description of the custom module
* recommendation: Steps to resolve violation
* ```
*
* ## Import
* OrganizationCustomModule can be imported using any of these accepted formats:
* * `organizations/{{organization}}/securityHealthAnalyticsSettings/customModules/{{name}}`
* * `{{organization}}/{{name}}`
* When using the `pulumi import` command, OrganizationCustomModule can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:securitycenter/organizationCustomModule:OrganizationCustomModule default organizations/{{organization}}/securityHealthAnalyticsSettings/customModules/{{name}}
* ```
* ```sh
* $ pulumi import gcp:securitycenter/organizationCustomModule:OrganizationCustomModule default {{organization}}/{{name}}
* ```
* @property customConfig The user specified custom configuration for the module.
* Structure is documented below.
* @property displayName The display name of the Security Health Analytics custom module. This
* display name becomes the finding category for all findings that are
* returned by this custom module. The display name must be between 1 and
* 128 characters, start with a lowercase letter, and contain alphanumeric
* characters or underscores only.
* @property enablementState The enablement state of the custom module.
* Possible values are: `ENABLED`, `DISABLED`.
* @property organization Numerical ID of the parent organization.
*/
public data class OrganizationCustomModuleArgs(
public val customConfig: Output? = null,
public val displayName: Output? = null,
public val enablementState: Output? = null,
public val organization: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.gcp.securitycenter.OrganizationCustomModuleArgs =
com.pulumi.gcp.securitycenter.OrganizationCustomModuleArgs.builder()
.customConfig(customConfig?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.displayName(displayName?.applyValue({ args0 -> args0 }))
.enablementState(enablementState?.applyValue({ args0 -> args0 }))
.organization(organization?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [OrganizationCustomModuleArgs].
*/
@PulumiTagMarker
public class OrganizationCustomModuleArgsBuilder internal constructor() {
private var customConfig: Output? = null
private var displayName: Output? = null
private var enablementState: Output? = null
private var organization: Output? = null
/**
* @param value The user specified custom configuration for the module.
* Structure is documented below.
*/
@JvmName("vlnqvlrjcaiyeguf")
public suspend fun customConfig(`value`: Output) {
this.customConfig = value
}
/**
* @param value The display name of the Security Health Analytics custom module. This
* display name becomes the finding category for all findings that are
* returned by this custom module. The display name must be between 1 and
* 128 characters, start with a lowercase letter, and contain alphanumeric
* characters or underscores only.
*/
@JvmName("nrodacvhyajqictb")
public suspend fun displayName(`value`: Output) {
this.displayName = value
}
/**
* @param value The enablement state of the custom module.
* Possible values are: `ENABLED`, `DISABLED`.
*/
@JvmName("rbmqxaxxdanrahks")
public suspend fun enablementState(`value`: Output) {
this.enablementState = value
}
/**
* @param value Numerical ID of the parent organization.
*/
@JvmName("payntomeoxwholim")
public suspend fun organization(`value`: Output) {
this.organization = value
}
/**
* @param value The user specified custom configuration for the module.
* Structure is documented below.
*/
@JvmName("xsnaxtnrhshypmsp")
public suspend fun customConfig(`value`: OrganizationCustomModuleCustomConfigArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.customConfig = mapped
}
/**
* @param argument The user specified custom configuration for the module.
* Structure is documented below.
*/
@JvmName("ioggedwvxclihmkk")
public suspend fun customConfig(argument: suspend OrganizationCustomModuleCustomConfigArgsBuilder.() -> Unit) {
val toBeMapped = OrganizationCustomModuleCustomConfigArgsBuilder().applySuspend {
argument()
}.build()
val mapped = of(toBeMapped)
this.customConfig = mapped
}
/**
* @param value The display name of the Security Health Analytics custom module. This
* display name becomes the finding category for all findings that are
* returned by this custom module. The display name must be between 1 and
* 128 characters, start with a lowercase letter, and contain alphanumeric
* characters or underscores only.
*/
@JvmName("lfqcpyrbpoabqory")
public suspend fun displayName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.displayName = mapped
}
/**
* @param value The enablement state of the custom module.
* Possible values are: `ENABLED`, `DISABLED`.
*/
@JvmName("xaqpxlthysklebvm")
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("kmnxiyrlydfgtgyt")
public suspend fun organization(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.organization = mapped
}
internal fun build(): OrganizationCustomModuleArgs = OrganizationCustomModuleArgs(
customConfig = customConfig,
displayName = displayName,
enablementState = enablementState,
organization = organization,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy