Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Qovery
  3. API Docs
  4. Environment
Qovery v0.41.0 published on Saturday, Sep 28, 2024 by dirien
dirien/pulumi-qovery

qovery.Environment

Explore with Pulumi AI

Qovery v0.41.0 published on Saturday, Sep 28, 2024 by dirien
dirien/pulumi-qovery

# qovery.Environment (Resource)

Provides a Qovery environment resource. This can be used to create and manage Qovery environments.

Example

import * as pulumi from "@pulumi/pulumi";
import * as qovery from "@ediri/qovery";

const myEnvironment = new qovery.Environment("myEnvironment", {
    projectId: qovery_project.my_project.id,
    clusterId: qovery_cluster.my_cluster.id,
    mode: "DEVELOPMENT",
    environmentVariables: [{
        key: "ENV_VAR_KEY",
        value: "ENV_VAR_VALUE",
    }],
    environmentVariableAliases: [{
        key: "ENV_VAR_KEY_ALIAS",
        value: "ENV_VAR_KEY",
    }],
    environmentVariableOverrides: [{
        key: "SOME_PROJECT_VARIABLE",
        value: "OVERRIDDEN_VALUE",
    }],
    secrets: [{
        key: "SECRET_KEY",
        value: "SECRET_VALUE",
    }],
    secretAliases: [{
        key: "SECRET_KEY_ALIAS",
        value: "SECRET_KEY",
    }],
    secretOverrides: [{
        key: "SOME_PROJECT_SECRET",
        value: "OVERRIDDEN_VALUE",
    }],
}, {
    dependsOn: [qovery_project.my_project],
});
Copy
import pulumi
import ediri_qovery as qovery

my_environment = qovery.Environment("myEnvironment",
    project_id=qovery_project["my_project"]["id"],
    cluster_id=qovery_cluster["my_cluster"]["id"],
    mode="DEVELOPMENT",
    environment_variables=[{
        "key": "ENV_VAR_KEY",
        "value": "ENV_VAR_VALUE",
    }],
    environment_variable_aliases=[{
        "key": "ENV_VAR_KEY_ALIAS",
        "value": "ENV_VAR_KEY",
    }],
    environment_variable_overrides=[{
        "key": "SOME_PROJECT_VARIABLE",
        "value": "OVERRIDDEN_VALUE",
    }],
    secrets=[{
        "key": "SECRET_KEY",
        "value": "SECRET_VALUE",
    }],
    secret_aliases=[{
        "key": "SECRET_KEY_ALIAS",
        "value": "SECRET_KEY",
    }],
    secret_overrides=[{
        "key": "SOME_PROJECT_SECRET",
        "value": "OVERRIDDEN_VALUE",
    }],
    opts = pulumi.ResourceOptions(depends_on=[qovery_project["my_project"]]))
Copy
package main

