Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.pulumi.gcp.securitycenter.kotlin.ProjectCustomModule.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.securitycenter.kotlin
import com.pulumi.core.Output
import com.pulumi.gcp.securitycenter.kotlin.outputs.ProjectCustomModuleCustomConfig
import com.pulumi.gcp.securitycenter.kotlin.outputs.ProjectCustomModuleCustomConfig.Companion.toKotlin
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 [ProjectCustomModule].
*/
@PulumiTagMarker
public class ProjectCustomModuleResourceBuilder internal constructor() {
public var name: String? = null
public var args: ProjectCustomModuleArgs = ProjectCustomModuleArgs()
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 ProjectCustomModuleArgsBuilder.() -> Unit) {
val builder = ProjectCustomModuleArgsBuilder()
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(): ProjectCustomModule {
val builtJavaResource =
com.pulumi.gcp.securitycenter.ProjectCustomModule(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return ProjectCustomModule(builtJavaResource)
}
}
/**
* 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 ProjectCustomModule, see:
* * [API documentation](https://cloud.google.com/security-command-center/docs/reference/rest/v1/projects.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 Project Custom Module Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const example = new gcp.securitycenter.ProjectCustomModule("example", {
* 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.ProjectCustomModule("example",
* 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.ProjectCustomModule("example", new()
* {
* DisplayName = "basic_custom_module",
* EnablementState = "ENABLED",
* CustomConfig = new Gcp.SecurityCenter.Inputs.ProjectCustomModuleCustomConfigArgs
* {
* Predicate = new Gcp.SecurityCenter.Inputs.ProjectCustomModuleCustomConfigPredicateArgs
* {
* Expression = "resource.rotationPeriod > duration(\"2592000s\")",
* },
* ResourceSelector = new Gcp.SecurityCenter.Inputs.ProjectCustomModuleCustomConfigResourceSelectorArgs
* {
* 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.NewProjectCustomModule(ctx, "example", &securitycenter.ProjectCustomModuleArgs{
* DisplayName: pulumi.String("basic_custom_module"),
* EnablementState: pulumi.String("ENABLED"),
* CustomConfig: &securitycenter.ProjectCustomModuleCustomConfigArgs{
* Predicate: &securitycenter.ProjectCustomModuleCustomConfigPredicateArgs{
* Expression: pulumi.String("resource.rotationPeriod > duration(\"2592000s\")"),
* },
* ResourceSelector: &securitycenter.ProjectCustomModuleCustomConfigResourceSelectorArgs{
* 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.ProjectCustomModule;
* import com.pulumi.gcp.securitycenter.ProjectCustomModuleArgs;
* import com.pulumi.gcp.securitycenter.inputs.ProjectCustomModuleCustomConfigArgs;
* import com.pulumi.gcp.securitycenter.inputs.ProjectCustomModuleCustomConfigPredicateArgs;
* import com.pulumi.gcp.securitycenter.inputs.ProjectCustomModuleCustomConfigResourceSelectorArgs;
* 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 ProjectCustomModule("example", ProjectCustomModuleArgs.builder()
* .displayName("basic_custom_module")
* .enablementState("ENABLED")
* .customConfig(ProjectCustomModuleCustomConfigArgs.builder()
* .predicate(ProjectCustomModuleCustomConfigPredicateArgs.builder()
* .expression("resource.rotationPeriod > duration(\"2592000s\")")
* .build())
* .resourceSelector(ProjectCustomModuleCustomConfigResourceSelectorArgs.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:ProjectCustomModule
* properties:
* 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 Project Custom Module Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const example = new gcp.securitycenter.ProjectCustomModule("example", {
* 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.ProjectCustomModule("example",
* 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.ProjectCustomModule("example", new()
* {
* DisplayName = "full_custom_module",
* EnablementState = "ENABLED",
* CustomConfig = new Gcp.SecurityCenter.Inputs.ProjectCustomModuleCustomConfigArgs
* {
* Predicate = new Gcp.SecurityCenter.Inputs.ProjectCustomModuleCustomConfigPredicateArgs
* {
* 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.ProjectCustomModuleCustomConfigCustomOutputArgs
* {
* Properties = new[]
* {
* new Gcp.SecurityCenter.Inputs.ProjectCustomModuleCustomConfigCustomOutputPropertyArgs
* {
* Name = "duration",
* ValueExpression = new Gcp.SecurityCenter.Inputs.ProjectCustomModuleCustomConfigCustomOutputPropertyValueExpressionArgs
* {
* Expression = "resource.rotationPeriod",
* Title = "Purpose of the expression",
* Description = "description of the expression",
* Location = "location of the expression",
* },
* },
* },
* },
* ResourceSelector = new Gcp.SecurityCenter.Inputs.ProjectCustomModuleCustomConfigResourceSelectorArgs
* {
* 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.NewProjectCustomModule(ctx, "example", &securitycenter.ProjectCustomModuleArgs{
* DisplayName: pulumi.String("full_custom_module"),
* EnablementState: pulumi.String("ENABLED"),
* CustomConfig: &securitycenter.ProjectCustomModuleCustomConfigArgs{
* Predicate: &securitycenter.ProjectCustomModuleCustomConfigPredicateArgs{
* 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.ProjectCustomModuleCustomConfigCustomOutputArgs{
* Properties: securitycenter.ProjectCustomModuleCustomConfigCustomOutputPropertyArray{
* &securitycenter.ProjectCustomModuleCustomConfigCustomOutputPropertyArgs{
* Name: pulumi.String("duration"),
* ValueExpression: &securitycenter.ProjectCustomModuleCustomConfigCustomOutputPropertyValueExpressionArgs{
* 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.ProjectCustomModuleCustomConfigResourceSelectorArgs{
* 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.ProjectCustomModule;
* import com.pulumi.gcp.securitycenter.ProjectCustomModuleArgs;
* import com.pulumi.gcp.securitycenter.inputs.ProjectCustomModuleCustomConfigArgs;
* import com.pulumi.gcp.securitycenter.inputs.ProjectCustomModuleCustomConfigPredicateArgs;
* import com.pulumi.gcp.securitycenter.inputs.ProjectCustomModuleCustomConfigCustomOutputArgs;
* import com.pulumi.gcp.securitycenter.inputs.ProjectCustomModuleCustomConfigResourceSelectorArgs;
* 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 ProjectCustomModule("example", ProjectCustomModuleArgs.builder()
* .displayName("full_custom_module")
* .enablementState("ENABLED")
* .customConfig(ProjectCustomModuleCustomConfigArgs.builder()
* .predicate(ProjectCustomModuleCustomConfigPredicateArgs.builder()
* .expression("resource.rotationPeriod > duration(\"2592000s\")")
* .title("Purpose of the expression")
* .description("description of the expression")
* .location("location of the expression")
* .build())
* .customOutput(ProjectCustomModuleCustomConfigCustomOutputArgs.builder()
* .properties(ProjectCustomModuleCustomConfigCustomOutputPropertyArgs.builder()
* .name("duration")
* .valueExpression(ProjectCustomModuleCustomConfigCustomOutputPropertyValueExpressionArgs.builder()
* .expression("resource.rotationPeriod")
* .title("Purpose of the expression")
* .description("description of the expression")
* .location("location of the expression")
* .build())
* .build())
* .build())
* .resourceSelector(ProjectCustomModuleCustomConfigResourceSelectorArgs.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:ProjectCustomModule
* properties:
* 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
* ProjectCustomModule can be imported using any of these accepted formats:
* * `projects/{{project}}/securityHealthAnalyticsSettings/customModules/{{name}}`
* * `{{project}}/{{name}}`
* * `{{name}}`
* When using the `pulumi import` command, ProjectCustomModule can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:securitycenter/projectCustomModule:ProjectCustomModule default projects/{{project}}/securityHealthAnalyticsSettings/customModules/{{name}}
* ```
* ```sh
* $ pulumi import gcp:securitycenter/projectCustomModule:ProjectCustomModule default {{project}}/{{name}}
* ```
* ```sh
* $ pulumi import gcp:securitycenter/projectCustomModule:ProjectCustomModule default {{name}}
* ```
*/
public class ProjectCustomModule internal constructor(
override val javaResource: com.pulumi.gcp.securitycenter.ProjectCustomModule,
) : KotlinCustomResource(javaResource, ProjectCustomModuleMapper) {
/**
* If empty, indicates that the custom module was created in the organization,folder,
* or project in which you are viewing the custom module. Otherwise, ancestor_module
* specifies the organization or folder from which the custom module is inherited.
*/
public val ancestorModule: Output
get() = javaResource.ancestorModule().applyValue({ args0 -> args0 })
/**
* The user specified custom configuration for the module.
* Structure is documented below.
*/
public val customConfig: Output
get() = javaResource.customConfig().applyValue({ args0 -> args0.let({ args0 -> toKotlin(args0) }) })
/**
* 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.
*/
public val displayName: Output
get() = javaResource.displayName().applyValue({ args0 -> args0 })
/**
* The enablement state of the custom module.
* Possible values are: `ENABLED`, `DISABLED`.
*/
public val enablementState: Output
get() = javaResource.enablementState().applyValue({ args0 -> args0 })
/**
* The editor that last updated the custom module.
*/
public val lastEditor: Output
get() = javaResource.lastEditor().applyValue({ args0 -> args0 })
/**
* The resource name of the custom module. Its format is "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}".
* The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
public val project: Output
get() = javaResource.project().applyValue({ args0 -> args0 })
/**
* The time at which the custom module was last updated.
* 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 ProjectCustomModuleMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.securitycenter.ProjectCustomModule::class == javaResource::class
override fun map(javaResource: Resource): ProjectCustomModule = ProjectCustomModule(
javaResource
as com.pulumi.gcp.securitycenter.ProjectCustomModule,
)
}
/**
* @see [ProjectCustomModule].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [ProjectCustomModule].
*/
public suspend fun projectCustomModule(
name: String,
block: suspend ProjectCustomModuleResourceBuilder.() -> Unit,
): ProjectCustomModule {
val builder = ProjectCustomModuleResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [ProjectCustomModule].
* @param name The _unique_ name of the resulting resource.
*/
public fun projectCustomModule(name: String): ProjectCustomModule {
val builder = ProjectCustomModuleResourceBuilder()
builder.name(name)
return builder.build()
}
