1. Packages
  2. Qovery
  3. API Docs
  4. getProject
Qovery v0.41.0 published on Saturday, Sep 28, 2024 by dirien

qovery.getProject

Explore with Pulumi AI

# qovery.Project (Data Source)

Provides a Qovery project resource. This can be used to create and manage Qovery projects.

Example Usage

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

const myProject = qovery.getProject({
    id: "<project_id>",
});
Copy
import pulumi
import pulumi_qovery as qovery

my_project = qovery.get_project(id="<project_id>")
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.LookupProject(ctx, &qovery.LookupProjectArgs{
			Id: "<project_id>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Qovery = Pulumi.Qovery;

return await Deployment.RunAsync(() => 
{
    var myProject = Qovery.GetProject.Invoke(new()
    {
        Id = "<project_id>",
    });

});
Copy
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.GetProjectArgs;
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 myProject = QoveryFunctions.getProject(GetProjectArgs.builder()
            .id("<project_id>")
            .build());

    }
}
Copy
variables:
  myProject:
    fn::invoke:
      Function: qovery:getProject
      Arguments:
        id: <project_id>
Copy

Using getProject

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 getProject(args: GetProjectArgs, opts?: InvokeOptions): Promise<GetProjectResult>
function getProjectOutput(args: GetProjectOutputArgs, opts?: InvokeOptions): Output<GetProjectResult>
Copy
def get_project(description: Optional[str] = None,
                environment_variable_aliases: Optional[Sequence[GetProjectEnvironmentVariableAlias]] = None,
                environment_variables: Optional[Sequence[GetProjectEnvironmentVariable]] = None,
                id: Optional[str] = None,
                secret_aliases: Optional[Sequence[GetProjectSecretAlias]] = None,
                secrets: Optional[Sequence[GetProjectSecret]] = None,
                opts: Optional[InvokeOptions] = None) -> GetProjectResult
