Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Gitlab Provider
  3. API Docs
  4. IntegrationEmailsOnPush
GitLab v8.5.0 published on Friday, Oct 18, 2024 by Pulumi
pulumi/pulumi-gitlab

gitlab.IntegrationEmailsOnPush

Explore with Pulumi AI

gitlab logo
GitLab v8.5.0 published on Friday, Oct 18, 2024 by Pulumi
pulumi/pulumi-gitlab

    The gitlab.IntegrationEmailsOnPush resource allows to manage the lifecycle of a project integration with Emails on Push Service.

    Upstream API: GitLab REST API docs

    Example Usage

    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 emails = new gitlab.IntegrationEmailsOnPush("emails", {
    project: awesomeProject.id,
    recipients: "myrecipient@example.com myotherrecipient@example.com",
});

    import pulumi
import pulumi_gitlab as gitlab

awesome_project = gitlab.Project("awesome_project",
    name="awesome_project",
    description="My awesome project.",
    visibility_level="public")
emails = gitlab.IntegrationEmailsOnPush("emails",
    project=awesome_project.id,
    recipients="myrecipient@example.com myotherrecipient@example.com")

    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.NewIntegrationEmailsOnPush(ctx, "emails", &gitlab.IntegrationEmailsOnPushArgs{
			Project:    awesomeProject.ID(),
			Recipients: pulumi.String("myrecipient@example.com myotherrecipient@example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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 emails = new GitLab.IntegrationEmailsOnPush("emails", new()
    {
        Project = awesomeProject.Id,
        Recipients = "myrecipient@example.com myotherrecipient@example.com",
    });

});

    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.IntegrationEmailsOnPush;
import com.pulumi.gitlab.IntegrationEmailsOnPushArgs;
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 emails = new IntegrationEmailsOnPush("emails", IntegrationEmailsOnPushArgs.builder()
            .project(awesomeProject.id())
            .recipients("myrecipient@example.com myotherrecipient@example.com")
            .build());

    }
}

    resources:
  awesomeProject:
    type: gitlab:Project
    name: awesome_project
    properties:
      name: awesome_project
      description: My awesome project.
      visibilityLevel: public
  emails:
    type: gitlab:IntegrationEmailsOnPush
    properties:
      project: ${awesomeProject.id}
      recipients: myrecipient@example.com myotherrecipient@example.com

    Create IntegrationEmailsOnPush Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IntegrationEmailsOnPush(name: string, args: IntegrationEmailsOnPushArgs, opts?: CustomResourceOptions);
    @overload
