Qovery v0.28.10, Jun 7 24

Qovery v0.28.10 published on Friday, Jun 7, 2024 by dirien

qovery.Organization

Explore with Pulumi AI

Qovery v0.28.10 published on Friday, Jun 7, 2024 by dirien

dirien/pulumi-qovery

# qovery.Organization (Resource)

Provides a Qovery organization resource. This can be used to create and manage Qovery organizations.

Example

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

const myOrganization = new qovery.Organization("myOrganization", {
    description: "My organization description",
    plan: "FREE",
});

import pulumi
import ediri_qovery as qovery

my_organization = qovery.Organization("myOrganization",
    description="My organization description",
    plan="FREE")

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.NewOrganization(ctx, "myOrganization", &qovery.OrganizationArgs{
			Description: pulumi.String("My organization description"),
			Plan:        pulumi.String("FREE"),
		})
		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 myOrganization = new Qovery.Organization("myOrganization", new()
    {
        Description = "My organization description",
        Plan = "FREE",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.qovery.Organization;
import com.pulumi.qovery.OrganizationArgs;
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 myOrganization = new Organization("myOrganization", OrganizationArgs.builder()
            .description("My organization description")
            .plan("FREE")
            .build());

    }
}

resources:
  myOrganization:
    type: qovery:Organization
    properties:
      # Optional
      description: My organization description
      plan: FREE

Create Organization Resource

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

Constructor syntax

new Organization(name: string, args: OrganizationArgs, opts?: CustomResourceOptions);

@overload
def Organization(resource_name: str,
                 args: OrganizationArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def Organization(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 plan: Optional[str] = None,
                 description: Optional[str] = None,
                 name: Optional[str] = None)

func NewOrganization(ctx *Context, name string, args OrganizationArgs, opts ...ResourceOption) (*Organization, error)

public Organization(string name, OrganizationArgs args, CustomResourceOptions? opts = null)

public Organization(String name, OrganizationArgs args)
public Organization(String name, OrganizationArgs args, CustomResourceOptions options)

type: qovery:Organization
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 OrganizationArgs: 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 OrganizationArgs: 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 OrganizationArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args OrganizationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args OrganizationArgs: 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 organizationResource = new Qovery.Organization("organizationResource", new()
{
    Plan = "string",
    Description = "string",
    Name = "string",
});

example, err := qovery.NewOrganization(ctx, "organizationResource", &qovery.OrganizationArgs{
	Plan:        pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})

var organizationResource = new Organization("organizationResource", OrganizationArgs.builder()
    .plan("string")
    .description("string")
    .name("string")
    .build());

organization_resource = qovery.Organization("organizationResource",
    plan="string",
    description="string",
    name="string")

const organizationResource = new qovery.Organization("organizationResource", {
    plan: "string",
    description: "string",
    name: "string",
});

type: qovery:Organization
properties:
    description: string
    name: string
    plan: string

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

Plan string: Plan of the organization. - Can be: BUSINESS, ENTERPRISE, ENTERPRISE_YEARLY, FREE, PROFESSIONAL, TEAM, TEAM_YEARLY.
Description string: Description of the organization.
Name string: Name of the organization.

Plan string: Plan of the organization. - Can be: BUSINESS, ENTERPRISE, ENTERPRISE_YEARLY, FREE, PROFESSIONAL, TEAM, TEAM_YEARLY.
Description string: Description of the organization.
Name string: Name of the organization.

plan String: Plan of the organization. - Can be: BUSINESS, ENTERPRISE, ENTERPRISE_YEARLY, FREE, PROFESSIONAL, TEAM, TEAM_YEARLY.
description String: Description of the organization.
name String: Name of the organization.

plan string: Plan of the organization. - Can be: BUSINESS, ENTERPRISE, ENTERPRISE_YEARLY, FREE, PROFESSIONAL, TEAM, TEAM_YEARLY.
description string: Description of the organization.
name string: Name of the organization.

plan str: Plan of the organization. - Can be: BUSINESS, ENTERPRISE, ENTERPRISE_YEARLY, FREE, PROFESSIONAL, TEAM, TEAM_YEARLY.
description str: Description of the organization.
name str: Name of the organization.

plan String: Plan of the organization. - Can be: BUSINESS, ENTERPRISE, ENTERPRISE_YEARLY, FREE, PROFESSIONAL, TEAM, TEAM_YEARLY.
description String: Description of the organization.
name String: Name of the organization.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing Organization Resource

Get an existing Organization 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?: OrganizationState, opts?: CustomResourceOptions): Organization

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        plan: Optional[str] = None) -> Organization

func GetOrganization(ctx *Context, name string, id IDInput, state *OrganizationState, opts ...ResourceOption) (*Organization, error)

public static Organization Get(string name, Input<string> id, OrganizationState? state, CustomResourceOptions? opts = null)

public static Organization get(String name, Output<String> id, OrganizationState 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.

The following state arguments are supported:

Description string: Description of the organization.
Name string: Name of the organization.
Plan string: Plan of the organization. - Can be: BUSINESS, ENTERPRISE, ENTERPRISE_YEARLY, FREE, PROFESSIONAL, TEAM, TEAM_YEARLY.

Description string: Description of the organization.
Name string: Name of the organization.
Plan string: Plan of the organization. - Can be: BUSINESS, ENTERPRISE, ENTERPRISE_YEARLY, FREE, PROFESSIONAL, TEAM, TEAM_YEARLY.

description String: Description of the organization.
name String: Name of the organization.
plan String: Plan of the organization. - Can be: BUSINESS, ENTERPRISE, ENTERPRISE_YEARLY, FREE, PROFESSIONAL, TEAM, TEAM_YEARLY.

description string: Description of the organization.
name string: Name of the organization.
plan string: Plan of the organization. - Can be: BUSINESS, ENTERPRISE, ENTERPRISE_YEARLY, FREE, PROFESSIONAL, TEAM, TEAM_YEARLY.

description str: Description of the organization.
name str: Name of the organization.
plan str: Plan of the organization. - Can be: BUSINESS, ENTERPRISE, ENTERPRISE_YEARLY, FREE, PROFESSIONAL, TEAM, TEAM_YEARLY.

description String: Description of the organization.
name String: Name of the organization.
plan String: Plan of the organization. - Can be: BUSINESS, ENTERPRISE, ENTERPRISE_YEARLY, FREE, PROFESSIONAL, TEAM, TEAM_YEARLY.

Import

$ pulumi import qovery:index/organization:Organization my_organization "<organization_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.

Qovery v0.28.10 published on Friday, Jun 7, 2024 by dirien

dirien/pulumi-qovery

qovery.Organization

On this page

On this page

# qovery.Organization (Resource)

Example

Create Organization Resource

Constructor syntax

Parameters

Constructor example

Organization Resource Properties

Inputs

Outputs

Look up Existing Organization Resource

Import

Package Details

On this page

On this page