com.pulumi.gitlab.kotlin.ServicePipelinesEmail.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gitlab-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.4.2.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gitlab.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
import kotlin.collections.List

/**
 * Builder for [ServicePipelinesEmail].
 */
@PulumiTagMarker
public class ServicePipelinesEmailResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: ServicePipelinesEmailArgs = ServicePipelinesEmailArgs()

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

/**
 * The `gitlab.ServicePipelinesEmail` resource allows to manage the lifecycle of a project integration with Pipeline Emails Service.
 * > This resource is deprecated. use `gitlab.IntegrationPipelinesEmail`instead!
 * **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#pipeline-emails)
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gitlab from "@pulumi/gitlab";
 * const awesomeProject = new gitlab.Project("awesome_project", {
 *     name: "awesome_project",
 *     description: "My awesome project.",
 *     visibilityLevel: "public",
 * });
 * const email = new gitlab.ServicePipelinesEmail("email", {
 *     project: awesomeProject.id,
 *     recipients: ["gitlab@user.create"],
 *     notifyOnlyBrokenPipelines: true,
 *     branchesToBeNotified: "all",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gitlab as gitlab
 * awesome_project = gitlab.Project("awesome_project",
 *     name="awesome_project",
 *     description="My awesome project.",
 *     visibility_level="public")
 * email = gitlab.ServicePipelinesEmail("email",
 *     project=awesome_project.id,
 *     recipients=["gitlab@user.create"],
 *     notify_only_broken_pipelines=True,
 *     branches_to_be_notified="all")
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using GitLab = Pulumi.GitLab;
 * return await Deployment.RunAsync(() =>
 * {
 *     var awesomeProject = new GitLab.Project("awesome_project", new()
 *     {
 *         Name = "awesome_project",
 *         Description = "My awesome project.",
 *         VisibilityLevel = "public",
 *     });
 *     var email = new GitLab.ServicePipelinesEmail("email", new()
 *     {
 *         Project = awesomeProject.Id,
 *         Recipients = new[]
 *         {
 *             "[email protected]",
 *         },
 *         NotifyOnlyBrokenPipelines = true,
 *         BranchesToBeNotified = "all",
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-gitlab/sdk/v8/go/gitlab"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		awesomeProject, err := gitlab.NewProject(ctx, "awesome_project", &gitlab.ProjectArgs{
 * 			Name:            pulumi.String("awesome_project"),
 * 			Description:     pulumi.String("My awesome project."),
 * 			VisibilityLevel: pulumi.String("public"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = gitlab.NewServicePipelinesEmail(ctx, "email", &gitlab.ServicePipelinesEmailArgs{
 * 			Project: awesomeProject.ID(),
 * 			Recipients: pulumi.StringArray{
 * 				pulumi.String("[email protected]"),
 * 			},
 * 			NotifyOnlyBrokenPipelines: pulumi.Bool(true),
 * 			BranchesToBeNotified:      pulumi.String("all"),
 * 		})
 * 		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.gitlab.Project;
 * import com.pulumi.gitlab.ProjectArgs;
 * import com.pulumi.gitlab.ServicePipelinesEmail;
 * import com.pulumi.gitlab.ServicePipelinesEmailArgs;
 * 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 awesomeProject = new Project("awesomeProject", ProjectArgs.builder()
 *             .name("awesome_project")
 *             .description("My awesome project.")
 *             .visibilityLevel("public")
 *             .build());
 *         var email = new ServicePipelinesEmail("email", ServicePipelinesEmailArgs.builder()
 *             .project(awesomeProject.id())
 *             .recipients("[email protected]")
 *             .notifyOnlyBrokenPipelines(true)
 *             .branchesToBeNotified("all")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   awesomeProject:
 *     type: gitlab:Project
 *     name: awesome_project
 *     properties:
 *       name: awesome_project
 *       description: My awesome project.
 *       visibilityLevel: public
 *   email:
 *     type: gitlab:ServicePipelinesEmail
 *     properties:
 *       project: ${awesomeProject.id}
 *       recipients:
 *         - [email protected]
 *       notifyOnlyBrokenPipelines: true
 *       branchesToBeNotified: all
 * ```
 * 
 * ## Import
 * Starting in Terraform v1.5.0 you can use an import block to import `gitlab_service_pipelines_email`. For example:
 * terraform
 * import {
 *   to = gitlab_service_pipelines_email.example
 *   id = "see CLI command below for ID"
 * }
 * Import using the CLI is supported using the following syntax:
 * You can import a gitlab_service_pipelines_email state using the project ID, e.g.
 * ```sh
 * $ pulumi import gitlab:index/servicePipelinesEmail:ServicePipelinesEmail email 1
 * ```
 */
public class ServicePipelinesEmail internal constructor(
    override val javaResource: com.pulumi.gitlab.ServicePipelinesEmail,
) : KotlinCustomResource(javaResource, ServicePipelinesEmailMapper) {
    /**
     * Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. Default is `default`
     */
    public val branchesToBeNotified: Output?
        get() = javaResource.branchesToBeNotified().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Notify only broken pipelines. Default is true.
     */
    public val notifyOnlyBrokenPipelines: Output?
        get() = javaResource.notifyOnlyBrokenPipelines().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * ID of the project you want to activate integration on.
     */
    public val project: Output
        get() = javaResource.project().applyValue({ args0 -> args0 })

    /**
     * ) email addresses where notifications are sent.
     */
    public val recipients: Output>
        get() = javaResource.recipients().applyValue({ args0 -> args0.map({ args0 -> args0 }) })
}

public object ServicePipelinesEmailMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.gitlab.ServicePipelinesEmail::class == javaResource::class

    override fun map(javaResource: Resource): ServicePipelinesEmail =
        ServicePipelinesEmail(javaResource as com.pulumi.gitlab.ServicePipelinesEmail)
}

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

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