def IntegrationEmailsOnPush(resource_name: str,
                            args: IntegrationEmailsOnPushArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def IntegrationEmailsOnPush(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            project: Optional[str] = None,
                            recipients: Optional[str] = None,
                            branches_to_be_notified: Optional[str] = None,
                            disable_diffs: Optional[bool] = None,
                            push_events: Optional[bool] = None,
                            send_from_committer_email: Optional[bool] = None,
                            tag_push_events: Optional[bool] = None)
    func NewIntegrationEmailsOnPush(ctx *Context, name string, args IntegrationEmailsOnPushArgs, opts ...ResourceOption) (*IntegrationEmailsOnPush, error)
    public IntegrationEmailsOnPush(string name, IntegrationEmailsOnPushArgs args, CustomResourceOptions? opts = null)
    public IntegrationEmailsOnPush(String name, IntegrationEmailsOnPushArgs args)
public IntegrationEmailsOnPush(String name, IntegrationEmailsOnPushArgs args, CustomResourceOptions options)

    type: gitlab:IntegrationEmailsOnPush
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args IntegrationEmailsOnPushArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IntegrationEmailsOnPushArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IntegrationEmailsOnPushArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IntegrationEmailsOnPushArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IntegrationEmailsOnPushArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var integrationEmailsOnPushResource = new GitLab.IntegrationEmailsOnPush("integrationEmailsOnPushResource", new()
{
    Project = "string",
    Recipients = "string",
    BranchesToBeNotified = "string",
    DisableDiffs = false,
    PushEvents = false,
    SendFromCommitterEmail = false,
    TagPushEvents = false,
});

    example, err := gitlab.NewIntegrationEmailsOnPush(ctx, "integrationEmailsOnPushResource", &gitlab.IntegrationEmailsOnPushArgs{
	Project:                pulumi.String("string"),
	Recipients:             pulumi.String("string"),
	BranchesToBeNotified:   pulumi.String("string"),
	DisableDiffs:           pulumi.Bool(false),
	PushEvents:             pulumi.Bool(false),
	SendFromCommitterEmail: pulumi.Bool(false),
	TagPushEvents:          pulumi.Bool(false),
})

    var integrationEmailsOnPushResource = new IntegrationEmailsOnPush("integrationEmailsOnPushResource", IntegrationEmailsOnPushArgs.builder()
    .project("string")
    .recipients("string")
    .branchesToBeNotified("string")
    .disableDiffs(false)
    .pushEvents(false)
    .sendFromCommitterEmail(false)
    .tagPushEvents(false)
    .build());

    integration_emails_on_push_resource = gitlab.IntegrationEmailsOnPush("integrationEmailsOnPushResource",
    project="string",
    recipients="string",
    branches_to_be_notified="string",
    disable_diffs=False,
    push_events=False,
    send_from_committer_email=False,
    tag_push_events=False)

    const integrationEmailsOnPushResource = new gitlab.IntegrationEmailsOnPush("integrationEmailsOnPushResource", {
    project: "string",
    recipients: "string",
    branchesToBeNotified: "string",
    disableDiffs: false,
    pushEvents: false,
    sendFromCommitterEmail: false,
    tagPushEvents: false,
});

    type: gitlab:IntegrationEmailsOnPush
properties:
    branchesToBeNotified: string
    disableDiffs: false
    project: string
    pushEvents: false
    recipients: string
    sendFromCommitterEmail: false
    tagPushEvents: false

    IntegrationEmailsOnPush Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The IntegrationEmailsOnPush resource accepts the following input properties:

    Project string
    ID or full-path of the project you want to activate integration on.
    Recipients string
    Emails separated by whitespace.
    BranchesToBeNotified string
    Branches to send notifications for. Valid options are all, default, protected, default_and_protected. Notifications are always fired for tag pushes.
    DisableDiffs bool
    Disable code diffs.
    PushEvents bool
    Enable notifications for push events.
    SendFromCommitterEmail bool
    Send from committer.
    TagPushEvents bool
    Enable notifications for tag push events.
    Project string
    ID or full-path of the project you want to activate integration on.
    Recipients string
    Emails separated by whitespace.
    BranchesToBeNotified string
    Branches to send notifications for. Valid options are all, default, protected, default_and_protected. Notifications are always fired for tag pushes.
    DisableDiffs bool
    Disable code diffs.
    PushEvents bool
    Enable notifications for push events.
    SendFromCommitterEmail bool
    Send from committer.
    TagPushEvents bool
    Enable notifications for tag push events.
    project String
    ID or full-path of the project you want to activate integration on.
    recipients String
    Emails separated by whitespace.
    branchesToBeNotified String
    Branches to send notifications for. Valid options are all, default, protected, default_and_protected. Notifications are always fired for tag pushes.
    disableDiffs Boolean
    Disable code diffs.
    pushEvents Boolean
    Enable notifications for push events.
    sendFromCommitterEmail Boolean
    Send from committer.
    tagPushEvents Boolean
    Enable notifications for tag push events.
    project string
    ID or full-path of the project you want to activate integration on.
    recipients string
    Emails separated by whitespace.
    branchesToBeNotified string
    Branches to send notifications for. Valid options are all, default, protected, default_and_protected. Notifications are always fired for tag pushes.
    disableDiffs boolean
    Disable code diffs.
    pushEvents boolean
    Enable notifications for push events.
    sendFromCommitterEmail boolean
    Send from committer.
    tagPushEvents boolean
    Enable notifications for tag push events.
    project str
    ID or full-path of the project you want to activate integration on.
    recipients str
    Emails separated by whitespace.
    branches_to_be_notified str
    Branches to send notifications for. Valid options are all, default, protected, default_and_protected. Notifications are always fired for tag pushes.
    disable_diffs bool
    Disable code diffs.
    push_events bool
    Enable notifications for push events.
    send_from_committer_email bool
    Send from committer.
    tag_push_events bool
    Enable notifications for tag push events.
    project String
    ID or full-path of the project you want to activate integration on.
    recipients String
    Emails separated by whitespace.
    branchesToBeNotified String
    Branches to send notifications for. Valid options are all, default, protected, default_and_protected. Notifications are always fired for tag pushes.
    disableDiffs Boolean
    Disable code diffs.
    pushEvents Boolean
    Enable notifications for push events.
    sendFromCommitterEmail Boolean
    Send from committer.
    tagPushEvents Boolean
    Enable notifications for tag push events.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IntegrationEmailsOnPush resource produces the following output properties:

    Active bool
    Whether the integration is active.
    CreatedAt string
    The ISO8601 date/time that this integration was activated at in UTC.
    Id string
    The provider-assigned unique ID for this managed resource.
    Slug string
    The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
    Title string
    Title of the integration.
    UpdatedAt string
    The ISO8601 date/time that this integration was last updated at in UTC.
    Active bool
    Whether the integration is active.
    CreatedAt string
    The ISO8601 date/time that this integration was activated at in UTC.
    Id string
    The provider-assigned unique ID for this managed resource.
    Slug string
    The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
    Title string
    Title of the integration.
    UpdatedAt string
    The ISO8601 date/time that this integration was last updated at in UTC.
    active Boolean
    Whether the integration is active.
    createdAt String
    The ISO8601 date/time that this integration was activated at in UTC.
    id String
    The provider-assigned unique ID for this managed resource.
    slug String
    The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
    title String
    Title of the integration.
    updatedAt String
    The ISO8601 date/time that this integration was last updated at in UTC.
    active boolean
    Whether the integration is active.
    createdAt string
    The ISO8601 date/time that this integration was activated at in UTC.
    id string
    The provider-assigned unique ID for this managed resource.
    slug string
    The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
    title string
    Title of the integration.
    updatedAt string
    The ISO8601 date/time that this integration was last updated at in UTC.
    active bool
    Whether the integration is active.
    created_at str
    The ISO8601 date/time that this integration was activated at in UTC.
    id str
    The provider-assigned unique ID for this managed resource.
    slug str
    The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
    title str
    Title of the integration.
    updated_at str
    The ISO8601 date/time that this integration was last updated at in UTC.
    active Boolean
    Whether the integration is active.
    createdAt String
    The ISO8601 date/time that this integration was activated at in UTC.
    id String
    The provider-assigned unique ID for this managed resource.
    slug String
    The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
    title String
    Title of the integration.
    updatedAt String
    The ISO8601 date/time that this integration was last updated at in UTC.

    Look up Existing IntegrationEmailsOnPush Resource

    Get an existing IntegrationEmailsOnPush resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: IntegrationEmailsOnPushState, opts?: CustomResourceOptions): IntegrationEmailsOnPush
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        branches_to_be_notified: Optional[str] = None,
        created_at: Optional[str] = None,
        disable_diffs: Optional[bool] = None,
        project: Optional[str] = None,
        push_events: Optional[bool] = None,
        recipients: Optional[str] = None,
        send_from_committer_email: Optional[bool] = None,
        slug: Optional[str] = None,
        tag_push_events: Optional[bool] = None,
        title: Optional[str] = None,
        updated_at: Optional[str] = None) -> IntegrationEmailsOnPush
    func GetIntegrationEmailsOnPush(ctx *Context, name string, id IDInput, state *IntegrationEmailsOnPushState, opts ...ResourceOption) (*IntegrationEmailsOnPush, error)
    public static IntegrationEmailsOnPush Get(string name, Input<string> id, IntegrationEmailsOnPushState? state, CustomResourceOptions? opts = null)
    public static IntegrationEmailsOnPush get(String name, Output<String> id, IntegrationEmailsOnPushState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Active bool
    Whether the integration is active.
    BranchesToBeNotified string
    Branches to send notifications for. Valid options are all, default, protected, default_and_protected. Notifications are always fired for tag pushes.
    CreatedAt string
    The ISO8601 date/time that this integration was activated at in UTC.
    DisableDiffs bool
    Disable code diffs.
    Project string
    ID or full-path of the project you want to activate integration on.
    PushEvents bool
    Enable notifications for push events.
    Recipients string
    Emails separated by whitespace.
    SendFromCommitterEmail bool
    Send from committer.
    Slug string
    The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
    TagPushEvents bool
    Enable notifications for tag push events.
    Title string
    Title of the integration.
    UpdatedAt string
    The ISO8601 date/time that this integration was last updated at in UTC.
    Active bool
    Whether the integration is active.
    BranchesToBeNotified string
    Branches to send notifications for. Valid options are all, default, protected, default_and_protected. Notifications are always fired for tag pushes.
    CreatedAt string
    The ISO8601 date/time that this integration was activated at in UTC.
    DisableDiffs bool
    Disable code diffs.
    Project string
    ID or full-path of the project you want to activate integration on.
    PushEvents bool
    Enable notifications for push events.
    Recipients string
    Emails separated by whitespace.
    SendFromCommitterEmail bool
    Send from committer.
    Slug string
    The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
    TagPushEvents bool
    Enable notifications for tag push events.
    Title string
    Title of the integration.
    UpdatedAt string
    The ISO8601 date/time that this integration was last updated at in UTC.
    active Boolean
    Whether the integration is active.
    branchesToBeNotified String
    Branches to send notifications for. Valid options are all, default, protected, default_and_protected. Notifications are always fired for tag pushes.
    createdAt String
    The ISO8601 date/time that this integration was activated at in UTC.
    disableDiffs Boolean
    Disable code diffs.
    project String
    ID or full-path of the project you want to activate integration on.
    pushEvents Boolean
    Enable notifications for push events.
    recipients String
    Emails separated by whitespace.
    sendFromCommitterEmail Boolean
    Send from committer.
    slug String
    The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
    tagPushEvents Boolean
    Enable notifications for tag push events.
    title String
    Title of the integration.
    updatedAt String
    The ISO8601 date/time that this integration was last updated at in UTC.
    active boolean
    Whether the integration is active.
    branchesToBeNotified string
    Branches to send notifications for. Valid options are all, default, protected, default_and_protected. Notifications are always fired for tag pushes.
    createdAt string
    The ISO8601 date/time that this integration was activated at in UTC.
    disableDiffs boolean
    Disable code diffs.
    project string
    ID or full-path of the project you want to activate integration on.
    pushEvents boolean
    Enable notifications for push events.
    recipients string
    Emails separated by whitespace.
    sendFromCommitterEmail boolean
    Send from committer.
    slug string
    The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
    tagPushEvents boolean
    Enable notifications for tag push events.
    title string
    Title of the integration.
    updatedAt string
    The ISO8601 date/time that this integration was last updated at in UTC.
    active bool
    Whether the integration is active.
    branches_to_be_notified str
    Branches to send notifications for. Valid options are all, default, protected, default_and_protected. Notifications are always fired for tag pushes.
    created_at str
    The ISO8601 date/time that this integration was activated at in UTC.
    disable_diffs bool
    Disable code diffs.
    project str
    ID or full-path of the project you want to activate integration on.
    push_events bool
    Enable notifications for push events.
    recipients str
    Emails separated by whitespace.
    send_from_committer_email bool
    Send from committer.
    slug str
    The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
    tag_push_events bool
    Enable notifications for tag push events.
    title str
    Title of the integration.
    updated_at str
    The ISO8601 date/time that this integration was last updated at in UTC.
    active Boolean
    Whether the integration is active.
    branchesToBeNotified String
    Branches to send notifications for. Valid options are all, default, protected, default_and_protected. Notifications are always fired for tag pushes.
    createdAt String
    The ISO8601 date/time that this integration was activated at in UTC.
    disableDiffs Boolean
    Disable code diffs.
    project String
    ID or full-path of the project you want to activate integration on.
    pushEvents Boolean
    Enable notifications for push events.
    recipients String
    Emails separated by whitespace.
    sendFromCommitterEmail Boolean
    Send from committer.
    slug String
    The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
    tagPushEvents Boolean
    Enable notifications for tag push events.
    title String
    Title of the integration.
    updatedAt String
    The ISO8601 date/time that this integration was last updated at in UTC.

    Import

    You can import a gitlab_integration_emails_on_push state using the project ID, e.g.

    $ pulumi import gitlab:index/integrationEmailsOnPush:IntegrationEmailsOnPush emails 1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    GitLab pulumi/pulumi-gitlab
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the gitlab Terraform Provider.
    gitlab logo
    GitLab v8.5.0 published on Friday, Oct 18, 2024 by Pulumi
    pulumi/pulumi-gitlab