com.pulumi.gcp.logging.kotlin.ProjectExclusion.kt Maven / Gradle / Ivy

Go to download
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.logging.kotlin

import com.pulumi.core.Output
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 [ProjectExclusion].
 */
@PulumiTagMarker
public class ProjectExclusionResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: ProjectExclusionArgs = ProjectExclusionArgs()

    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 ProjectExclusionArgsBuilder.() -> Unit) {
        val builder = ProjectExclusionArgsBuilder()
        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(): ProjectExclusion {
        val builtJavaResource = com.pulumi.gcp.logging.ProjectExclusion(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return ProjectExclusion(builtJavaResource)
    }
}

/**
 * Manages a project-level logging exclusion. For more information see:
 * * [API documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.exclusions)
 * * How-to Guides
 *     * [Excluding Logs](https://cloud.google.com/logging/docs/exclusions)
 * > You can specify exclusions for log sinks created by the provider by using the exclusions field of `gcp.logging.ProjectSink`
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * const my_exclusion = new gcp.logging.ProjectExclusion("my-exclusion", {
 *     name: "my-instance-debug-exclusion",
 *     description: "Exclude GCE instance debug logs",
 *     filter: "resource.type = gce_instance AND severity <= DEBUG",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * my_exclusion = gcp.logging.ProjectExclusion("my-exclusion",
 *     name="my-instance-debug-exclusion",
 *     description="Exclude GCE instance debug logs",
 *     filter="resource.type = gce_instance AND severity <= DEBUG")
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Gcp = Pulumi.Gcp;
 * return await Deployment.RunAsync(() =>
 * {
 *     var my_exclusion = new Gcp.Logging.ProjectExclusion("my-exclusion", new()
 *     {
 *         Name = "my-instance-debug-exclusion",
 *         Description = "Exclude GCE instance debug logs",
 *         Filter = "resource.type = gce_instance AND severity <= DEBUG",
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/logging"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		_, err := logging.NewProjectExclusion(ctx, "my-exclusion", &logging.ProjectExclusionArgs{
 * 			Name:        pulumi.String("my-instance-debug-exclusion"),
 * 			Description: pulumi.String("Exclude GCE instance debug logs"),
 * 			Filter:      pulumi.String("resource.type = gce_instance AND severity <= DEBUG"),
 * 		})
 * 		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.logging.ProjectExclusion;
 * import com.pulumi.gcp.logging.ProjectExclusionArgs;
 * 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 my_exclusion = new ProjectExclusion("my-exclusion", ProjectExclusionArgs.builder()
 *             .name("my-instance-debug-exclusion")
 *             .description("Exclude GCE instance debug logs")
 *             .filter("resource.type = gce_instance AND severity <= DEBUG")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   my-exclusion:
 *     type: gcp:logging:ProjectExclusion
 *     properties:
 *       name: my-instance-debug-exclusion
 *       description: Exclude GCE instance debug logs
 *       filter: resource.type = gce_instance AND severity <= DEBUG
 * ```
 * 
 * ## Import
 * Project-level logging exclusions can be imported using their URI, e.g.
 * * `projects/{{project_id}}/exclusions/{{name}}`
 * When using the `pulumi import` command, project-level logging exclusions can be imported using one of the formats above. For example:
 * ```sh
 * $ pulumi import gcp:logging/projectExclusion:ProjectExclusion default projects/{{project_id}}/exclusions/{{name}}
 * ```
 */
public class ProjectExclusion internal constructor(
    override val javaResource: com.pulumi.gcp.logging.ProjectExclusion,
) : KotlinCustomResource(javaResource, ProjectExclusionMapper) {
    /**
     * A human-readable description.
     */
    public val description: Output?
        get() = javaResource.description().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Whether this exclusion rule should be disabled or not. This defaults to
     * false.
     */
    public val disabled: Output?
        get() = javaResource.disabled().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * The filter to apply when excluding logs. Only log entries that match the filter are excluded.
     * See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced-filters) for information on how to
     * write a filter.
     */
    public val filter: Output
        get() = javaResource.filter().applyValue({ args0 -> args0 })

    /**
     * The name of the logging exclusion.
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * The project to create the exclusion in. If omitted, the project associated with the provider is
     * used.
     */
    public val project: Output
        get() = javaResource.project().applyValue({ args0 -> args0 })
}

public object ProjectExclusionMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.gcp.logging.ProjectExclusion::class == javaResource::class

    override fun map(javaResource: Resource): ProjectExclusion = ProjectExclusion(
        javaResource as
            com.pulumi.gcp.logging.ProjectExclusion,
    )
}

/**
 * @see [ProjectExclusion].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [ProjectExclusion].
 */
public suspend fun projectExclusion(
    name: String,
    block: suspend ProjectExclusionResourceBuilder.() -> Unit,
): ProjectExclusion {
    val builder = ProjectExclusionResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [ProjectExclusion].
 * @param name The _unique_ name of the resulting resource.
 */
public fun projectExclusion(name: String): ProjectExclusion {
    val builder = ProjectExclusionResourceBuilder()
    builder.name(name)
    return builder.build()
}