1. Packages
  2. Qovery
  3. API Docs
  4. DeploymentStage
Qovery v0.28.8 published on Sunday, Mar 3, 2024 by dirien

qovery.DeploymentStage

Explore with Pulumi AI

qovery logo
Qovery v0.28.8 published on Sunday, Mar 3, 2024 by dirien

    # qovery.DeploymentStage (Resource)

    Provides a Qovery deployment stage resource. This can be used to create and manage Qovery deployment stages.

    Example

    import * as pulumi from "@pulumi/pulumi";
    import * as qovery from "@ediri/qovery";
    
    const myDeploymentStage = new qovery.DeploymentStage("myDeploymentStage", {
        environmentId: qovery_environment.my_environment.id,
        description: "",
        isAfter: qovery_deployment_stage.first_deployment_stage.id,
        isBefore: qovery_deployment_stage.third_deployment_stage.id,
    }, {
        dependsOn: [qovery_environment.my_environment],
    });
    
    import pulumi
    import ediri_qovery as qovery
    
    my_deployment_stage = qovery.DeploymentStage("myDeploymentStage",
        environment_id=qovery_environment["my_environment"]["id"],
        description="",
        is_after=qovery_deployment_stage["first_deployment_stage"]["id"],
        is_before=qovery_deployment_stage["third_deployment_stage"]["id"],
        opts=pulumi.ResourceOptions(depends_on=[qovery_environment["my_environment"]]))
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Qovery = ediri.Qovery;
    
    return await Deployment.RunAsync(() => 
    {
        var myDeploymentStage = new Qovery.DeploymentStage("myDeploymentStage", new()
        {
            EnvironmentId = qovery_environment.My_environment.Id,
            Description = "",
            IsAfter = qovery_deployment_stage.First_deployment_stage.Id,
            IsBefore = qovery_deployment_stage.Third_deployment_stage.Id,
        }, new CustomResourceOptions
        {
            DependsOn = new[]
            {
                qovery_environment.My_environment,
            },
        });
    
    });
    
    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.NewDeploymentStage(ctx, "myDeploymentStage", &qovery.DeploymentStageArgs{
    			EnvironmentId: pulumi.Any(qovery_environment.My_environment.Id),
    			Description:   pulumi.String(""),
    			IsAfter:       pulumi.Any(qovery_deployment_stage.First_deployment_stage.Id),
    			IsBefore:      pulumi.Any(qovery_deployment_stage.Third_deployment_stage.Id),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			qovery_environment.My_environment,
    		}))
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.qovery.DeploymentStage;
    import com.pulumi.qovery.DeploymentStageArgs;
    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 myDeploymentStage = new DeploymentStage("myDeploymentStage", DeploymentStageArgs.builder()        
                .environmentId(qovery_environment.my_environment().id())
                .description("")
                .isAfter(qovery_deployment_stage.first_deployment_stage().id())
                .isBefore(qovery_deployment_stage.third_deployment_stage().id())
                .build(), CustomResourceOptions.builder()
                    .dependsOn(qovery_environment.my_environment())
                    .build());
    
        }
    }
    
    resources:
      myDeploymentStage:
        type: qovery:DeploymentStage
        properties:
          # Required
          environmentId: ${qovery_environment.my_environment.id}
          # Optional
          description:
          isAfter: ${qovery_deployment_stage.first_deployment_stage.id}
          isBefore: ${qovery_deployment_stage.third_deployment_stage.id}
        options:
          dependson:
            - ${qovery_environment.my_environment}
    

    You can find complete examples within these repositories:

    • Deploy services with a specific order

    Create DeploymentStage Resource

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

    Constructor syntax

    new DeploymentStage(name: string, args: DeploymentStageArgs, opts?: CustomResourceOptions);
    @overload
    def DeploymentStage(resource_name: str,
                        args: DeploymentStageArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def DeploymentStage(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        environment_id: Optional[str] = None,
                        description: Optional[str] = None,
                        is_after: Optional[str] = None,
                        is_before: Optional[str] = None,
                        name: Optional[str] = None)
    func NewDeploymentStage(ctx *Context, name string, args DeploymentStageArgs, opts ...ResourceOption) (*DeploymentStage, error)
    public DeploymentStage(string name, DeploymentStageArgs args, CustomResourceOptions? opts = null)
    public DeploymentStage(String name, DeploymentStageArgs args)
    public DeploymentStage(String name, DeploymentStageArgs args, CustomResourceOptions options)
    
    type: qovery:DeploymentStage
    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 DeploymentStageArgs
    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 DeploymentStageArgs
    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 DeploymentStageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeploymentStageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeploymentStageArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var deploymentStageResource = new Qovery.DeploymentStage("deploymentStageResource", new()
    {
        EnvironmentId = "string",
        Description = "string",
        IsAfter = "string",
        IsBefore = "string",
        Name = "string",
    });
    
    example, err := qovery.NewDeploymentStage(ctx, "deploymentStageResource", &qovery.DeploymentStageArgs{
    	EnvironmentId: pulumi.String("string"),
    	Description:   pulumi.String("string"),
    	IsAfter:       pulumi.String("string"),
    	IsBefore:      pulumi.String("string"),
    	Name:          pulumi.String("string"),
    })
    
    var deploymentStageResource = new DeploymentStage("deploymentStageResource", DeploymentStageArgs.builder()        
        .environmentId("string")
        .description("string")
        .isAfter("string")
        .isBefore("string")
        .name("string")
        .build());
    
    deployment_stage_resource = qovery.DeploymentStage("deploymentStageResource",
        environment_id="string",
        description="string",
        is_after="string",
        is_before="string",
        name="string")
    
    const deploymentStageResource = new qovery.DeploymentStage("deploymentStageResource", {
        environmentId: "string",
        description: "string",
        isAfter: "string",
        isBefore: "string",
        name: "string",
    });
    
    type: qovery:DeploymentStage
    properties:
        description: string
        environmentId: string
        isAfter: string
        isBefore: string
        name: string
    

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

    EnvironmentId string
    Id of the environment.
    Description string
    Description of the deployment stage.
    IsAfter string
    Move the current deployment stage after the target deployment stage
    IsBefore string
    Move the current deployment stage before the target deployment stage
    Name string
    Name of the deployment stage.
    EnvironmentId string
    Id of the environment.
    Description string
    Description of the deployment stage.
    IsAfter string
    Move the current deployment stage after the target deployment stage
    IsBefore string
    Move the current deployment stage before the target deployment stage
    Name string
    Name of the deployment stage.
    environmentId String
    Id of the environment.
    description String
    Description of the deployment stage.
    isAfter String
    Move the current deployment stage after the target deployment stage
    isBefore String
    Move the current deployment stage before the target deployment stage
    name String
    Name of the deployment stage.
    environmentId string
    Id of the environment.
    description string
    Description of the deployment stage.
    isAfter string
    Move the current deployment stage after the target deployment stage
    isBefore string
    Move the current deployment stage before the target deployment stage
    name string
    Name of the deployment stage.
    environment_id str
    Id of the environment.
    description str
    Description of the deployment stage.
    is_after str
    Move the current deployment stage after the target deployment stage
    is_before str
    Move the current deployment stage before the target deployment stage
    name str
    Name of the deployment stage.
    environmentId String
    Id of the environment.
    description String
    Description of the deployment stage.
    isAfter String
    Move the current deployment stage after the target deployment stage
    isBefore String
    Move the current deployment stage before the target deployment stage
    name String
    Name of the deployment stage.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DeploymentStage 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 DeploymentStage Resource

    Get an existing DeploymentStage 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?: DeploymentStageState, opts?: CustomResourceOptions): DeploymentStage
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            environment_id: Optional[str] = None,
            is_after: Optional[str] = None,
            is_before: Optional[str] = None,
            name: Optional[str] = None) -> DeploymentStage
    func GetDeploymentStage(ctx *Context, name string, id IDInput, state *DeploymentStageState, opts ...ResourceOption) (*DeploymentStage, error)
    public static DeploymentStage Get(string name, Input<string> id, DeploymentStageState? state, CustomResourceOptions? opts = null)
    public static DeploymentStage get(String name, Output<String> id, DeploymentStageState 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 deployment stage.
    EnvironmentId string
    Id of the environment.
    IsAfter string
    Move the current deployment stage after the target deployment stage
    IsBefore string
    Move the current deployment stage before the target deployment stage
    Name string
    Name of the deployment stage.
    Description string
    Description of the deployment stage.
    EnvironmentId string
    Id of the environment.
    IsAfter string
    Move the current deployment stage after the target deployment stage
    IsBefore string
    Move the current deployment stage before the target deployment stage
    Name string
    Name of the deployment stage.
    description String
    Description of the deployment stage.
    environmentId String
    Id of the environment.
    isAfter String
    Move the current deployment stage after the target deployment stage
    isBefore String
    Move the current deployment stage before the target deployment stage
    name String
    Name of the deployment stage.
    description string
    Description of the deployment stage.
    environmentId string
    Id of the environment.
    isAfter string
    Move the current deployment stage after the target deployment stage
    isBefore string
    Move the current deployment stage before the target deployment stage
    name string
    Name of the deployment stage.
    description str
    Description of the deployment stage.
    environment_id str
    Id of the environment.
    is_after str
    Move the current deployment stage after the target deployment stage
    is_before str
    Move the current deployment stage before the target deployment stage
    name str
    Name of the deployment stage.
    description String
    Description of the deployment stage.
    environmentId String
    Id of the environment.
    isAfter String
    Move the current deployment stage after the target deployment stage
    isBefore String
    Move the current deployment stage before the target deployment stage
    name String
    Name of the deployment stage.

    Import

     $ pulumi import qovery:index/deploymentStage:DeploymentStage my_deployment_stage "<environment_id>,<deployment_stage_name>"
    

    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 logo
    Qovery v0.28.8 published on Sunday, Mar 3, 2024 by dirien