com.pulumi.gcp.logging.kotlin.OrganizationExclusionArgs.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
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 8.10.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.logging.kotlin

import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.logging.OrganizationExclusionArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName

/**
 * Manages an organization-level logging exclusion. For more information see:
 * * [API documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/organizations.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.OrganizationSink`
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * const my_exclusion = new gcp.logging.OrganizationExclusion("my-exclusion", {
 *     name: "my-instance-debug-exclusion",
 *     orgId: "123456789",
 *     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.OrganizationExclusion("my-exclusion",
 *     name="my-instance-debug-exclusion",
 *     org_id="123456789",
 *     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.OrganizationExclusion("my-exclusion", new()
 *     {
 *         Name = "my-instance-debug-exclusion",
 *         OrgId = "123456789",
 *         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.NewOrganizationExclusion(ctx, "my-exclusion", &logging.OrganizationExclusionArgs{
 * 			Name:        pulumi.String("my-instance-debug-exclusion"),
 * 			OrgId:       pulumi.String("123456789"),
 * 			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.OrganizationExclusion;
 * import com.pulumi.gcp.logging.OrganizationExclusionArgs;
 * 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 OrganizationExclusion("my-exclusion", OrganizationExclusionArgs.builder()
 *             .name("my-instance-debug-exclusion")
 *             .orgId("123456789")
 *             .description("Exclude GCE instance debug logs")
 *             .filter("resource.type = gce_instance AND severity <= DEBUG")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   my-exclusion:
 *     type: gcp:logging:OrganizationExclusion
 *     properties:
 *       name: my-instance-debug-exclusion
 *       orgId: '123456789'
 *       description: Exclude GCE instance debug logs
 *       filter: resource.type = gce_instance AND severity <= DEBUG
 * ```
 * 
 * ## Import
 * Organization-level logging exclusions can be imported using their URI, e.g.
 * * `organizations/{{organization}}/exclusions/{{name}}`
 * When using the `pulumi import` command, organization-level logging exclusions can be imported using one of the formats above. For example:
 * ```sh
 * $ pulumi import gcp:logging/organizationExclusion:OrganizationExclusion default organizations/{{organization}}/exclusions/{{name}}
 * ```
 * @property description A human-readable description.
 * @property disabled Whether this exclusion rule should be disabled or not. This defaults to
 * false.
 * @property filter 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.
 * @property name The name of the logging exclusion.
 * @property orgId The organization to create the exclusion in.
 */
public data class OrganizationExclusionArgs(
    public val description: Output? = null,
    public val disabled: Output? = null,
    public val filter: Output? = null,
    public val name: Output? = null,
    public val orgId: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.gcp.logging.OrganizationExclusionArgs =
        com.pulumi.gcp.logging.OrganizationExclusionArgs.builder()
            .description(description?.applyValue({ args0 -> args0 }))
            .disabled(disabled?.applyValue({ args0 -> args0 }))
            .filter(filter?.applyValue({ args0 -> args0 }))
            .name(name?.applyValue({ args0 -> args0 }))
            .orgId(orgId?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [OrganizationExclusionArgs].
 */
@PulumiTagMarker
public class OrganizationExclusionArgsBuilder internal constructor() {
    private var description: Output? = null

    private var disabled: Output? = null

    private var filter: Output? = null

    private var name: Output? = null

    private var orgId: Output? = null

    /**
     * @param value A human-readable description.
     */
    @JvmName("ipukrwmeextdxkxa")
    public suspend fun description(`value`: Output) {
        this.description = value
    }

    /**
     * @param value Whether this exclusion rule should be disabled or not. This defaults to
     * false.
     */
    @JvmName("rhwikeupglgslxhq")
    public suspend fun disabled(`value`: Output) {
        this.disabled = value
    }

    /**
     * @param value 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.
     */
    @JvmName("cphbjhnditytguyl")
    public suspend fun filter(`value`: Output) {
        this.filter = value
    }

    /**
     * @param value The name of the logging exclusion.
     */
    @JvmName("hpdhtcbnxymscaik")
    public suspend fun name(`value`: Output) {
        this.name = value
    }

    /**
     * @param value The organization to create the exclusion in.
     */
    @JvmName("ckcnoccqapsdsjhy")
    public suspend fun orgId(`value`: Output) {
        this.orgId = value
    }

    /**
     * @param value A human-readable description.
     */
    @JvmName("fnbuiafrfmhcawpk")
    public suspend fun description(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.description = mapped
    }

    /**
     * @param value Whether this exclusion rule should be disabled or not. This defaults to
     * false.
     */
    @JvmName("herihfjhqwyrhlnp")
    public suspend fun disabled(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.disabled = mapped
    }

    /**
     * @param value 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.
     */
    @JvmName("mkkcseigdssbeeci")
    public suspend fun filter(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.filter = mapped
    }

    /**
     * @param value The name of the logging exclusion.
     */
    @JvmName("qdyghqvkepykahpu")
    public suspend fun name(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.name = mapped
    }

    /**
     * @param value The organization to create the exclusion in.
     */
    @JvmName("jdpfvplqwjbkdfsh")
    public suspend fun orgId(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.orgId = mapped
    }

    internal fun build(): OrganizationExclusionArgs = OrganizationExclusionArgs(
        description = description,
        disabled = disabled,
        filter = filter,
        name = name,
        orgId = orgId,
    )
}