qovery.Project
Explore with Pulumi AI
# qovery.Project (Resource)
Provides a Qovery project resource. This can be used to create and manage Qovery projects.
Example
import * as pulumi from "@pulumi/pulumi";
import * as qovery from "@ediri/qovery";
const myProject = new qovery.Project("myProject", {
organizationId: qovery_organization.my_organization.id,
description: "My project description",
environmentVariables: [{
key: "ENV_VAR_KEY",
value: "ENV_VAR_VALUE",
}],
environmentVariableAliases: [{
key: "ENV_VAR_KEY_ALIAS",
value: "ENV_VAR_KEY",
}],
secrets: [{
key: "SECRET_KEY",
value: "SECRET_VALUE",
}],
secretAliases: [{
key: "SECRET_KEY_ALIAS",
value: "SECRET_KEY",
}],
}, {
dependsOn: [qovery_organization.my_organization],
});
import pulumi
import ediri_qovery as qovery
my_project = qovery.Project("myProject",
organization_id=qovery_organization["my_organization"]["id"],
description="My project description",
environment_variables=[qovery.ProjectEnvironmentVariableArgs(
key="ENV_VAR_KEY",
value="ENV_VAR_VALUE",
)],
environment_variable_aliases=[qovery.ProjectEnvironmentVariableAliasArgs(
key="ENV_VAR_KEY_ALIAS",
value="ENV_VAR_KEY",
)],
secrets=[qovery.ProjectSecretArgs(
key="SECRET_KEY",
value="SECRET_VALUE",
)],
secret_aliases=[qovery.ProjectSecretAliasArgs(
key="SECRET_KEY_ALIAS",
value="SECRET_KEY",
)],
opts=pulumi.ResourceOptions(depends_on=[qovery_organization["my_organization"]]))
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.NewProject(ctx, "myProject", &qovery.ProjectArgs{
OrganizationId: pulumi.Any(qovery_organization.My_organization.Id),
Description: pulumi.String("My project description"),
EnvironmentVariables: qovery.ProjectEnvironmentVariableArray{
&qovery.ProjectEnvironmentVariableArgs{
Key: pulumi.String("ENV_VAR_KEY"),
Value: pulumi.String("ENV_VAR_VALUE"),
},
},
EnvironmentVariableAliases: qovery.ProjectEnvironmentVariableAliasArray{
&qovery.ProjectEnvironmentVariableAliasArgs{
Key: pulumi.String("ENV_VAR_KEY_ALIAS"),
Value: pulumi.String("ENV_VAR_KEY"),
},
},
Secrets: qovery.ProjectSecretArray{
&qovery.ProjectSecretArgs{
Key: pulumi.String("SECRET_KEY"),
Value: pulumi.String("SECRET_VALUE"),
},
},
SecretAliases: qovery.ProjectSecretAliasArray{
&qovery.ProjectSecretAliasArgs{
Key: pulumi.String("SECRET_KEY_ALIAS"),
Value: pulumi.String("SECRET_KEY"),
},
},
}, pulumi.DependsOn([]pulumi.Resource{
qovery_organization.My_organization,
}))
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Qovery = ediri.Qovery;
return await Deployment.RunAsync(() =>
{
var myProject = new Qovery.Project("myProject", new()
{
OrganizationId = qovery_organization.My_organization.Id,
Description = "My project description",
EnvironmentVariables = new[]
{
new Qovery.Inputs.ProjectEnvironmentVariableArgs
{
Key = "ENV_VAR_KEY",
Value = "ENV_VAR_VALUE",
},
},
EnvironmentVariableAliases = new[]
{
new Qovery.Inputs.ProjectEnvironmentVariableAliasArgs
{
Key = "ENV_VAR_KEY_ALIAS",
Value = "ENV_VAR_KEY",
},
},
Secrets = new[]
{
new Qovery.Inputs.ProjectSecretArgs
{
Key = "SECRET_KEY",
Value = "SECRET_VALUE",
},
},
SecretAliases = new[]
{
new Qovery.Inputs.ProjectSecretAliasArgs
{
Key = "SECRET_KEY_ALIAS",
Value = "SECRET_KEY",
},
},
}, new CustomResourceOptions
{
DependsOn =
{
qovery_organization.My_organization,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.qovery.Project;
import com.pulumi.qovery.ProjectArgs;
import com.pulumi.qovery.inputs.ProjectEnvironmentVariableArgs;
import com.pulumi.qovery.inputs.ProjectEnvironmentVariableAliasArgs;
import com.pulumi.qovery.inputs.ProjectSecretArgs;
import com.pulumi.qovery.inputs.ProjectSecretAliasArgs;
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 myProject = new Project("myProject", ProjectArgs.builder()
.organizationId(qovery_organization.my_organization().id())
.description("My project description")
.environmentVariables(ProjectEnvironmentVariableArgs.builder()
.key("ENV_VAR_KEY")
.value("ENV_VAR_VALUE")
.build())
.environmentVariableAliases(ProjectEnvironmentVariableAliasArgs.builder()
.key("ENV_VAR_KEY_ALIAS")
.value("ENV_VAR_KEY")
.build())
.secrets(ProjectSecretArgs.builder()
.key("SECRET_KEY")
.value("SECRET_VALUE")
.build())
.secretAliases(ProjectSecretAliasArgs.builder()
.key("SECRET_KEY_ALIAS")
.value("SECRET_KEY")
.build())
.build(), CustomResourceOptions.builder()
.dependsOn(qovery_organization.my_organization())
.build());
}
}
resources:
myProject:
type: qovery:Project
properties:
# Required
organizationId: ${qovery_organization.my_organization.id}
# Optional
description: My project description
environmentVariables:
- key: ENV_VAR_KEY
value: ENV_VAR_VALUE
environmentVariableAliases:
- key: ENV_VAR_KEY_ALIAS
value: ENV_VAR_KEY
secrets:
- key: SECRET_KEY
value: SECRET_VALUE
secretAliases:
- key: SECRET_KEY_ALIAS
value: SECRET_KEY
options:
dependson:
- ${qovery_organization.my_organization}
Create Project Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Project(name: string, args: ProjectArgs, opts?: CustomResourceOptions);
@overload
def Project(resource_name: str,
args: ProjectArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Project(resource_name: str,
opts: Optional[ResourceOptions] = None,
organization_id: Optional[str] = None,
description: Optional[str] = None,
environment_variable_aliases: Optional[Sequence[ProjectEnvironmentVariableAliasArgs]] = None,
environment_variables: Optional[Sequence[ProjectEnvironmentVariableArgs]] = None,
name: Optional[str] = None,
secret_aliases: Optional[Sequence[ProjectSecretAliasArgs]] = None,
secrets: Optional[Sequence[ProjectSecretArgs]] = None)
func NewProject(ctx *Context, name string, args ProjectArgs, opts ...ResourceOption) (*Project, error)
public Project(string name, ProjectArgs args, CustomResourceOptions? opts = null)
public Project(String name, ProjectArgs args)
public Project(String name, ProjectArgs args, CustomResourceOptions options)
type: qovery:Project
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ProjectArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ProjectArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ProjectArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ProjectArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ProjectArgs
- 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 projectResource = new Qovery.Project("projectResource", new()
{
OrganizationId = "string",
Description = "string",
EnvironmentVariableAliases = new[]
{
new Qovery.Inputs.ProjectEnvironmentVariableAliasArgs
{
Key = "string",
Value = "string",
Id = "string",
},
},
EnvironmentVariables = new[]
{
new Qovery.Inputs.ProjectEnvironmentVariableArgs
{
Key = "string",
Value = "string",
Id = "string",
},
},
Name = "string",
SecretAliases = new[]
{
new Qovery.Inputs.ProjectSecretAliasArgs
{
Key = "string",
Value = "string",
Id = "string",
},
},
Secrets = new[]
{
new Qovery.Inputs.ProjectSecretArgs
{
Key = "string",
Value = "string",
Id = "string",
},
},
});
example, err := qovery.NewProject(ctx, "projectResource", &qovery.ProjectArgs{
OrganizationId: pulumi.String("string"),
Description: pulumi.String("string"),
EnvironmentVariableAliases: qovery.ProjectEnvironmentVariableAliasArray{
&qovery.ProjectEnvironmentVariableAliasArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
Id: pulumi.String("string"),
},
},
EnvironmentVariables: qovery.ProjectEnvironmentVariableArray{
&qovery.ProjectEnvironmentVariableArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
Id: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
SecretAliases: qovery.ProjectSecretAliasArray{
&qovery.ProjectSecretAliasArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
Id: pulumi.String("string"),
},
},
Secrets: qovery.ProjectSecretArray{
&qovery.ProjectSecretArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
Id: pulumi.String("string"),
},
},
})
var projectResource = new Project("projectResource", ProjectArgs.builder()
.organizationId("string")
.description("string")
.environmentVariableAliases(ProjectEnvironmentVariableAliasArgs.builder()
.key("string")
.value("string")
.id("string")
.build())
.environmentVariables(ProjectEnvironmentVariableArgs.builder()
.key("string")
.value("string")
.id("string")
.build())
.name("string")
.secretAliases(ProjectSecretAliasArgs.builder()
.key("string")
.value("string")
.id("string")
.build())
.secrets(ProjectSecretArgs.builder()
.key("string")
.value("string")
.id("string")
.build())
.build());
project_resource = qovery.Project("projectResource",
organization_id="string",
description="string",
environment_variable_aliases=[qovery.ProjectEnvironmentVariableAliasArgs(
key="string",
value="string",
id="string",
)],
environment_variables=[qovery.ProjectEnvironmentVariableArgs(
key="string",
value="string",
id="string",
)],
name="string",
secret_aliases=[qovery.ProjectSecretAliasArgs(
key="string",
value="string",
id="string",
)],
secrets=[qovery.ProjectSecretArgs(
key="string",
value="string",
id="string",
)])
const projectResource = new qovery.Project("projectResource", {
organizationId: "string",
description: "string",
environmentVariableAliases: [{
key: "string",
value: "string",
id: "string",
}],
environmentVariables: [{
key: "string",
value: "string",
id: "string",
}],
name: "string",
secretAliases: [{
key: "string",
value: "string",
id: "string",
}],
secrets: [{
key: "string",
value: "string",
id: "string",
}],
});
type: qovery:Project
properties:
description: string
environmentVariableAliases:
- id: string
key: string
value: string
environmentVariables:
- id: string
key: string
value: string
name: string
organizationId: string
secretAliases:
- id: string
key: string
value: string
secrets:
- id: string
key: string
value: string
Project Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Project resource accepts the following input properties:
- Organization
Id string - Id of the organization.
- Description string
- Description of the project.
- Environment
Variable List<ediri.Aliases Qovery. Inputs. Project Environment Variable Alias> - List of environment variable aliases linked to this project.
- Environment
Variables List<ediri.Qovery. Inputs. Project Environment Variable> - List of environment variables linked to this project.
- Name string
- Name of the project.
- Secret
Aliases List<ediri.Qovery. Inputs. Project Secret Alias> - List of secret aliases linked to this project.
- Secrets
List<ediri.
Qovery. Inputs. Project Secret> - List of secrets linked to this project.
- Organization
Id string - Id of the organization.
- Description string
- Description of the project.
- Environment
Variable []ProjectAliases Environment Variable Alias Args - List of environment variable aliases linked to this project.
- Environment
Variables []ProjectEnvironment Variable Args - List of environment variables linked to this project.
- Name string
- Name of the project.
- Secret
Aliases []ProjectSecret Alias Args - List of secret aliases linked to this project.
- Secrets
[]Project
Secret Args - List of secrets linked to this project.
- organization
Id String - Id of the organization.
- description String
- Description of the project.
- environment
Variable List<ProjectAliases Environment Variable Alias> - List of environment variable aliases linked to this project.
- environment
Variables List<ProjectEnvironment Variable> - List of environment variables linked to this project.
- name String
- Name of the project.
- secret
Aliases List<ProjectSecret Alias> - List of secret aliases linked to this project.
- secrets
List<Project
Secret> - List of secrets linked to this project.
- organization
Id string - Id of the organization.
- description string
- Description of the project.
- environment
Variable ProjectAliases Environment Variable Alias[] - List of environment variable aliases linked to this project.
- environment
Variables ProjectEnvironment Variable[] - List of environment variables linked to this project.
- name string
- Name of the project.
- secret
Aliases ProjectSecret Alias[] - List of secret aliases linked to this project.
- secrets
Project
Secret[] - List of secrets linked to this project.
- organization_
id str - Id of the organization.
- description str
- Description of the project.
- environment_
variable_ Sequence[Projectaliases Environment Variable Alias Args] - List of environment variable aliases linked to this project.
- environment_
variables Sequence[ProjectEnvironment Variable Args] - List of environment variables linked to this project.
- name str
- Name of the project.
- secret_
aliases Sequence[ProjectSecret Alias Args] - List of secret aliases linked to this project.
- secrets
Sequence[Project
Secret Args] - List of secrets linked to this project.
- organization
Id String - Id of the organization.
- description String
- Description of the project.
- environment
Variable List<Property Map>Aliases - List of environment variable aliases linked to this project.
- environment
Variables List<Property Map> - List of environment variables linked to this project.
- name String
- Name of the project.
- secret
Aliases List<Property Map> - List of secret aliases linked to this project.
- secrets List<Property Map>
- List of secrets linked to this project.
Outputs
All input properties are implicitly available as output properties. Additionally, the Project resource produces the following output properties:
- Built
In List<ediri.Environment Variables Qovery. Outputs. Project Built In Environment Variable> - List of built-in environment variables linked to this project.
- Id string
- The provider-assigned unique ID for this managed resource.
- Built
In []ProjectEnvironment Variables Built In Environment Variable - List of built-in environment variables linked to this project.
- Id string
- The provider-assigned unique ID for this managed resource.
- built
In List<ProjectEnvironment Variables Built In Environment Variable> - List of built-in environment variables linked to this project.
- id String
- The provider-assigned unique ID for this managed resource.
- built
In ProjectEnvironment Variables Built In Environment Variable[] - List of built-in environment variables linked to this project.
- id string
- The provider-assigned unique ID for this managed resource.
- built_
in_ Sequence[Projectenvironment_ variables Built In Environment Variable] - List of built-in environment variables linked to this project.
- id str
- The provider-assigned unique ID for this managed resource.
- built
In List<Property Map>Environment Variables - List of built-in environment variables linked to this project.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Project Resource
Get an existing Project 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?: ProjectState, opts?: CustomResourceOptions): Project
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
built_in_environment_variables: Optional[Sequence[ProjectBuiltInEnvironmentVariableArgs]] = None,
description: Optional[str] = None,
environment_variable_aliases: Optional[Sequence[ProjectEnvironmentVariableAliasArgs]] = None,
environment_variables: Optional[Sequence[ProjectEnvironmentVariableArgs]] = None,
name: Optional[str] = None,
organization_id: Optional[str] = None,
secret_aliases: Optional[Sequence[ProjectSecretAliasArgs]] = None,
secrets: Optional[Sequence[ProjectSecretArgs]] = None) -> Project
func GetProject(ctx *Context, name string, id IDInput, state *ProjectState, opts ...ResourceOption) (*Project, error)
public static Project Get(string name, Input<string> id, ProjectState? state, CustomResourceOptions? opts = null)
public static Project get(String name, Output<String> id, ProjectState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Built
In List<ediri.Environment Variables Qovery. Inputs. Project Built In Environment Variable> - List of built-in environment variables linked to this project.
- Description string
- Description of the project.
- Environment
Variable List<ediri.Aliases Qovery. Inputs. Project Environment Variable Alias> - List of environment variable aliases linked to this project.
- Environment
Variables List<ediri.Qovery. Inputs. Project Environment Variable> - List of environment variables linked to this project.
- Name string
- Name of the project.
- Organization
Id string - Id of the organization.
- Secret
Aliases List<ediri.Qovery. Inputs. Project Secret Alias> - List of secret aliases linked to this project.
- Secrets
List<ediri.
Qovery. Inputs. Project Secret> - List of secrets linked to this project.
- Built
In []ProjectEnvironment Variables Built In Environment Variable Args - List of built-in environment variables linked to this project.
- Description string
- Description of the project.
- Environment
Variable []ProjectAliases Environment Variable Alias Args - List of environment variable aliases linked to this project.
- Environment
Variables []ProjectEnvironment Variable Args - List of environment variables linked to this project.
- Name string
- Name of the project.
- Organization
Id string - Id of the organization.
- Secret
Aliases []ProjectSecret Alias Args - List of secret aliases linked to this project.
- Secrets
[]Project
Secret Args - List of secrets linked to this project.
- built
In List<ProjectEnvironment Variables Built In Environment Variable> - List of built-in environment variables linked to this project.
- description String
- Description of the project.
- environment
Variable List<ProjectAliases Environment Variable Alias> - List of environment variable aliases linked to this project.
- environment
Variables List<ProjectEnvironment Variable> - List of environment variables linked to this project.
- name String
- Name of the project.
- organization
Id String - Id of the organization.
- secret
Aliases List<ProjectSecret Alias> - List of secret aliases linked to this project.
- secrets
List<Project
Secret> - List of secrets linked to this project.
- built
In ProjectEnvironment Variables Built In Environment Variable[] - List of built-in environment variables linked to this project.
- description string
- Description of the project.
- environment
Variable ProjectAliases Environment Variable Alias[] - List of environment variable aliases linked to this project.
- environment
Variables ProjectEnvironment Variable[] - List of environment variables linked to this project.
- name string
- Name of the project.
- organization
Id string - Id of the organization.
- secret
Aliases ProjectSecret Alias[] - List of secret aliases linked to this project.
- secrets
Project
Secret[] - List of secrets linked to this project.
- built_
in_ Sequence[Projectenvironment_ variables Built In Environment Variable Args] - List of built-in environment variables linked to this project.
- description str
- Description of the project.
- environment_
variable_ Sequence[Projectaliases Environment Variable Alias Args] - List of environment variable aliases linked to this project.
- environment_
variables Sequence[ProjectEnvironment Variable Args] - List of environment variables linked to this project.
- name str
- Name of the project.
- organization_
id str - Id of the organization.
- secret_
aliases Sequence[ProjectSecret Alias Args] - List of secret aliases linked to this project.
- secrets
Sequence[Project
Secret Args] - List of secrets linked to this project.
- built
In List<Property Map>Environment Variables - List of built-in environment variables linked to this project.
- description String
- Description of the project.
- environment
Variable List<Property Map>Aliases - List of environment variable aliases linked to this project.
- environment
Variables List<Property Map> - List of environment variables linked to this project.
- name String
- Name of the project.
- organization
Id String - Id of the organization.
- secret
Aliases List<Property Map> - List of secret aliases linked to this project.
- secrets List<Property Map>
- List of secrets linked to this project.
Supporting Types
ProjectBuiltInEnvironmentVariable, ProjectBuiltInEnvironmentVariableArgs
ProjectEnvironmentVariable, ProjectEnvironmentVariableArgs
ProjectEnvironmentVariableAlias, ProjectEnvironmentVariableAliasArgs
ProjectSecret, ProjectSecretArgs
ProjectSecretAlias, ProjectSecretAliasArgs
Import
$ pulumi import qovery:index/project:Project my_project "<project_id>"
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.