pulumi-gcp-kotlin/com.pulumi.gcp.securitycenter.kotlin/FolderCustomModuleArgs

FolderCustomModuleArgs

data class FolderCustomModuleArgs(val customConfig: Output<FolderCustomModuleCustomConfigArgs>? = null, val displayName: Output<String>? = null, val enablementState: Output<String>? = null, val folder: Output<String>? = null) : ConvertibleToJava<FolderCustomModuleArgs>

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 FolderCustomModule, see:

Example Usage

Scc Folder Custom Module Basic

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.securitycenter.FolderCustomModule;
import com.pulumi.gcp.securitycenter.FolderCustomModuleArgs;
import com.pulumi.gcp.securitycenter.inputs.FolderCustomModuleCustomConfigArgs;
import com.pulumi.gcp.securitycenter.inputs.FolderCustomModuleCustomConfigPredicateArgs;
import com.pulumi.gcp.securitycenter.inputs.FolderCustomModuleCustomConfigResourceSelectorArgs;
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 folder = new Folder("folder", FolderArgs.builder()
            .parent("organizations/123456789")
            .displayName("folder-name")
            .build());
        var example = new FolderCustomModule("example", FolderCustomModuleArgs.builder()
            .folder(folder.folderId())
            .displayName("basic_custom_module")
            .enablementState("ENABLED")
            .customConfig(FolderCustomModuleCustomConfigArgs.builder()
                .predicate(FolderCustomModuleCustomConfigPredicateArgs.builder()
                    .expression("resource.rotationPeriod duration(\"2592000s\")")
                    .build())
                .resourceSelector(FolderCustomModuleCustomConfigResourceSelectorArgs.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());
    }
}
Content copied to clipboard

Scc Folder Custom Module Full

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.securitycenter.FolderCustomModule;
import com.pulumi.gcp.securitycenter.FolderCustomModuleArgs;
import com.pulumi.gcp.securitycenter.inputs.FolderCustomModuleCustomConfigArgs;
import com.pulumi.gcp.securitycenter.inputs.FolderCustomModuleCustomConfigPredicateArgs;
import com.pulumi.gcp.securitycenter.inputs.FolderCustomModuleCustomConfigCustomOutputArgs;
import com.pulumi.gcp.securitycenter.inputs.FolderCustomModuleCustomConfigResourceSelectorArgs;
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 folder = new Folder("folder", FolderArgs.builder()
            .parent("organizations/123456789")
            .displayName("folder-name")
            .build());
        var example = new FolderCustomModule("example", FolderCustomModuleArgs.builder()
            .folder(folder.folderId())
            .displayName("full_custom_module")
            .enablementState("ENABLED")
            .customConfig(FolderCustomModuleCustomConfigArgs.builder()
                .predicate(FolderCustomModuleCustomConfigPredicateArgs.builder()
                    .expression("resource.rotationPeriod duration(\"2592000s\")")
                    .title("Purpose of the expression")
                    .description("description of the expression")
                    .location("location of the expression")
                    .build())
                .customOutput(FolderCustomModuleCustomConfigCustomOutputArgs.builder()
                    .properties(FolderCustomModuleCustomConfigCustomOutputPropertyArgs.builder()
                        .name("duration")
                        .valueExpression(FolderCustomModuleCustomConfigCustomOutputPropertyValueExpressionArgs.builder()
                            .expression("resource.rotationPeriod")
                            .title("Purpose of the expression")
                            .description("description of the expression")
                            .location("location of the expression")
                            .build())
                        .build())
                    .build())
                .resourceSelector(FolderCustomModuleCustomConfigResourceSelectorArgs.builder()
                    .resourceTypes("cloudkms.googleapis.com/CryptoKey")
                    .build())
                .severity("LOW")
                .description("Description of the custom module")
                .recommendation("Steps to resolve violation")
                .build())
            .build());
    }
}
Content copied to clipboard

Import

FolderCustomModule can be imported using any of these accepted formats* folders/{{folder}}/securityHealthAnalyticsSettings/customModules/{{name}} * {{folder}}/{{name}} In Terraform v1.5.0 and later, use an import block to import FolderCustomModule using one of the formats above. For exampletf import { id = "folders/{{folder}}/securityHealthAnalyticsSettings/customModules/{{name}}" to = google_scc_folder_custom_module.default }

$ pulumi import gcp:securitycenter/folderCustomModule:FolderCustomModule When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), FolderCustomModule can be imported using one of the formats above. For example
Content copied to clipboard
$ pulumi import gcp:securitycenter/folderCustomModule:FolderCustomModule default folders/{{folder}}/securityHealthAnalyticsSettings/customModules/{{name}}
Content copied to clipboard
$ pulumi import gcp:securitycenter/folderCustomModule:FolderCustomModule default {{folder}}/{{name}}
Content copied to clipboard

Constructors

Link copied to clipboard
fun FolderCustomModuleArgs(customConfig: Output<FolderCustomModuleCustomConfigArgs>? = null, displayName: Output<String>? = null, enablementState: Output<String>? = null, folder: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): FolderCustomModuleArgs

Properties

Link copied to clipboard
val customConfig: Output<FolderCustomModuleCustomConfigArgs>? = null

The user specified custom configuration for the module. Structure is documented below.

Link copied to clipboard
val displayName: Output<String>? = null

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.

Link copied to clipboard
val enablementState: Output<String>? = null

The enablement state of the custom module. Possible values are: ENABLED, DISABLED.

Link copied to clipboard
val folder: Output<String>? = null

Numerical ID of the parent folder.