def get_project_output(description: Optional[pulumi.Input[str]] = None,
                environment_variable_aliases: Optional[pulumi.Input[Sequence[pulumi.Input[GetProjectEnvironmentVariableAliasArgs]]]] = None,
                environment_variables: Optional[pulumi.Input[Sequence[pulumi.Input[GetProjectEnvironmentVariableArgs]]]] = None,
                id: Optional[pulumi.Input[str]] = None,
                secret_aliases: Optional[pulumi.Input[Sequence[pulumi.Input[GetProjectSecretAliasArgs]]]] = None,
                secrets: Optional[pulumi.Input[Sequence[pulumi.Input[GetProjectSecretArgs]]]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetProjectResult]
Copy
func LookupProject(ctx *Context, args *LookupProjectArgs, opts ...InvokeOption) (*LookupProjectResult, error)
func LookupProjectOutput(ctx *Context, args *LookupProjectOutputArgs, opts ...InvokeOption) LookupProjectResultOutput
Copy

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

public static class GetProject 
{
    public static Task<GetProjectResult> InvokeAsync(GetProjectArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectResult> Invoke(GetProjectInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
public static Output<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: qovery:index/getProject:getProject
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
Id of the project.
Description string
Description of the project.
EnvironmentVariableAliases List<ediri.Qovery.Inputs.GetProjectEnvironmentVariableAlias>
List of environment variable aliases linked to this project.
EnvironmentVariables List<ediri.Qovery.Inputs.GetProjectEnvironmentVariable>
List of environment variables linked to this project.
SecretAliases List<ediri.Qovery.Inputs.GetProjectSecretAlias>
List of secret aliases linked to this project.
Secrets List<ediri.Qovery.Inputs.GetProjectSecret>
List of secrets linked to this project.
Id This property is required. string
Id of the project.
Description string
Description of the project.
EnvironmentVariableAliases []GetProjectEnvironmentVariableAlias
List of environment variable aliases linked to this project.
EnvironmentVariables []GetProjectEnvironmentVariable
List of environment variables linked to this project.
SecretAliases []GetProjectSecretAlias
List of secret aliases linked to this project.
Secrets []GetProjectSecret
List of secrets linked to this project.
id This property is required. String
Id of the project.
description String
Description of the project.
environmentVariableAliases List<GetProjectEnvironmentVariableAlias>
List of environment variable aliases linked to this project.
environmentVariables List<GetProjectEnvironmentVariable>
List of environment variables linked to this project.
secretAliases List<GetProjectSecretAlias>
List of secret aliases linked to this project.
secrets List<GetProjectSecret>
List of secrets linked to this project.
id This property is required. string
Id of the project.
description string
Description of the project.
environmentVariableAliases GetProjectEnvironmentVariableAlias[]
List of environment variable aliases linked to this project.
environmentVariables GetProjectEnvironmentVariable[]
List of environment variables linked to this project.
secretAliases GetProjectSecretAlias[]
List of secret aliases linked to this project.
secrets GetProjectSecret[]
List of secrets linked to this project.
id This property is required. str
Id of the project.
description str
Description of the project.
environment_variable_aliases Sequence[GetProjectEnvironmentVariableAlias]
List of environment variable aliases linked to this project.
environment_variables Sequence[GetProjectEnvironmentVariable]
List of environment variables linked to this project.
secret_aliases Sequence[GetProjectSecretAlias]
List of secret aliases linked to this project.
secrets Sequence[GetProjectSecret]
List of secrets linked to this project.
id This property is required. String
Id of the project.
description String
Description of the project.
environmentVariableAliases List<Property Map>
List of environment variable aliases linked to this project.
environmentVariables List<Property Map>
List of environment variables linked to this project.
secretAliases List<Property Map>
List of secret aliases linked to this project.
secrets List<Property Map>
List of secrets linked to this project.

getProject Result

The following output properties are available:

BuiltInEnvironmentVariables List<ediri.Qovery.Outputs.GetProjectBuiltInEnvironmentVariable>
List of built-in environment variables linked to this project.
Description string
Description of the project.
EnvironmentVariableAliases List<ediri.Qovery.Outputs.GetProjectEnvironmentVariableAlias>
List of environment variable aliases linked to this project.
EnvironmentVariables List<ediri.Qovery.Outputs.GetProjectEnvironmentVariable>
List of environment variables linked to this project.
Id string
Id of the project.
Name string
Name of the project.
OrganizationId string
Id of the organization.
SecretAliases List<ediri.Qovery.Outputs.GetProjectSecretAlias>
List of secret aliases linked to this project.
Secrets List<ediri.Qovery.Outputs.GetProjectSecret>
List of secrets linked to this project.
BuiltInEnvironmentVariables []GetProjectBuiltInEnvironmentVariable
List of built-in environment variables linked to this project.
Description string
Description of the project.
EnvironmentVariableAliases []GetProjectEnvironmentVariableAlias
List of environment variable aliases linked to this project.
EnvironmentVariables []GetProjectEnvironmentVariable
List of environment variables linked to this project.
Id string
Id of the project.
Name string
Name of the project.
OrganizationId string
Id of the organization.
SecretAliases []GetProjectSecretAlias
List of secret aliases linked to this project.
Secrets []GetProjectSecret
List of secrets linked to this project.
builtInEnvironmentVariables List<GetProjectBuiltInEnvironmentVariable>
List of built-in environment variables linked to this project.
description String
Description of the project.
environmentVariableAliases List<GetProjectEnvironmentVariableAlias>
List of environment variable aliases linked to this project.
environmentVariables List<GetProjectEnvironmentVariable>
List of environment variables linked to this project.
id String
Id of the project.
name String
Name of the project.
organizationId String
Id of the organization.
secretAliases List<GetProjectSecretAlias>
List of secret aliases linked to this project.
secrets List<GetProjectSecret>
List of secrets linked to this project.
builtInEnvironmentVariables GetProjectBuiltInEnvironmentVariable[]
List of built-in environment variables linked to this project.
description string
Description of the project.
environmentVariableAliases GetProjectEnvironmentVariableAlias[]
List of environment variable aliases linked to this project.
environmentVariables GetProjectEnvironmentVariable[]
List of environment variables linked to this project.
id string
Id of the project.
name string
Name of the project.
organizationId string
Id of the organization.
secretAliases GetProjectSecretAlias[]
List of secret aliases linked to this project.
secrets GetProjectSecret[]
List of secrets linked to this project.
built_in_environment_variables Sequence[GetProjectBuiltInEnvironmentVariable]
List of built-in environment variables linked to this project.
description str
Description of the project.
environment_variable_aliases Sequence[GetProjectEnvironmentVariableAlias]
List of environment variable aliases linked to this project.
environment_variables Sequence[GetProjectEnvironmentVariable]
List of environment variables linked to this project.
id str
Id of the project.
name str
Name of the project.
organization_id str
Id of the organization.
secret_aliases Sequence[GetProjectSecretAlias]
List of secret aliases linked to this project.
secrets Sequence[GetProjectSecret]
List of secrets linked to this project.
builtInEnvironmentVariables List<Property Map>
List of built-in environment variables linked to this project.
description String
Description of the project.
environmentVariableAliases List<Property Map>
List of environment variable aliases linked to this project.
environmentVariables List<Property Map>
List of environment variables linked to this project.
id String
Id of the project.
name String
Name of the project.
organizationId String
Id of the organization.
secretAliases List<Property Map>
List of secret aliases linked to this project.
secrets List<Property Map>
List of secrets linked to this project.

Supporting Types

GetProjectBuiltInEnvironmentVariable

Description This property is required. string
Description of the environment variable.
Id This property is required. 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 This property is required. string
Description of the environment variable.
Id This property is required. 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 This property is required. String
Description of the environment variable.
id This property is required. 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 This property is required. string
Description of the environment variable.
id This property is required. 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 This property is required. str
Description of the environment variable.
id This property is required. str
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 This property is required. String
Description of the environment variable.
id This property is required. 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.

GetProjectEnvironmentVariable

Description This property is required. string
Description of the environment variable.
Id This property is required. 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 This property is required. string
Description of the environment variable.
Id This property is required. 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 This property is required. String
Description of the environment variable.
id This property is required. 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 This property is required. string
Description of the environment variable.
id This property is required. 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 This property is required. str
Description of the environment variable.
id This property is required. str
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 This property is required. String
Description of the environment variable.
id This property is required. 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.

GetProjectEnvironmentVariableAlias

Description This property is required. string
Description of the environment variable.
Id This property is required. 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 This property is required. string
Description of the environment variable.
Id This property is required. 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 This property is required. String
Description of the environment variable.
id This property is required. 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 This property is required. string
Description of the environment variable.
id This property is required. 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 This property is required. str
Description of the environment variable.
id This property is required. str
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 This property is required. String
Description of the environment variable.
id This property is required. 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.

GetProjectSecret

Description This property is required. string
Description of the environment variable.
Id This property is required. 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 This property is required. string
Description of the environment variable.
Id This property is required. 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 This property is required. String
Description of the environment variable.
id This property is required. 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 This property is required. string
Description of the environment variable.
id This property is required. 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 This property is required. str
Description of the environment variable.
id This property is required. str
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 This property is required. String
Description of the environment variable.
id This property is required. 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.

GetProjectSecretAlias

Description This property is required. string
Description of the environment variable.
Id This property is required. 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 This property is required. string
Description of the environment variable.
Id This property is required. 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 This property is required. String
Description of the environment variable.
id This property is required. 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 This property is required. string
Description of the environment variable.
id This property is required. 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 This property is required. str
Description of the environment variable.
id This property is required. str
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 This property is required. String
Description of the environment variable.
id This property is required. 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.

Package Details

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