com.pulumi.gcp.logging.kotlin.FolderExclusion.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 [FolderExclusion].
 */
@PulumiTagMarker
public class FolderExclusionResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: FolderExclusionArgs = FolderExclusionArgs()

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

/**
 * Manages a folder-level logging exclusion. For more information see:
 * * [API documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/folders.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.FolderSink`
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * const my_folder = new gcp.organizations.Folder("my-folder", {
 *     displayName: "My folder",
 *     parent: "organizations/123456",
 * });
 * const my_exclusion = new gcp.logging.FolderExclusion("my-exclusion", {
 *     name: "my-instance-debug-exclusion",
 *     folder: my_folder.name,
 *     description: "Exclude GCE instance debug logs",
 *     filter: "resource.type = gce_instance AND severity <= DEBUG",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * my_folder = gcp.organizations.Folder("my-folder",
 *     display_name="My folder",
 *     parent="organizations/123456")
 * my_exclusion = gcp.logging.FolderExclusion("my-exclusion",
 *     name="my-instance-debug-exclusion",
 *     folder=my_folder.name,
 *     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_folder = new Gcp.Organizations.Folder("my-folder", new()
 *     {
 *         DisplayName = "My folder",
 *         Parent = "organizations/123456",
 *     });
 *     var my_exclusion = new Gcp.Logging.FolderExclusion("my-exclusion", new()
 *     {
 *         Name = "my-instance-debug-exclusion",
 *         Folder = my_folder.Name,
 *         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-gcp/sdk/v7/go/gcp/organizations"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		_, err := organizations.NewFolder(ctx, "my-folder", &organizations.FolderArgs{
 * 			DisplayName: pulumi.String("My folder"),
 * 			Parent:      pulumi.String("organizations/123456"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = logging.NewFolderExclusion(ctx, "my-exclusion", &logging.FolderExclusionArgs{
 * 			Name:        pulumi.String("my-instance-debug-exclusion"),
 * 			Folder:      my_folder.Name,
 * 			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.organizations.Folder;
 * import com.pulumi.gcp.organizations.FolderArgs;
 * import com.pulumi.gcp.logging.FolderExclusion;
 * import com.pulumi.gcp.logging.FolderExclusionArgs;
 * 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_folder = new Folder("my-folder", FolderArgs.builder()
 *             .displayName("My folder")
 *             .parent("organizations/123456")
 *             .build());
 *         var my_exclusion = new FolderExclusion("my-exclusion", FolderExclusionArgs.builder()
 *             .name("my-instance-debug-exclusion")
 *             .folder(my_folder.name())
 *             .description("Exclude GCE instance debug logs")
 *             .filter("resource.type = gce_instance AND severity <= DEBUG")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   my-exclusion:
 *     type: gcp:logging:FolderExclusion
 *     properties:
 *       name: my-instance-debug-exclusion
 *       folder: ${["my-folder"].name}
 *       description: Exclude GCE instance debug logs
 *       filter: resource.type = gce_instance AND severity <= DEBUG
 *   my-folder:
 *     type: gcp:organizations:Folder
 *     properties:
 *       displayName: My folder
 *       parent: organizations/123456
 * ```
 * 
 * ## Import
 * Folder-level logging exclusions can be imported using their URI, e.g.
 * * `folders/{{folder}}/exclusions/{{name}}`
 * When using the `pulumi import` command, folder-level logging exclusions can be imported using one of the formats above. For example:
 * ```sh
 * $ pulumi import gcp:logging/folderExclusion:FolderExclusion default folders/{{folder}}/exclusions/{{name}}
 * ```
 */
public class FolderExclusion internal constructor(
    override val javaResource: com.pulumi.gcp.logging.FolderExclusion,
) : KotlinCustomResource(javaResource, FolderExclusionMapper) {
    /**
     * 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 folder to be exported to the sink. Note that either [FOLDER_ID] or "folders/[FOLDER_ID]" is
     * accepted.
     */
    public val folder: Output
        get() = javaResource.folder().applyValue({ args0 -> args0 })

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

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

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

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

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