getEnvironment

Qovery v0.41.0, Sep 28 24

Viewing docs for Qovery v0.41.0
published on Saturday, Sep 28, 2024 by dirien

Schema (JSON)

dirien/pulumi-qovery

Viewing docs for Qovery v0.41.0
published on Saturday, Sep 28, 2024 by dirien

Schema (JSON)

dirien/pulumi-qovery

# qovery.Environment (Data Source)

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

Example Usage

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

const myEnvironment = qovery.getEnvironment({
    id: "<environment_id>",
});

import pulumi
import pulumi_qovery as qovery

my_environment = qovery.get_environment(id="<environment_id>")

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.LookupEnvironment(ctx, &qovery.LookupEnvironmentArgs{
			Id: "<environment_id>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Qovery = Pulumi.Qovery;

return await Deployment.RunAsync(() => 
{
    var myEnvironment = Qovery.GetEnvironment.Invoke(new()
    {
        Id = "<environment_id>",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.qovery.QoveryFunctions;
import com.pulumi.qovery.inputs.GetEnvironmentArgs;
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) {
        final var myEnvironment = QoveryFunctions.getEnvironment(GetEnvironmentArgs.builder()
            .id("<environment_id>")
            .build());

    }
}

variables:
  myEnvironment:
    fn::invoke:
      Function: qovery:getEnvironment
      Arguments:
        id: <environment_id>

Using getEnvironment

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEnvironment(args: GetEnvironmentArgs, opts?: InvokeOptions): Promise<GetEnvironmentResult>
function getEnvironmentOutput(args: GetEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentResult>

def get_environment(environment_variable_aliases: Optional[Sequence[GetEnvironmentEnvironmentVariableAlias]] = None,
                    environment_variable_overrides: Optional[Sequence[GetEnvironmentEnvironmentVariableOverride]] = None,
                    environment_variables: Optional[Sequence[GetEnvironmentEnvironmentVariable]] = None,
                    id: Optional[str] = None,
                    mode: Optional[str] = None,
                    secret_aliases: Optional[Sequence[GetEnvironmentSecretAlias]] = None,
                    secret_overrides: Optional[Sequence[GetEnvironmentSecretOverride]] = None,
                    secrets: Optional[Sequence[GetEnvironmentSecret]] = None,
                    opts: Optional[InvokeOptions] = None) -> GetEnvironmentResult
def get_environment_output(environment_variable_aliases: Optional[pulumi.Input[Sequence[pulumi.Input[GetEnvironmentEnvironmentVariableAliasArgs]]]] = None,
                    environment_variable_overrides: Optional[pulumi.Input[Sequence[pulumi.Input[GetEnvironmentEnvironmentVariableOverrideArgs]]]] = None,
                    environment_variables: Optional[pulumi.Input[Sequence[pulumi.Input[GetEnvironmentEnvironmentVariableArgs]]]] = None,
                    id: Optional[pulumi.Input[str]] = None,
                    mode: Optional[pulumi.Input[str]] = None,
                    secret_aliases: Optional[pulumi.Input[Sequence[pulumi.Input[GetEnvironmentSecretAliasArgs]]]] = None,
                    secret_overrides: Optional[pulumi.Input[Sequence[pulumi.Input[GetEnvironmentSecretOverrideArgs]]]] = None,
                    secrets: Optional[pulumi.Input[Sequence[pulumi.Input[GetEnvironmentSecretArgs]]]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetEnvironmentResult]

func LookupEnvironment(ctx *Context, args *LookupEnvironmentArgs, opts ...InvokeOption) (*LookupEnvironmentResult, error)
func LookupEnvironmentOutput(ctx *Context, args *LookupEnvironmentOutputArgs, opts ...InvokeOption) LookupEnvironmentResultOutput

> Note: This function is named LookupEnvironment in the Go SDK.

public static class GetEnvironment 
{
    public static Task<GetEnvironmentResult> InvokeAsync(GetEnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetEnvironmentResult> Invoke(GetEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
public static Output<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)

fn::invoke:
  function: qovery:index/getEnvironment:getEnvironment
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string
EnvironmentVariableAliases List<ediri.Qovery.Inputs.GetEnvironmentEnvironmentVariableAlias>
EnvironmentVariableOverrides List<ediri.Qovery.Inputs.GetEnvironmentEnvironmentVariableOverride>
EnvironmentVariables List<ediri.Qovery.Inputs.GetEnvironmentEnvironmentVariable>
Mode string
SecretAliases List<ediri.Qovery.Inputs.GetEnvironmentSecretAlias>
SecretOverrides List<ediri.Qovery.Inputs.GetEnvironmentSecretOverride>
Secrets List<ediri.Qovery.Inputs.GetEnvironmentSecret>

Id string
EnvironmentVariableAliases []GetEnvironmentEnvironmentVariableAlias
EnvironmentVariableOverrides []GetEnvironmentEnvironmentVariableOverride
EnvironmentVariables []GetEnvironmentEnvironmentVariable
Mode string
SecretAliases []GetEnvironmentSecretAlias
SecretOverrides []GetEnvironmentSecretOverride
Secrets []GetEnvironmentSecret

id String
environmentVariableAliases List<GetEnvironmentEnvironmentVariableAlias>
environmentVariableOverrides List<GetEnvironmentEnvironmentVariableOverride>
environmentVariables List<GetEnvironmentEnvironmentVariable>
mode String
secretAliases List<GetEnvironmentSecretAlias>
secretOverrides List<GetEnvironmentSecretOverride>
secrets List<GetEnvironmentSecret>

id string
environmentVariableAliases GetEnvironmentEnvironmentVariableAlias[]
environmentVariableOverrides GetEnvironmentEnvironmentVariableOverride[]
environmentVariables GetEnvironmentEnvironmentVariable[]
mode string
secretAliases GetEnvironmentSecretAlias[]
secretOverrides GetEnvironmentSecretOverride[]
secrets GetEnvironmentSecret[]

id str
environment_variable_aliases Sequence[GetEnvironmentEnvironmentVariableAlias]
environment_variable_overrides Sequence[GetEnvironmentEnvironmentVariableOverride]
environment_variables Sequence[GetEnvironmentEnvironmentVariable]
mode str
secret_aliases Sequence[GetEnvironmentSecretAlias]
secret_overrides Sequence[GetEnvironmentSecretOverride]
secrets Sequence[GetEnvironmentSecret]

id String
environmentVariableAliases List<Property Map>
environmentVariableOverrides List<Property Map>
environmentVariables List<Property Map>
mode String
secretAliases List<Property Map>
secretOverrides List<Property Map>
secrets List<Property Map>

getEnvironment Result

The following output properties are available:

BuiltInEnvironmentVariables List<ediri.Qovery.Outputs.GetEnvironmentBuiltInEnvironmentVariable>
ClusterId string
EnvironmentVariableAliases List<ediri.Qovery.Outputs.GetEnvironmentEnvironmentVariableAlias>
EnvironmentVariableOverrides List<ediri.Qovery.Outputs.GetEnvironmentEnvironmentVariableOverride>
EnvironmentVariables List<ediri.Qovery.Outputs.GetEnvironmentEnvironmentVariable>
Id string
Mode string
Name string
ProjectId string
SecretAliases List<ediri.Qovery.Outputs.GetEnvironmentSecretAlias>
Secrets List<ediri.Qovery.Outputs.GetEnvironmentSecret>
SecretOverrides List<ediri.Qovery.Outputs.GetEnvironmentSecretOverride>

BuiltInEnvironmentVariables []GetEnvironmentBuiltInEnvironmentVariable
ClusterId string
EnvironmentVariableAliases []GetEnvironmentEnvironmentVariableAlias
EnvironmentVariableOverrides []GetEnvironmentEnvironmentVariableOverride
EnvironmentVariables []GetEnvironmentEnvironmentVariable
Id string
Mode string
Name string
ProjectId string
SecretAliases []GetEnvironmentSecretAlias
Secrets []GetEnvironmentSecret
SecretOverrides []GetEnvironmentSecretOverride

builtInEnvironmentVariables List<GetEnvironmentBuiltInEnvironmentVariable>
clusterId String
environmentVariableAliases List<GetEnvironmentEnvironmentVariableAlias>
environmentVariableOverrides List<GetEnvironmentEnvironmentVariableOverride>
environmentVariables List<GetEnvironmentEnvironmentVariable>
id String
mode String
name String
projectId String
secretAliases List<GetEnvironmentSecretAlias>
secrets List<GetEnvironmentSecret>
secretOverrides List<GetEnvironmentSecretOverride>

builtInEnvironmentVariables GetEnvironmentBuiltInEnvironmentVariable[]
clusterId string
environmentVariableAliases GetEnvironmentEnvironmentVariableAlias[]
environmentVariableOverrides GetEnvironmentEnvironmentVariableOverride[]
environmentVariables GetEnvironmentEnvironmentVariable[]
id string
mode string
name string
projectId string
secretAliases GetEnvironmentSecretAlias[]
secrets GetEnvironmentSecret[]
secretOverrides GetEnvironmentSecretOverride[]

built_in_environment_variables Sequence[GetEnvironmentBuiltInEnvironmentVariable]
cluster_id str
environment_variable_aliases Sequence[GetEnvironmentEnvironmentVariableAlias]
environment_variable_overrides Sequence[GetEnvironmentEnvironmentVariableOverride]
environment_variables Sequence[GetEnvironmentEnvironmentVariable]
id str
mode str
name str
project_id str
secret_aliases Sequence[GetEnvironmentSecretAlias]
secrets Sequence[GetEnvironmentSecret]
secret_overrides Sequence[GetEnvironmentSecretOverride]

builtInEnvironmentVariables List<Property Map>
clusterId String
environmentVariableAliases List<Property Map>
environmentVariableOverrides List<Property Map>
environmentVariables List<Property Map>
id String
mode String
name String
projectId String
secretAliases List<Property Map>
secrets List<Property Map>
secretOverrides List<Property Map>

Supporting Types

GetEnvironmentBuiltInEnvironmentVariable

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.

GetEnvironmentEnvironmentVariable

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.

GetEnvironmentEnvironmentVariableAlias

Description string: Description of the environment variable.
Id string: Id of the environment variable alias.
Key string: Name of the environment variable alias.
Value string: Name of the variable to alias.

Description string: Description of the environment variable.
Id string: Id of the environment variable alias.
Key string: Name of the environment variable alias.
Value string: Name of the variable to alias.

description String: Description of the environment variable.
id String: Id of the environment variable alias.
key String: Name of the environment variable alias.
value String: Name of the variable to alias.

description string: Description of the environment variable.
id string: Id of the environment variable alias.
key string: Name of the environment variable alias.
value string: Name of the variable to alias.

description str: Description of the environment variable.
id str: Id of the environment variable alias.
key str: Name of the environment variable alias.
value str: Name of the variable to alias.

description String: Description of the environment variable.
id String: Id of the environment variable alias.
key String: Name of the environment variable alias.
value String: Name of the variable to alias.

GetEnvironmentEnvironmentVariableOverride

Description string: Description of the environment variable.
Id string: Id of the environment variable override.
Key string: Name of the environment variable override.
Value string: Value of the environment variable override.

Description string: Description of the environment variable.
Id string: Id of the environment variable override.
Key string: Name of the environment variable override.
Value string: Value of the environment variable override.

description String: Description of the environment variable.
id String: Id of the environment variable override.
key String: Name of the environment variable override.
value String: Value of the environment variable override.

description string: Description of the environment variable.
id string: Id of the environment variable override.
key string: Name of the environment variable override.
value string: Value of the environment variable override.

description str: Description of the environment variable.
id str: Id of the environment variable override.
key str: Name of the environment variable override.
value str: Value of the environment variable override.

description String: Description of the environment variable.
id String: Id of the environment variable override.
key String: Name of the environment variable override.
value String: Value of the environment variable override.

GetEnvironmentSecret

Description string: Description of the environment variable.
Id string: Id of the secret.
Key string: Key of the secret.
Value string: Value of the secret.

Description string: Description of the environment variable.
Id string: Id of the secret.
Key string: Key of the secret.
Value string: Value of the secret.

description String: Description of the environment variable.
id String: Id of the secret.
key String: Key of the secret.
value String: Value of the secret.

description string: Description of the environment variable.
id string: Id of the secret.
key string: Key of the secret.
value string: Value of the secret.

description str: Description of the environment variable.
id str: Id of the secret.
key str: Key of the secret.
value str: Value of the secret.

description String: Description of the environment variable.
id String: Id of the secret.
key String: Key of the secret.
value String: Value of the secret.

GetEnvironmentSecretAlias

Description string: Description of the environment variable.
Id string: Id of the secret alias.
Key string: Name of the secret alias.
Value string: Name of the secret to alias.

Description string: Description of the environment variable.
Id string: Id of the secret alias.
Key string: Name of the secret alias.
Value string: Name of the secret to alias.

description String: Description of the environment variable.
id String: Id of the secret alias.
key String: Name of the secret alias.
value String: Name of the secret to alias.

description string: Description of the environment variable.
id string: Id of the secret alias.
key string: Name of the secret alias.
value string: Name of the secret to alias.

description str: Description of the environment variable.
id str: Id of the secret alias.
key str: Name of the secret alias.
value str: Name of the secret to alias.

description String: Description of the environment variable.
id String: Id of the secret alias.
key String: Name of the secret alias.
value String: Name of the secret to alias.

GetEnvironmentSecretOverride

Description string: Description of the environment variable.
Id string: Id of the secret override.
Key string: Name of the secret override.
Value string: Value of the secret override.

Description string: Description of the environment variable.
Id string: Id of the secret override.
Key string: Name of the secret override.
Value string: Value of the secret override.

description String: Description of the environment variable.
id String: Id of the secret override.
key String: Name of the secret override.
value String: Value of the secret override.

description string: Description of the environment variable.
id string: Id of the secret override.
key string: Name of the secret override.
value string: Value of the secret override.

description str: Description of the environment variable.
id str: Id of the secret override.
key str: Name of the secret override.
value str: Value of the secret override.

description String: Description of the environment variable.
id String: Id of the secret override.
key String: Name of the secret override.
value String: Value of the secret override.

Package Details

Repository: qovery dirien/pulumi-qovery
License: Apache-2.0
Notes: This Pulumi package is based on the qovery Terraform Provider.

Viewing docs for Qovery v0.41.0
published on Saturday, Sep 28, 2024 by dirien

Schema (JSON)

dirien/pulumi-qovery

qovery.getEnvironment

On this page

On this page

# qovery.Environment (Data Source)

Example Usage

Using getEnvironment

getEnvironment Result

Supporting Types

GetEnvironmentBuiltInEnvironmentVariable

GetEnvironmentEnvironmentVariable

GetEnvironmentEnvironmentVariableAlias

GetEnvironmentEnvironmentVariableOverride

GetEnvironmentSecret

GetEnvironmentSecretAlias

GetEnvironmentSecretOverride

Package Details

On this page

On this page