Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Gitlab Provider
  3. API Docs
  4. ProjectEnvironment
GitLab v8.11.0 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-gitlab

gitlab.ProjectEnvironment

Explore with Pulumi AI

GitLab v8.11.0 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-gitlab

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const _this = new gitlab.Group("this", {
    name: "example",
    path: "example",
    description: "An example group",
});
const thisProject = new gitlab.Project("this", {
    name: "example",
    namespaceId: _this.id,
    initializeWithReadme: true,
});
const thisProjectEnvironment = new gitlab.ProjectEnvironment("this", {
    project: thisProject.id,
    name: "example",
    externalUrl: "www.example.com",
});
Copy
import pulumi
import pulumi_gitlab as gitlab

this = gitlab.Group("this",
    name="example",
    path="example",
    description="An example group")
this_project = gitlab.Project("this",
    name="example",
    namespace_id=this.id,
    initialize_with_readme=True)
this_project_environment = gitlab.ProjectEnvironment("this",
    project=this_project.id,
    name="example",
    external_url="www.example.com")
Copy
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 {
		this, err := gitlab.NewGroup(ctx, "this", &gitlab.GroupArgs{
			Name:        pulumi.String("example"),
			Path:        pulumi.String("example"),
			Description: pulumi.String("An example group"),
		})
		if err != nil {
			return err
		}
		thisProject, err := gitlab.NewProject(ctx, "this", &gitlab.ProjectArgs{
			Name:                 pulumi.String("example"),
			NamespaceId:          this.ID(),
			InitializeWithReadme: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = gitlab.NewProjectEnvironment(ctx, "this", &gitlab.ProjectEnvironmentArgs{
			Project:     thisProject.ID(),
			Name:        pulumi.String("example"),
			ExternalUrl: pulumi.String("www.example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;

return await Deployment.RunAsync(() => 
{
    var @this = new GitLab.Group("this", new()
    {
        Name = "example",
        Path = "example",
        Description = "An example group",
    });

    var thisProject = new GitLab.Project("this", new()
    {
        Name = "example",
        NamespaceId = @this.Id,
        InitializeWithReadme = true,
    });

    var thisProjectEnvironment = new GitLab.ProjectEnvironment("this", new()
    {
        Project = thisProject.Id,
        Name = "example",
        ExternalUrl = "www.example.com",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.Group;
import com.pulumi.gitlab.GroupArgs;
import com.pulumi.gitlab.Project;
import com.pulumi.gitlab.ProjectArgs;
import com.pulumi.gitlab.ProjectEnvironment;
import com.pulumi.gitlab.ProjectEnvironmentArgs;
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 this_ = new Group("this", GroupArgs.builder()
            .name("example")
            .path("example")
            .description("An example group")
            .build());

        var thisProject = new Project("thisProject", ProjectArgs.builder()
            .name("example")
            .namespaceId(this_.id())
            .initializeWithReadme(true)
            .build());

        var thisProjectEnvironment = new ProjectEnvironment("thisProjectEnvironment", ProjectEnvironmentArgs.builder()
            .project(thisProject.id())
            .name("example")
            .externalUrl("www.example.com")
            .build());

    }
}
Copy
resources:
  this:
    type: gitlab:Group
    properties:
      name: example
      path: example
      description: An example group
  thisProject:
    type: gitlab:Project
    name: this
    properties:
      name: example
      namespaceId: ${this.id}
      initializeWithReadme: true
  thisProjectEnvironment:
    type: gitlab:ProjectEnvironment
    name: this
    properties:
      project: ${thisProject.id}
      name: example
      externalUrl: www.example.com
Copy

Create ProjectEnvironment Resource

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

Constructor syntax

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

@overload
def ProjectEnvironment(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       project: Optional[str] = None,
                       auto_stop_setting: Optional[str] = None,
                       cluster_agent_id: Optional[int] = None,
                       description: Optional[str] = None,
                       external_url: Optional[str] = None,
                       flux_resource_path: Optional[str] = None,
                       kubernetes_namespace: Optional[str] = None,
                       name: Optional[str] = None,
                       stop_before_destroy: Optional[bool] = None,
                       tier: Optional[str] = None)
func NewProjectEnvironment(ctx *Context, name string, args ProjectEnvironmentArgs, opts ...ResourceOption) (*ProjectEnvironment, error)
public ProjectEnvironment(string name, ProjectEnvironmentArgs args, CustomResourceOptions? opts = null)
public ProjectEnvironment(String name, ProjectEnvironmentArgs args)
public ProjectEnvironment(String name, ProjectEnvironmentArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ProjectEnvironmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ProjectEnvironmentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ProjectEnvironmentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ProjectEnvironmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ProjectEnvironmentArgs
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 projectEnvironmentResource = new GitLab.ProjectEnvironment("projectEnvironmentResource", new()
{
    Project = "string",
    AutoStopSetting = "string",
    ClusterAgentId = 0,
    Description = "string",
    ExternalUrl = "string",
    FluxResourcePath = "string",
    KubernetesNamespace = "string",
    Name = "string",
    StopBeforeDestroy = false,
    Tier = "string",
});
Copy
example, err := gitlab.NewProjectEnvironment(ctx, "projectEnvironmentResource", &gitlab.ProjectEnvironmentArgs{
	Project:             pulumi.String("string"),
	AutoStopSetting:     pulumi.String("string"),
	ClusterAgentId:      pulumi.Int(0),
	Description:         pulumi.String("string"),
	ExternalUrl:         pulumi.String("string"),
	FluxResourcePath:    pulumi.String("string"),
	KubernetesNamespace: pulumi.String("string"),
	Name:                pulumi.String("string"),
	StopBeforeDestroy:   pulumi.Bool(false),
	Tier:                pulumi.String("string"),
})
Copy
var projectEnvironmentResource = new ProjectEnvironment("projectEnvironmentResource", ProjectEnvironmentArgs.builder()
    .project("string")
    .autoStopSetting("string")
    .clusterAgentId(0)
    .description("string")
    .externalUrl("string")
    .fluxResourcePath("string")
    .kubernetesNamespace("string")
    .name("string")
    .stopBeforeDestroy(false)
    .tier("string")
    .build());
Copy
project_environment_resource = gitlab.ProjectEnvironment("projectEnvironmentResource",
    project="string",
    auto_stop_setting="string",
    cluster_agent_id=0,
    description="string",
    external_url="string",
    flux_resource_path="string",
    kubernetes_namespace="string",
    name="string",
    stop_before_destroy=False,
    tier="string")
Copy
const projectEnvironmentResource = new gitlab.ProjectEnvironment("projectEnvironmentResource", {
    project: "string",
    autoStopSetting: "string",
    clusterAgentId: 0,
    description: "string",
    externalUrl: "string",
    fluxResourcePath: "string",
    kubernetesNamespace: "string",
    name: "string",
    stopBeforeDestroy: false,
    tier: "string",
});
Copy
type: gitlab:ProjectEnvironment
properties:
    autoStopSetting: string
    clusterAgentId: 0
    description: string
    externalUrl: string
    fluxResourcePath: string
    kubernetesNamespace: string
    name: string
    project: string
    stopBeforeDestroy: false
    tier: string
Copy

ProjectEnvironment 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 ProjectEnvironment resource accepts the following input properties:

Project
This property is required.
Changes to this property will trigger replacement.
string
The ID or full path of the project to environment is created for.
AutoStopSetting string
The auto stop setting for the environment. Allowed values are always, with_action. If this is set to with_action and stop_before_destroy is true, the environment will be force-stopped.
ClusterAgentId int
The cluster agent to associate with this environment.
Description string
The description of the environment.
ExternalUrl string
Place to link to for this environment.
FluxResourcePath string
The Flux resource path to associate with this environment.
KubernetesNamespace string
The Kubernetes namespace to associate with this environment.
Name Changes to this property will trigger replacement. string
The name of the environment.
StopBeforeDestroy bool
Determines whether the environment is attempted to be stopped before the environment is deleted. If auto_stop_setting is set to with_action, this will perform a force stop.
Tier string
The tier of the new environment. Valid values are production, staging, testing, development, other.
Project
This property is required.
Changes to this property will trigger replacement.
string
The ID or full path of the project to environment is created for.
AutoStopSetting string
The auto stop setting for the environment. Allowed values are always, with_action. If this is set to with_action and stop_before_destroy is true, the environment will be force-stopped.
ClusterAgentId int
The cluster agent to associate with this environment.
Description string
The description of the environment.
ExternalUrl string
Place to link to for this environment.
FluxResourcePath string
The Flux resource path to associate with this environment.
KubernetesNamespace string
The Kubernetes namespace to associate with this environment.
Name Changes to this property will trigger replacement. string
The name of the environment.
StopBeforeDestroy bool
Determines whether the environment is attempted to be stopped before the environment is deleted. If auto_stop_setting is set to with_action, this will perform a force stop.
Tier string
The tier of the new environment. Valid values are production, staging, testing, development, other.
project
This property is required.
Changes to this property will trigger replacement.
String
The ID or full path of the project to environment is created for.
autoStopSetting String
The auto stop setting for the environment. Allowed values are always, with_action. If this is set to with_action and stop_before_destroy is true, the environment will be force-stopped.
clusterAgentId Integer
The cluster agent to associate with this environment.
description String
The description of the environment.
externalUrl String
Place to link to for this environment.
fluxResourcePath String
The Flux resource path to associate with this environment.
kubernetesNamespace String
The Kubernetes namespace to associate with this environment.
name Changes to this property will trigger replacement. String
The name of the environment.
stopBeforeDestroy Boolean
Determines whether the environment is attempted to be stopped before the environment is deleted. If auto_stop_setting is set to with_action, this will perform a force stop.
tier String
The tier of the new environment. Valid values are production, staging, testing, development, other.
project
This property is required.
Changes to this property will trigger replacement.
string
The ID or full path of the project to environment is created for.
autoStopSetting string
The auto stop setting for the environment. Allowed values are always, with_action. If this is set to with_action and stop_before_destroy is true, the environment will be force-stopped.
clusterAgentId number
The cluster agent to associate with this environment.
description string
The description of the environment.
externalUrl string
Place to link to for this environment.
fluxResourcePath string
The Flux resource path to associate with this environment.
kubernetesNamespace string
The Kubernetes namespace to associate with this environment.
name Changes to this property will trigger replacement. string
The name of the environment.
stopBeforeDestroy boolean
Determines whether the environment is attempted to be stopped before the environment is deleted. If auto_stop_setting is set to with_action, this will perform a force stop.
tier string
The tier of the new environment. Valid values are production, staging, testing, development, other.
project
This property is required.
Changes to this property will trigger replacement.
str
The ID or full path of the project to environment is created for.
auto_stop_setting str
The auto stop setting for the environment. Allowed values are always, with_action. If this is set to with_action and stop_before_destroy is true, the environment will be force-stopped.
cluster_agent_id int
The cluster agent to associate with this environment.
description str
The description of the environment.
external_url str
Place to link to for this environment.
flux_resource_path str
The Flux resource path to associate with this environment.
kubernetes_namespace str
The Kubernetes namespace to associate with this environment.
name Changes to this property will trigger replacement. str
The name of the environment.
stop_before_destroy bool
Determines whether the environment is attempted to be stopped before the environment is deleted. If auto_stop_setting is set to with_action, this will perform a force stop.
tier str
The tier of the new environment. Valid values are production, staging, testing, development, other.
project
This property is required.
Changes to this property will trigger replacement.
String
The ID or full path of the project to environment is created for.
autoStopSetting String
The auto stop setting for the environment. Allowed values are always, with_action. If this is set to with_action and stop_before_destroy is true, the environment will be force-stopped.
clusterAgentId Number
The cluster agent to associate with this environment.
description String
The description of the environment.
externalUrl String
Place to link to for this environment.
fluxResourcePath String
The Flux resource path to associate with this environment.
kubernetesNamespace String
The Kubernetes namespace to associate with this environment.
name Changes to this property will trigger replacement. String
The name of the environment.
stopBeforeDestroy Boolean
Determines whether the environment is attempted to be stopped before the environment is deleted. If auto_stop_setting is set to with_action, this will perform a force stop.
tier String
The tier of the new environment. Valid values are production, staging, testing, development, other.

Outputs

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

AutoStopAt string
The ISO8601 date/time that this environment will be automatically stopped at in UTC.
CreatedAt string
The ISO8601 date/time that this environment was created at in UTC.
Id string
The provider-assigned unique ID for this managed resource.
Slug string
The name of the environment 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.
State string
State the environment is in. Valid values are available, stopped.
UpdatedAt string
The ISO8601 date/time that this environment was last updated at in UTC.
AutoStopAt string
The ISO8601 date/time that this environment will be automatically stopped at in UTC.
CreatedAt string
The ISO8601 date/time that this environment was created at in UTC.
Id string
The provider-assigned unique ID for this managed resource.
Slug string
The name of the environment 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.
State string
State the environment is in. Valid values are available, stopped.
UpdatedAt string
The ISO8601 date/time that this environment was last updated at in UTC.
autoStopAt String
The ISO8601 date/time that this environment will be automatically stopped at in UTC.
createdAt String
The ISO8601 date/time that this environment was created at in UTC.
id String
The provider-assigned unique ID for this managed resource.
slug String
The name of the environment 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.
state String
State the environment is in. Valid values are available, stopped.
updatedAt String
The ISO8601 date/time that this environment was last updated at in UTC.
autoStopAt string
The ISO8601 date/time that this environment will be automatically stopped at in UTC.
createdAt string
The ISO8601 date/time that this environment was created at in UTC.
id string
The provider-assigned unique ID for this managed resource.
slug string
The name of the environment 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.
state string
State the environment is in. Valid values are available, stopped.
updatedAt string
The ISO8601 date/time that this environment was last updated at in UTC.
auto_stop_at str
The ISO8601 date/time that this environment will be automatically stopped at in UTC.
created_at str
The ISO8601 date/time that this environment was created at in UTC.
id str
The provider-assigned unique ID for this managed resource.
slug str
The name of the environment 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.
state str
State the environment is in. Valid values are available, stopped.
updated_at str
The ISO8601 date/time that this environment was last updated at in UTC.
autoStopAt String
The ISO8601 date/time that this environment will be automatically stopped at in UTC.
createdAt String
The ISO8601 date/time that this environment was created at in UTC.
id String
The provider-assigned unique ID for this managed resource.
slug String
The name of the environment 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.
state String
State the environment is in. Valid values are available, stopped.
updatedAt String
The ISO8601 date/time that this environment was last updated at in UTC.

Look up Existing ProjectEnvironment Resource

Get an existing ProjectEnvironment 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?: ProjectEnvironmentState, opts?: CustomResourceOptions): ProjectEnvironment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_stop_at: Optional[str] = None,
        auto_stop_setting: Optional[str] = None,
        cluster_agent_id: Optional[int] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        external_url: Optional[str] = None,
        flux_resource_path: Optional[str] = None,
        kubernetes_namespace: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        slug: Optional[str] = None,
        state: Optional[str] = None,
        stop_before_destroy: Optional[bool] = None,
        tier: Optional[str] = None,
        updated_at: Optional[str] = None) -> ProjectEnvironment
func GetProjectEnvironment(ctx *Context, name string, id IDInput, state *ProjectEnvironmentState, opts ...ResourceOption) (*ProjectEnvironment, error)
public static ProjectEnvironment Get(string name, Input<string> id, ProjectEnvironmentState? state, CustomResourceOptions? opts = null)
public static ProjectEnvironment get(String name, Output<String> id, ProjectEnvironmentState state, CustomResourceOptions options)
resources:  _:    type: gitlab:ProjectEnvironment    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AutoStopAt string
The ISO8601 date/time that this environment will be automatically stopped at in UTC.
AutoStopSetting string
The auto stop setting for the environment. Allowed values are always, with_action. If this is set to with_action and stop_before_destroy is true, the environment will be force-stopped.
ClusterAgentId int
The cluster agent to associate with this environment.
CreatedAt string
The ISO8601 date/time that this environment was created at in UTC.
Description string
The description of the environment.
ExternalUrl string
Place to link to for this environment.
FluxResourcePath string
The Flux resource path to associate with this environment.
KubernetesNamespace string
The Kubernetes namespace to associate with this environment.
Name Changes to this property will trigger replacement. string
The name of the environment.
Project Changes to this property will trigger replacement. string
The ID or full path of the project to environment is created for.
Slug string
The name of the environment 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.
State string
State the environment is in. Valid values are available, stopped.
StopBeforeDestroy bool
Determines whether the environment is attempted to be stopped before the environment is deleted. If auto_stop_setting is set to with_action, this will perform a force stop.
Tier string
The tier of the new environment. Valid values are production, staging, testing, development, other.
UpdatedAt string
The ISO8601 date/time that this environment was last updated at in UTC.
AutoStopAt string
The ISO8601 date/time that this environment will be automatically stopped at in UTC.
AutoStopSetting string
The auto stop setting for the environment. Allowed values are always, with_action. If this is set to with_action and stop_before_destroy is true, the environment will be force-stopped.
ClusterAgentId int
The cluster agent to associate with this environment.
CreatedAt string
The ISO8601 date/time that this environment was created at in UTC.
Description string
The description of the environment.
ExternalUrl string
Place to link to for this environment.
FluxResourcePath string
The Flux resource path to associate with this environment.
KubernetesNamespace string
The Kubernetes namespace to associate with this environment.
Name Changes to this property will trigger replacement. string
The name of the environment.
Project Changes to this property will trigger replacement. string
The ID or full path of the project to environment is created for.
Slug string
The name of the environment 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.
State string
State the environment is in. Valid values are available, stopped.
StopBeforeDestroy bool
Determines whether the environment is attempted to be stopped before the environment is deleted. If auto_stop_setting is set to with_action, this will perform a force stop.
Tier string
The tier of the new environment. Valid values are production, staging, testing, development, other.
UpdatedAt string
The ISO8601 date/time that this environment was last updated at in UTC.
autoStopAt String
The ISO8601 date/time that this environment will be automatically stopped at in UTC.
autoStopSetting String
The auto stop setting for the environment. Allowed values are always, with_action. If this is set to with_action and stop_before_destroy is true, the environment will be force-stopped.
clusterAgentId Integer
The cluster agent to associate with this environment.
createdAt String
The ISO8601 date/time that this environment was created at in UTC.
description String
The description of the environment.
externalUrl String
Place to link to for this environment.
fluxResourcePath String
The Flux resource path to associate with this environment.
kubernetesNamespace String
The Kubernetes namespace to associate with this environment.
name Changes to this property will trigger replacement. String
The name of the environment.
project Changes to this property will trigger replacement. String
The ID or full path of the project to environment is created for.
slug String
The name of the environment 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.
state String
State the environment is in. Valid values are available, stopped.
stopBeforeDestroy Boolean
Determines whether the environment is attempted to be stopped before the environment is deleted. If auto_stop_setting is set to with_action, this will perform a force stop.
tier String
The tier of the new environment. Valid values are production, staging, testing, development, other.
updatedAt String
The ISO8601 date/time that this environment was last updated at in UTC.
autoStopAt string
The ISO8601 date/time that this environment will be automatically stopped at in UTC.
autoStopSetting string
The auto stop setting for the environment. Allowed values are always, with_action. If this is set to with_action and stop_before_destroy is true, the environment will be force-stopped.
clusterAgentId number
The cluster agent to associate with this environment.
createdAt string
The ISO8601 date/time that this environment was created at in UTC.
description string
The description of the environment.
externalUrl string
Place to link to for this environment.
fluxResourcePath string
The Flux resource path to associate with this environment.
kubernetesNamespace string
The Kubernetes namespace to associate with this environment.
name Changes to this property will trigger replacement. string
The name of the environment.
project Changes to this property will trigger replacement. string
The ID or full path of the project to environment is created for.
slug string
The name of the environment 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.
state string
State the environment is in. Valid values are available, stopped.
stopBeforeDestroy boolean
Determines whether the environment is attempted to be stopped before the environment is deleted. If auto_stop_setting is set to with_action, this will perform a force stop.
tier string
The tier of the new environment. Valid values are production, staging, testing, development, other.
updatedAt string
The ISO8601 date/time that this environment was last updated at in UTC.
auto_stop_at str
The ISO8601 date/time that this environment will be automatically stopped at in UTC.
auto_stop_setting str
The auto stop setting for the environment. Allowed values are always, with_action. If this is set to with_action and stop_before_destroy is true, the environment will be force-stopped.
cluster_agent_id int
The cluster agent to associate with this environment.
created_at str
The ISO8601 date/time that this environment was created at in UTC.
description str
The description of the environment.
external_url str
Place to link to for this environment.
flux_resource_path str
The Flux resource path to associate with this environment.
kubernetes_namespace str
The Kubernetes namespace to associate with this environment.
name Changes to this property will trigger replacement. str
The name of the environment.
project Changes to this property will trigger replacement. str
The ID or full path of the project to environment is created for.
slug str
The name of the environment 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.
state str
State the environment is in. Valid values are available, stopped.
stop_before_destroy bool
Determines whether the environment is attempted to be stopped before the environment is deleted. If auto_stop_setting is set to with_action, this will perform a force stop.
tier str
The tier of the new environment. Valid values are production, staging, testing, development, other.
updated_at str
The ISO8601 date/time that this environment was last updated at in UTC.
autoStopAt String
The ISO8601 date/time that this environment will be automatically stopped at in UTC.
autoStopSetting String
The auto stop setting for the environment. Allowed values are always, with_action. If this is set to with_action and stop_before_destroy is true, the environment will be force-stopped.
clusterAgentId Number
The cluster agent to associate with this environment.
createdAt String
The ISO8601 date/time that this environment was created at in UTC.
description String
The description of the environment.
externalUrl String
Place to link to for this environment.
fluxResourcePath String
The Flux resource path to associate with this environment.
kubernetesNamespace String
The Kubernetes namespace to associate with this environment.
name Changes to this property will trigger replacement. String
The name of the environment.
project Changes to this property will trigger replacement. String
The ID or full path of the project to environment is created for.
slug String
The name of the environment 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.
state String
State the environment is in. Valid values are available, stopped.
stopBeforeDestroy Boolean
Determines whether the environment is attempted to be stopped before the environment is deleted. If auto_stop_setting is set to with_action, this will perform a force stop.
tier String
The tier of the new environment. Valid values are production, staging, testing, development, other.
updatedAt String
The ISO8601 date/time that this environment was last updated at in UTC.

Import

Starting in Terraform v1.5.0 you can use an import block to import gitlab_project_environment. For example:

terraform

import {

to = gitlab_project_environment.example

id = “see CLI command below for ID”

}

Import using the CLI is supported using the following syntax:

GitLab project environments can be imported using an id made up of projectId:environmenId, e.g.

$ pulumi import gitlab:index/projectEnvironment:ProjectEnvironment bar 123:321
Copy

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 v8.11.0 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-gitlab