import (
	"github.com/dirien/pulumi-qovery/sdk/go/qovery"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := qovery.NewEnvironment(ctx, "myEnvironment", &qovery.EnvironmentArgs{
			ProjectId: pulumi.Any(qovery_project.My_project.Id),
			ClusterId: pulumi.Any(qovery_cluster.My_cluster.Id),
			Mode:      pulumi.String("DEVELOPMENT"),
			EnvironmentVariables: qovery.EnvironmentEnvironmentVariableArray{
				&qovery.EnvironmentEnvironmentVariableArgs{
					Key:   pulumi.String("ENV_VAR_KEY"),
					Value: pulumi.String("ENV_VAR_VALUE"),
				},
			},
			EnvironmentVariableAliases: qovery.EnvironmentEnvironmentVariableAliasArray{
				&qovery.EnvironmentEnvironmentVariableAliasArgs{
					Key:   pulumi.String("ENV_VAR_KEY_ALIAS"),
					Value: pulumi.String("ENV_VAR_KEY"),
				},
			},
			EnvironmentVariableOverrides: qovery.EnvironmentEnvironmentVariableOverrideArray{
				&qovery.EnvironmentEnvironmentVariableOverrideArgs{
					Key:   pulumi.String("SOME_PROJECT_VARIABLE"),
					Value: pulumi.String("OVERRIDDEN_VALUE"),
				},
			},
			Secrets: qovery.EnvironmentSecretArray{
				&qovery.EnvironmentSecretArgs{
					Key:   pulumi.String("SECRET_KEY"),
					Value: pulumi.String("SECRET_VALUE"),
				},
			},
			SecretAliases: qovery.EnvironmentSecretAliasArray{
				&qovery.EnvironmentSecretAliasArgs{
					Key:   pulumi.String("SECRET_KEY_ALIAS"),
					Value: pulumi.String("SECRET_KEY"),
				},
			},
			SecretOverrides: qovery.EnvironmentSecretOverrideArray{
				&qovery.EnvironmentSecretOverrideArgs{
					Key:   pulumi.String("SOME_PROJECT_SECRET"),
					Value: pulumi.String("OVERRIDDEN_VALUE"),
				},
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			qovery_project.My_project,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Qovery = ediri.Qovery;

return await Deployment.RunAsync(() => 
{
    var myEnvironment = new Qovery.Environment("myEnvironment", new()
    {
        ProjectId = qovery_project.My_project.Id,
        ClusterId = qovery_cluster.My_cluster.Id,
        Mode = "DEVELOPMENT",
        EnvironmentVariables = new[]
        {
            new Qovery.Inputs.EnvironmentEnvironmentVariableArgs
            {
                Key = "ENV_VAR_KEY",
                Value = "ENV_VAR_VALUE",
            },
        },
        EnvironmentVariableAliases = new[]
        {
            new Qovery.Inputs.EnvironmentEnvironmentVariableAliasArgs
            {
                Key = "ENV_VAR_KEY_ALIAS",
                Value = "ENV_VAR_KEY",
            },
        },
        EnvironmentVariableOverrides = new[]
        {
            new Qovery.Inputs.EnvironmentEnvironmentVariableOverrideArgs
            {
                Key = "SOME_PROJECT_VARIABLE",
                Value = "OVERRIDDEN_VALUE",
            },
        },
        Secrets = new[]
        {
            new Qovery.Inputs.EnvironmentSecretArgs
            {
                Key = "SECRET_KEY",
                Value = "SECRET_VALUE",
            },
        },
        SecretAliases = new[]
        {
            new Qovery.Inputs.EnvironmentSecretAliasArgs
            {
                Key = "SECRET_KEY_ALIAS",
                Value = "SECRET_KEY",
            },
        },
        SecretOverrides = new[]
        {
            new Qovery.Inputs.EnvironmentSecretOverrideArgs
            {
                Key = "SOME_PROJECT_SECRET",
                Value = "OVERRIDDEN_VALUE",
            },
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            qovery_project.My_project,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.qovery.Environment;
import com.pulumi.qovery.EnvironmentArgs;
import com.pulumi.qovery.inputs.EnvironmentEnvironmentVariableArgs;
import com.pulumi.qovery.inputs.EnvironmentEnvironmentVariableAliasArgs;
import com.pulumi.qovery.inputs.EnvironmentEnvironmentVariableOverrideArgs;
import com.pulumi.qovery.inputs.EnvironmentSecretArgs;
import com.pulumi.qovery.inputs.EnvironmentSecretAliasArgs;
import com.pulumi.qovery.inputs.EnvironmentSecretOverrideArgs;
import com.pulumi.resources.CustomResourceOptions;
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 myEnvironment = new Environment("myEnvironment", EnvironmentArgs.builder()
            .projectId(qovery_project.my_project().id())
            .clusterId(qovery_cluster.my_cluster().id())
            .mode("DEVELOPMENT")
            .environmentVariables(EnvironmentEnvironmentVariableArgs.builder()
                .key("ENV_VAR_KEY")
                .value("ENV_VAR_VALUE")
                .build())
            .environmentVariableAliases(EnvironmentEnvironmentVariableAliasArgs.builder()
                .key("ENV_VAR_KEY_ALIAS")
                .value("ENV_VAR_KEY")
                .build())
            .environmentVariableOverrides(EnvironmentEnvironmentVariableOverrideArgs.builder()
                .key("SOME_PROJECT_VARIABLE")
                .value("OVERRIDDEN_VALUE")
                .build())
            .secrets(EnvironmentSecretArgs.builder()
                .key("SECRET_KEY")
                .value("SECRET_VALUE")
                .build())
            .secretAliases(EnvironmentSecretAliasArgs.builder()
                .key("SECRET_KEY_ALIAS")
                .value("SECRET_KEY")
                .build())
            .secretOverrides(EnvironmentSecretOverrideArgs.builder()
                .key("SOME_PROJECT_SECRET")
                .value("OVERRIDDEN_VALUE")
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(qovery_project.my_project())
                .build());

    }
}
Copy
resources:
  myEnvironment:
    type: qovery:Environment
    properties:
      # Required
      projectId: ${qovery_project.my_project.id}
      # Optional
      clusterId: ${qovery_cluster.my_cluster.id}
      mode: DEVELOPMENT
      environmentVariables:
        - key: ENV_VAR_KEY
          value: ENV_VAR_VALUE
      environmentVariableAliases:
        - key: ENV_VAR_KEY_ALIAS
          value: ENV_VAR_KEY
      environmentVariableOverrides:
        - key: SOME_PROJECT_VARIABLE
          value: OVERRIDDEN_VALUE
      secrets:
        - key: SECRET_KEY
          value: SECRET_VALUE
      secretAliases:
        - key: SECRET_KEY_ALIAS
          value: SECRET_KEY
      secretOverrides:
        - key: SOME_PROJECT_SECRET
          value: OVERRIDDEN_VALUE
    options:
      dependson:
        - ${qovery_project.my_project}
Copy

You can find complete examples within these repositories:

  • Deploy an Application and Database within 3 environments

Create Environment Resource

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

Constructor syntax

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

@overload
def Environment(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                cluster_id: Optional[str] = None,
                project_id: Optional[str] = None,
                environment_variable_aliases: Optional[Sequence[EnvironmentEnvironmentVariableAliasArgs]] = None,
                environment_variable_overrides: Optional[Sequence[EnvironmentEnvironmentVariableOverrideArgs]] = None,
                environment_variables: Optional[Sequence[EnvironmentEnvironmentVariableArgs]] = None,
                mode: Optional[str] = None,
                name: Optional[str] = None,
                secret_aliases: Optional[Sequence[EnvironmentSecretAliasArgs]] = None,
                secret_overrides: Optional[Sequence[EnvironmentSecretOverrideArgs]] = None,
                secrets: Optional[Sequence[EnvironmentSecretArgs]] = None)
func NewEnvironment(ctx *Context, name string, args EnvironmentArgs, opts ...ResourceOption) (*Environment, error)
public Environment(string name, EnvironmentArgs args, CustomResourceOptions? opts = null)
public Environment(String name, EnvironmentArgs args)
public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)

type: qovery:Environment
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. EnvironmentArgs
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. EnvironmentArgs
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. EnvironmentArgs
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. EnvironmentArgs
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. EnvironmentArgs
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 environmentResource = new Qovery.Environment("environmentResource", new()
{
    ClusterId = "string",
    ProjectId = "string",
    EnvironmentVariableAliases = new[]
    {
        new Qovery.Inputs.EnvironmentEnvironmentVariableAliasArgs
        {
            Key = "string",
            Value = "string",
            Description = "string",
            Id = "string",
        },
    },
    EnvironmentVariableOverrides = new[]
    {
        new Qovery.Inputs.EnvironmentEnvironmentVariableOverrideArgs
        {
            Key = "string",
            Value = "string",
            Description = "string",
            Id = "string",
        },
    },
    EnvironmentVariables = new[]
    {
        new Qovery.Inputs.EnvironmentEnvironmentVariableArgs
        {
            Key = "string",
            Value = "string",
            Description = "string",
            Id = "string",
        },
    },
    Mode = "string",
    Name = "string",
    SecretAliases = new[]
    {
        new Qovery.Inputs.EnvironmentSecretAliasArgs
        {
            Key = "string",
            Value = "string",
            Description = "string",
            Id = "string",
        },
    },
    SecretOverrides = new[]
    {
        new Qovery.Inputs.EnvironmentSecretOverrideArgs
        {
            Key = "string",
            Value = "string",
            Description = "string",
            Id = "string",
        },
    },
    Secrets = new[]
    {
        new Qovery.Inputs.EnvironmentSecretArgs
        {
            Key = "string",
            Value = "string",
            Description = "string",
            Id = "string",
        },
    },
});
Copy
example, err := qovery.NewEnvironment(ctx, "environmentResource", &qovery.EnvironmentArgs{
	ClusterId: pulumi.String("string"),
	ProjectId: pulumi.String("string"),
	EnvironmentVariableAliases: qovery.EnvironmentEnvironmentVariableAliasArray{
		&qovery.EnvironmentEnvironmentVariableAliasArgs{
			Key:         pulumi.String("string"),
			Value:       pulumi.String("string"),
			Description: pulumi.String("string"),
			Id:          pulumi.String("string"),
		},
	},
	EnvironmentVariableOverrides: qovery.EnvironmentEnvironmentVariableOverrideArray{
		&qovery.EnvironmentEnvironmentVariableOverrideArgs{
			Key:         pulumi.String("string"),
			Value:       pulumi.String("string"),
			Description: pulumi.String("string"),
			Id:          pulumi.String("string"),
		},
	},
	EnvironmentVariables: qovery.EnvironmentEnvironmentVariableArray{
		&qovery.EnvironmentEnvironmentVariableArgs{
			Key:         pulumi.String("string"),
			Value:       pulumi.String("string"),
			Description: pulumi.String("string"),
			Id:          pulumi.String("string"),
		},
	},
	Mode: pulumi.String("string"),
	Name: pulumi.String("string"),
	SecretAliases: qovery.EnvironmentSecretAliasArray{
		&qovery.EnvironmentSecretAliasArgs{
			Key:         pulumi.String("string"),
			Value:       pulumi.String("string"),
			Description: pulumi.String("string"),
			Id:          pulumi.String("string"),
		},
	},
	SecretOverrides: qovery.EnvironmentSecretOverrideArray{
		&qovery.EnvironmentSecretOverrideArgs{
			Key:         pulumi.String("string"),
			Value:       pulumi.String("string"),
			Description: pulumi.String("string"),
			Id:          pulumi.String("string"),
		},
	},
	Secrets: qovery.EnvironmentSecretArray{
		&qovery.EnvironmentSecretArgs{
			Key:         pulumi.String("string"),
			Value:       pulumi.String("string"),
			Description: pulumi.String("string"),
			Id:          pulumi.String("string"),
		},
	},
})
Copy
var environmentResource = new Environment("environmentResource", EnvironmentArgs.builder()
    .clusterId("string")
    .projectId("string")
    .environmentVariableAliases(EnvironmentEnvironmentVariableAliasArgs.builder()
        .key("string")
        .value("string")
        .description("string")
        .id("string")
        .build())
    .environmentVariableOverrides(EnvironmentEnvironmentVariableOverrideArgs.builder()
        .key("string")
        .value("string")
        .description("string")
        .id("string")
        .build())
    .environmentVariables(EnvironmentEnvironmentVariableArgs.builder()
        .key("string")
        .value("string")
        .description("string")
        .id("string")
        .build())
    .mode("string")
    .name("string")
    .secretAliases(EnvironmentSecretAliasArgs.builder()
        .key("string")
        .value("string")
        .description("string")
        .id("string")
        .build())
    .secretOverrides(EnvironmentSecretOverrideArgs.builder()
        .key("string")
        .value("string")
        .description("string")
        .id("string")
        .build())
    .secrets(EnvironmentSecretArgs.builder()
        .key("string")
        .value("string")
        .description("string")
        .id("string")
        .build())
    .build());
Copy
environment_resource = qovery.Environment("environmentResource",
    cluster_id="string",
    project_id="string",
    environment_variable_aliases=[{
        "key": "string",
        "value": "string",
        "description": "string",
        "id": "string",
    }],
    environment_variable_overrides=[{
        "key": "string",
        "value": "string",
        "description": "string",
        "id": "string",
    }],
    environment_variables=[{
        "key": "string",
        "value": "string",
        "description": "string",
        "id": "string",
    }],
    mode="string",
    name="string",
    secret_aliases=[{
        "key": "string",
        "value": "string",
        "description": "string",
        "id": "string",
    }],
    secret_overrides=[{
        "key": "string",
        "value": "string",
        "description": "string",
        "id": "string",
    }],
    secrets=[{
        "key": "string",
        "value": "string",
        "description": "string",
        "id": "string",
    }])
Copy
const environmentResource = new qovery.Environment("environmentResource", {
    clusterId: "string",
    projectId: "string",
    environmentVariableAliases: [{
        key: "string",
        value: "string",
        description: "string",
        id: "string",
    }],
    environmentVariableOverrides: [{
        key: "string",
        value: "string",
        description: "string",
        id: "string",
    }],
    environmentVariables: [{
        key: "string",
        value: "string",
        description: "string",
        id: "string",
    }],
    mode: "string",
    name: "string",
    secretAliases: [{
        key: "string",
        value: "string",
        description: "string",
        id: "string",
    }],
    secretOverrides: [{
        key: "string",
        value: "string",
        description: "string",
        id: "string",
    }],
    secrets: [{
        key: "string",
        value: "string",
        description: "string",
        id: "string",
    }],
});
Copy
type: qovery:Environment
properties:
    clusterId: string
    environmentVariableAliases:
        - description: string
          id: string
          key: string
          value: string
    environmentVariableOverrides:
        - description: string
          id: string
          key: string
          value: string
    environmentVariables:
        - description: string
          id: string
          key: string
          value: string
    mode: string
    name: string
    projectId: string
    secretAliases:
        - description: string
          id: string
          key: string
          value: string
    secretOverrides:
        - description: string
          id: string
          key: string
          value: string
    secrets:
        - description: string
          id: string
          key: string
          value: string
Copy

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

ClusterId This property is required. string
Id of the cluster [NOTE: can't be updated after creation].
ProjectId This property is required. string
Id of the project.
EnvironmentVariableAliases List<ediri.Qovery.Inputs.EnvironmentEnvironmentVariableAlias>
List of environment variable aliases linked to this environment.
EnvironmentVariableOverrides List<ediri.Qovery.Inputs.EnvironmentEnvironmentVariableOverride>
List of environment variable overrides linked to this environment.
EnvironmentVariables List<ediri.Qovery.Inputs.EnvironmentEnvironmentVariable>
List of environment variables linked to this environment.
Mode string
Mode of the environment. - Can be: DEVELOPMENT, PREVIEW, PRODUCTION, STAGING. - Default: DEVELOPMENT.
Name string
Name of the environment.
SecretAliases List<ediri.Qovery.Inputs.EnvironmentSecretAlias>
List of secret aliases linked to this environment.
SecretOverrides List<ediri.Qovery.Inputs.EnvironmentSecretOverride>
List of secret overrides linked to this environment.
Secrets List<ediri.Qovery.Inputs.EnvironmentSecret>
List of secrets linked to this environment.
ClusterId This property is required. string
Id of the cluster [NOTE: can't be updated after creation].
ProjectId This property is required. string
Id of the project.
EnvironmentVariableAliases []EnvironmentEnvironmentVariableAliasArgs
List of environment variable aliases linked to this environment.
EnvironmentVariableOverrides []EnvironmentEnvironmentVariableOverrideArgs
List of environment variable overrides linked to this environment.
EnvironmentVariables []EnvironmentEnvironmentVariableArgs
List of environment variables linked to this environment.
Mode string
Mode of the environment. - Can be: DEVELOPMENT, PREVIEW, PRODUCTION, STAGING. - Default: DEVELOPMENT.
Name string
Name of the environment.
SecretAliases []EnvironmentSecretAliasArgs
List of secret aliases linked to this environment.
SecretOverrides []EnvironmentSecretOverrideArgs
List of secret overrides linked to this environment.
Secrets []EnvironmentSecretArgs
List of secrets linked to this environment.
clusterId This property is required. String
Id of the cluster [NOTE: can't be updated after creation].
projectId This property is required. String
Id of the project.
environmentVariableAliases List<EnvironmentEnvironmentVariableAlias>
List of environment variable aliases linked to this environment.
environmentVariableOverrides List<EnvironmentEnvironmentVariableOverride>
List of environment variable overrides linked to this environment.
environmentVariables List<EnvironmentEnvironmentVariable>
List of environment variables linked to this environment.
mode String
Mode of the environment. - Can be: DEVELOPMENT, PREVIEW, PRODUCTION, STAGING. - Default: DEVELOPMENT.
name String
Name of the environment.
secretAliases List<EnvironmentSecretAlias>
List of secret aliases linked to this environment.
secretOverrides List<EnvironmentSecretOverride>
List of secret overrides linked to this environment.
secrets List<EnvironmentSecret>
List of secrets linked to this environment.
clusterId This property is required. string
Id of the cluster [NOTE: can't be updated after creation].
projectId This property is required. string
Id of the project.
environmentVariableAliases EnvironmentEnvironmentVariableAlias[]
List of environment variable aliases linked to this environment.
environmentVariableOverrides EnvironmentEnvironmentVariableOverride[]
List of environment variable overrides linked to this environment.
environmentVariables EnvironmentEnvironmentVariable[]
List of environment variables linked to this environment.
mode string
Mode of the environment. - Can be: DEVELOPMENT, PREVIEW, PRODUCTION, STAGING. - Default: DEVELOPMENT.
name string
Name of the environment.
secretAliases EnvironmentSecretAlias[]
List of secret aliases linked to this environment.
secretOverrides EnvironmentSecretOverride[]
List of secret overrides linked to this environment.
secrets EnvironmentSecret[]
List of secrets linked to this environment.
cluster_id This property is required. str
Id of the cluster [NOTE: can't be updated after creation].
project_id This property is required. str
Id of the project.
environment_variable_aliases Sequence[EnvironmentEnvironmentVariableAliasArgs]
List of environment variable aliases linked to this environment.
environment_variable_overrides Sequence[EnvironmentEnvironmentVariableOverrideArgs]
List of environment variable overrides linked to this environment.
environment_variables Sequence[EnvironmentEnvironmentVariableArgs]
List of environment variables linked to this environment.
mode str
Mode of the environment. - Can be: DEVELOPMENT, PREVIEW, PRODUCTION, STAGING. - Default: DEVELOPMENT.
name str
Name of the environment.
secret_aliases Sequence[EnvironmentSecretAliasArgs]
List of secret aliases linked to this environment.
secret_overrides Sequence[EnvironmentSecretOverrideArgs]
List of secret overrides linked to this environment.
secrets Sequence[EnvironmentSecretArgs]
List of secrets linked to this environment.
clusterId This property is required. String
Id of the cluster [NOTE: can't be updated after creation].
projectId This property is required. String
Id of the project.
environmentVariableAliases List<Property Map>
List of environment variable aliases linked to this environment.
environmentVariableOverrides List<Property Map>
List of environment variable overrides linked to this environment.
environmentVariables List<Property Map>
List of environment variables linked to this environment.
mode String
Mode of the environment. - Can be: DEVELOPMENT, PREVIEW, PRODUCTION, STAGING. - Default: DEVELOPMENT.
name String
Name of the environment.
secretAliases List<Property Map>
List of secret aliases linked to this environment.
secretOverrides List<Property Map>
List of secret overrides linked to this environment.
secrets List<Property Map>
List of secrets linked to this environment.

Outputs

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

BuiltInEnvironmentVariables List<ediri.Qovery.Outputs.EnvironmentBuiltInEnvironmentVariable>
List of built-in environment variables linked to this environment.
Id string
The provider-assigned unique ID for this managed resource.
BuiltInEnvironmentVariables []EnvironmentBuiltInEnvironmentVariable
List of built-in environment variables linked to this environment.
Id string
The provider-assigned unique ID for this managed resource.
builtInEnvironmentVariables List<EnvironmentBuiltInEnvironmentVariable>
List of built-in environment variables linked to this environment.
id String
The provider-assigned unique ID for this managed resource.
builtInEnvironmentVariables EnvironmentBuiltInEnvironmentVariable[]
List of built-in environment variables linked to this environment.
id string
The provider-assigned unique ID for this managed resource.
built_in_environment_variables Sequence[EnvironmentBuiltInEnvironmentVariable]
List of built-in environment variables linked to this environment.
id str
The provider-assigned unique ID for this managed resource.
builtInEnvironmentVariables List<Property Map>
List of built-in environment variables linked to this environment.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Environment Resource

Get an existing Environment 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?: EnvironmentState, opts?: CustomResourceOptions): Environment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        built_in_environment_variables: Optional[Sequence[EnvironmentBuiltInEnvironmentVariableArgs]] = None,
        cluster_id: Optional[str] = None,
        environment_variable_aliases: Optional[Sequence[EnvironmentEnvironmentVariableAliasArgs]] = None,
        environment_variable_overrides: Optional[Sequence[EnvironmentEnvironmentVariableOverrideArgs]] = None,
        environment_variables: Optional[Sequence[EnvironmentEnvironmentVariableArgs]] = None,
        mode: Optional[str] = None,
        name: Optional[str] = None,
        project_id: Optional[str] = None,
        secret_aliases: Optional[Sequence[EnvironmentSecretAliasArgs]] = None,
        secret_overrides: Optional[Sequence[EnvironmentSecretOverrideArgs]] = None,
        secrets: Optional[Sequence[EnvironmentSecretArgs]] = None) -> Environment
func GetEnvironment(ctx *Context, name string, id IDInput, state *EnvironmentState, opts ...ResourceOption) (*Environment, error)
public static Environment Get(string name, Input<string> id, EnvironmentState? state, CustomResourceOptions? opts = null)
public static Environment get(String name, Output<String> id, EnvironmentState state, CustomResourceOptions options)
resources:  _:    type: qovery:Environment    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:
BuiltInEnvironmentVariables List<ediri.Qovery.Inputs.EnvironmentBuiltInEnvironmentVariable>
List of built-in environment variables linked to this environment.
ClusterId string
Id of the cluster [NOTE: can't be updated after creation].
EnvironmentVariableAliases List<ediri.Qovery.Inputs.EnvironmentEnvironmentVariableAlias>
List of environment variable aliases linked to this environment.
EnvironmentVariableOverrides List<ediri.Qovery.Inputs.EnvironmentEnvironmentVariableOverride>
List of environment variable overrides linked to this environment.
EnvironmentVariables List<ediri.Qovery.Inputs.EnvironmentEnvironmentVariable>
List of environment variables linked to this environment.
Mode string
Mode of the environment. - Can be: DEVELOPMENT, PREVIEW, PRODUCTION, STAGING. - Default: DEVELOPMENT.
Name string
Name of the environment.
ProjectId string
Id of the project.
SecretAliases List<ediri.Qovery.Inputs.EnvironmentSecretAlias>
List of secret aliases linked to this environment.
SecretOverrides List<ediri.Qovery.Inputs.EnvironmentSecretOverride>
List of secret overrides linked to this environment.
Secrets List<ediri.Qovery.Inputs.EnvironmentSecret>
List of secrets linked to this environment.
BuiltInEnvironmentVariables []EnvironmentBuiltInEnvironmentVariableArgs
List of built-in environment variables linked to this environment.
ClusterId string
Id of the cluster [NOTE: can't be updated after creation].
EnvironmentVariableAliases []EnvironmentEnvironmentVariableAliasArgs
List of environment variable aliases linked to this environment.
EnvironmentVariableOverrides []EnvironmentEnvironmentVariableOverrideArgs
List of environment variable overrides linked to this environment.
EnvironmentVariables []EnvironmentEnvironmentVariableArgs
List of environment variables linked to this environment.
Mode string
Mode of the environment. - Can be: DEVELOPMENT, PREVIEW, PRODUCTION, STAGING. - Default: DEVELOPMENT.
Name string
Name of the environment.
ProjectId string
Id of the project.
SecretAliases []EnvironmentSecretAliasArgs
List of secret aliases linked to this environment.
SecretOverrides []EnvironmentSecretOverrideArgs
List of secret overrides linked to this environment.
Secrets []EnvironmentSecretArgs
List of secrets linked to this environment.
builtInEnvironmentVariables List<EnvironmentBuiltInEnvironmentVariable>
List of built-in environment variables linked to this environment.
clusterId String
Id of the cluster [NOTE: can't be updated after creation].
environmentVariableAliases List<EnvironmentEnvironmentVariableAlias>
List of environment variable aliases linked to this environment.
environmentVariableOverrides List<EnvironmentEnvironmentVariableOverride>
List of environment variable overrides linked to this environment.
environmentVariables List<EnvironmentEnvironmentVariable>
List of environment variables linked to this environment.
mode String
Mode of the environment. - Can be: DEVELOPMENT, PREVIEW, PRODUCTION, STAGING. - Default: DEVELOPMENT.
name String
Name of the environment.
projectId String
Id of the project.
secretAliases List<EnvironmentSecretAlias>
List of secret aliases linked to this environment.
secretOverrides List<EnvironmentSecretOverride>
List of secret overrides linked to this environment.
secrets List<EnvironmentSecret>
List of secrets linked to this environment.
builtInEnvironmentVariables EnvironmentBuiltInEnvironmentVariable[]
List of built-in environment variables linked to this environment.
clusterId string
Id of the cluster [NOTE: can't be updated after creation].
environmentVariableAliases EnvironmentEnvironmentVariableAlias[]
List of environment variable aliases linked to this environment.
environmentVariableOverrides EnvironmentEnvironmentVariableOverride[]
List of environment variable overrides linked to this environment.
environmentVariables EnvironmentEnvironmentVariable[]
List of environment variables linked to this environment.
mode string
Mode of the environment. - Can be: DEVELOPMENT, PREVIEW, PRODUCTION, STAGING. - Default: DEVELOPMENT.
name string
Name of the environment.
projectId string
Id of the project.
secretAliases EnvironmentSecretAlias[]
List of secret aliases linked to this environment.
secretOverrides EnvironmentSecretOverride[]
List of secret overrides linked to this environment.
secrets EnvironmentSecret[]
List of secrets linked to this environment.
built_in_environment_variables Sequence[EnvironmentBuiltInEnvironmentVariableArgs]
List of built-in environment variables linked to this environment.
cluster_id str
Id of the cluster [NOTE: can't be updated after creation].
environment_variable_aliases Sequence[EnvironmentEnvironmentVariableAliasArgs]
List of environment variable aliases linked to this environment.
environment_variable_overrides Sequence[EnvironmentEnvironmentVariableOverrideArgs]
List of environment variable overrides linked to this environment.
environment_variables Sequence[EnvironmentEnvironmentVariableArgs]
List of environment variables linked to this environment.
mode str
Mode of the environment. - Can be: DEVELOPMENT, PREVIEW, PRODUCTION, STAGING. - Default: DEVELOPMENT.
name str
Name of the environment.
project_id str
Id of the project.
secret_aliases Sequence[EnvironmentSecretAliasArgs]
List of secret aliases linked to this environment.
secret_overrides Sequence[EnvironmentSecretOverrideArgs]
List of secret overrides linked to this environment.
secrets Sequence[EnvironmentSecretArgs]
List of secrets linked to this environment.
builtInEnvironmentVariables List<Property Map>
List of built-in environment variables linked to this environment.
clusterId String
Id of the cluster [NOTE: can't be updated after creation].
environmentVariableAliases List<Property Map>
List of environment variable aliases linked to this environment.
environmentVariableOverrides List<Property Map>
List of environment variable overrides linked to this environment.
environmentVariables List<Property Map>
List of environment variables linked to this environment.
mode String
Mode of the environment. - Can be: DEVELOPMENT, PREVIEW, PRODUCTION, STAGING. - Default: DEVELOPMENT.
name String
Name of the environment.
projectId String
Id of the project.
secretAliases List<Property Map>
List of secret aliases linked to this environment.
secretOverrides List<Property Map>
List of secret overrides linked to this environment.
secrets List<Property Map>
List of secrets linked to this environment.

Supporting Types

EnvironmentBuiltInEnvironmentVariable
, EnvironmentBuiltInEnvironmentVariableArgs

Description string
Description of the environment variable.
Id string
Id of the environment variable.
Key string
Key of the environment variable.
Value string
Value of the environment variable.
Description string
Description of the environment variable.
Id string
Id of the environment variable.
Key string
Key of the environment variable.
Value string
Value of the environment variable.
description String
Description of the environment variable.
id String
Id of the environment variable.
key String
Key of the environment variable.
value String
Value of the environment variable.
description string
Description of the environment variable.
id string
Id of the environment variable.
key string
Key of the environment variable.
value string
Value of the environment variable.
description str
Description of the environment variable.
id str
Id of the environment variable.
key str
Key of the environment variable.
value str
Value of the environment variable.
description String
Description of the environment variable.
id String
Id of the environment variable.
key String
Key of the environment variable.
value String
Value of the environment variable.

EnvironmentEnvironmentVariable
, EnvironmentEnvironmentVariableArgs

Key This property is required. string
Key of the environment variable.
Value This property is required. string
Value of the environment variable.
Description string
Description of the environment variable.
Id string
Id of the environment variable.
Key This property is required. string
Key of the environment variable.
Value This property is required. string
Value of the environment variable.
Description string
Description of the environment variable.
Id string
Id of the environment variable.
key This property is required. String
Key of the environment variable.
value This property is required. String
Value of the environment variable.
description String
Description of the environment variable.
id String
Id of the environment variable.
key This property is required. string
Key of the environment variable.
value This property is required. string
Value of the environment variable.
description string
Description of the environment variable.
id string
Id of the environment variable.
key This property is required. str
Key of the environment variable.
value This property is required. str
Value of the environment variable.
description str
Description of the environment variable.
id str
Id of the environment variable.
key This property is required. String
Key of the environment variable.
value This property is required. String
Value of the environment variable.
description String
Description of the environment variable.
id String
Id of the environment variable.

EnvironmentEnvironmentVariableAlias
, EnvironmentEnvironmentVariableAliasArgs

Key This property is required. string
Name of the environment variable alias.
Value This property is required. string
Name of the variable to alias.
Description string
Description of the environment variable alias.
Id string
Id of the environment variable alias.
Key This property is required. string
Name of the environment variable alias.
Value This property is required. string
Name of the variable to alias.
Description string
Description of the environment variable alias.
Id string
Id of the environment variable alias.
key This property is required. String
Name of the environment variable alias.
value This property is required. String
Name of the variable to alias.
description String
Description of the environment variable alias.
id String
Id of the environment variable alias.
key This property is required. string
Name of the environment variable alias.
value This property is required. string
Name of the variable to alias.
description string
Description of the environment variable alias.
id string
Id of the environment variable alias.
key This property is required. str
Name of the environment variable alias.
value This property is required. str
Name of the variable to alias.
description str
Description of the environment variable alias.
id str
Id of the environment variable alias.
key This property is required. String
Name of the environment variable alias.
value This property is required. String
Name of the variable to alias.
description String
Description of the environment variable alias.
id String
Id of the environment variable alias.

EnvironmentEnvironmentVariableOverride
, EnvironmentEnvironmentVariableOverrideArgs

Key This property is required. string
Name of the environment variable override.
Value This property is required. string
Value of the environment variable override.
Description string
Description of the environment variable override.
Id string
Id of the environment variable override.
Key This property is required. string
Name of the environment variable override.
Value This property is required. string
Value of the environment variable override.
Description string
Description of the environment variable override.
Id string
Id of the environment variable override.
key This property is required. String
Name of the environment variable override.
value This property is required. String
Value of the environment variable override.
description String
Description of the environment variable override.
id String
Id of the environment variable override.
key This property is required. string
Name of the environment variable override.
value This property is required. string
Value of the environment variable override.
description string
Description of the environment variable override.
id string
Id of the environment variable override.
key This property is required. str
Name of the environment variable override.
value This property is required. str
Value of the environment variable override.
description str
Description of the environment variable override.
id str
Id of the environment variable override.
key This property is required. String
Name of the environment variable override.
value This property is required. String
Value of the environment variable override.
description String
Description of the environment variable override.
id String
Id of the environment variable override.

EnvironmentSecret
, EnvironmentSecretArgs

Key This property is required. string
Key of the secret.
Value This property is required. string
Value of the secret.
Description string
Description of the secret.
Id string
Id of the secret.
Key This property is required. string
Key of the secret.
Value This property is required. string
Value of the secret.
Description string
Description of the secret.
Id string
Id of the secret.
key This property is required. String
Key of the secret.
value This property is required. String
Value of the secret.
description String
Description of the secret.
id String
Id of the secret.
key This property is required. string
Key of the secret.
value This property is required. string
Value of the secret.
description string
Description of the secret.
id string
Id of the secret.
key This property is required. str
Key of the secret.
value This property is required. str
Value of the secret.
description str
Description of the secret.
id str
Id of the secret.
key This property is required. String
Key of the secret.
value This property is required. String
Value of the secret.
description String
Description of the secret.
id String
Id of the secret.

EnvironmentSecretAlias
, EnvironmentSecretAliasArgs

Key This property is required. string
Name of the secret alias.
Value This property is required. string
Name of the secret to alias.
Description string
Description of the secret alias.
Id string
Id of the secret alias.
Key This property is required. string
Name of the secret alias.
Value This property is required. string
Name of the secret to alias.
Description string
Description of the secret alias.
Id string
Id of the secret alias.
key This property is required. String
Name of the secret alias.
value This property is required. String
Name of the secret to alias.
description String
Description of the secret alias.
id String
Id of the secret alias.
key This property is required. string
Name of the secret alias.
value This property is required. string
Name of the secret to alias.
description string
Description of the secret alias.
id string
Id of the secret alias.
key This property is required. str
Name of the secret alias.
value This property is required. str
Name of the secret to alias.
description str
Description of the secret alias.
id str
Id of the secret alias.
key This property is required. String
Name of the secret alias.
value This property is required. String
Name of the secret to alias.
description String
Description of the secret alias.
id String
Id of the secret alias.

EnvironmentSecretOverride
, EnvironmentSecretOverrideArgs

Key This property is required. string
Name of the secret override.
Value This property is required. string
Value of the secret override.
Description string
Description of the secret override.
Id string
Id of the secret override.
Key This property is required. string
Name of the secret override.
Value This property is required. string
Value of the secret override.
Description string
Description of the secret override.
Id string
Id of the secret override.
key This property is required. String
Name of the secret override.
value This property is required. String
Value of the secret override.
description String
Description of the secret override.
id String
Id of the secret override.
key This property is required. string
Name of the secret override.
value This property is required. string
Value of the secret override.
description string
Description of the secret override.
id string
Id of the secret override.
key This property is required. str
Name of the secret override.
value This property is required. str
Value of the secret override.
description str
Description of the secret override.
id str
Id of the secret override.
key This property is required. String
Name of the secret override.
value This property is required. String
Value of the secret override.
description String
Description of the secret override.
id String
Id of the secret override.

Import

$ pulumi import qovery:index/environment:Environment my_environment "<environment_id>"
Copy

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

Package Details

Repository
qovery dirien/pulumi-qovery
License
Apache-2.0
Notes
This Pulumi package is based on the qovery Terraform Provider.
Qovery v0.41.0 published on Saturday, Sep 28, 2024 by dirien
dirien/pulumi-qovery