1. Packages
  2. Doppler
  3. API Docs
  4. BranchConfig
Doppler v0.7.0 published on Thursday, May 2, 2024 by Pulumiverse

doppler.BranchConfig

Explore with Pulumi AI

doppler logo
Doppler v0.7.0 published on Thursday, May 2, 2024 by Pulumiverse

    Manage a Doppler config.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as doppler from "@pulumiverse/doppler";
    
    const backendCiGithub = new doppler.BranchConfig("backend_ci_github", {
        project: "backend",
        environment: "ci",
        name: "ci_github",
    });
    
    import pulumi
    import pulumiverse_doppler as doppler
    
    backend_ci_github = doppler.BranchConfig("backend_ci_github",
        project="backend",
        environment="ci",
        name="ci_github")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-doppler/sdk/go/doppler"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := doppler.NewBranchConfig(ctx, "backend_ci_github", &doppler.BranchConfigArgs{
    			Project:     pulumi.String("backend"),
    			Environment: pulumi.String("ci"),
    			Name:        pulumi.String("ci_github"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Doppler = Pulumiverse.Doppler;
    
    return await Deployment.RunAsync(() => 
    {
        var backendCiGithub = new Doppler.BranchConfig("backend_ci_github", new()
        {
            Project = "backend",
            Environment = "ci",
            Name = "ci_github",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.doppler.BranchConfig;
    import com.pulumi.doppler.BranchConfigArgs;
    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 backendCiGithub = new BranchConfig("backendCiGithub", BranchConfigArgs.builder()        
                .project("backend")
                .environment("ci")
                .name("ci_github")
                .build());
    
        }
    }
    
    resources:
      backendCiGithub:
        type: doppler:BranchConfig
        name: backend_ci_github
        properties:
          project: backend
          environment: ci
          name: ci_github
    

    Create BranchConfig Resource

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

    Constructor syntax

    new BranchConfig(name: string, args: BranchConfigArgs, opts?: CustomResourceOptions);
    @overload
    def BranchConfig(resource_name: str,
                     args: BranchConfigArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def BranchConfig(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     environment: Optional[str] = None,
                     project: Optional[str] = None,
                     name: Optional[str] = None)
    func NewBranchConfig(ctx *Context, name string, args BranchConfigArgs, opts ...ResourceOption) (*BranchConfig, error)
    public BranchConfig(string name, BranchConfigArgs args, CustomResourceOptions? opts = null)
    public BranchConfig(String name, BranchConfigArgs args)
    public BranchConfig(String name, BranchConfigArgs args, CustomResourceOptions options)
    
    type: doppler:BranchConfig
    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 BranchConfigArgs
    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 BranchConfigArgs
    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 BranchConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BranchConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BranchConfigArgs
    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 branchConfigResource = new Doppler.BranchConfig("branchConfigResource", new()
    {
        Environment = "string",
        Project = "string",
        Name = "string",
    });
    
    example, err := doppler.NewBranchConfig(ctx, "branchConfigResource", &doppler.BranchConfigArgs{
    	Environment: pulumi.String("string"),
    	Project:     pulumi.String("string"),
    	Name:        pulumi.String("string"),
    })
    
    var branchConfigResource = new BranchConfig("branchConfigResource", BranchConfigArgs.builder()        
        .environment("string")
        .project("string")
        .name("string")
        .build());
    
    branch_config_resource = doppler.BranchConfig("branchConfigResource",
        environment="string",
        project="string",
        name="string")
    
    const branchConfigResource = new doppler.BranchConfig("branchConfigResource", {
        environment: "string",
        project: "string",
        name: "string",
    });
    
    type: doppler:BranchConfig
    properties:
        environment: string
        name: string
        project: string
    

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

    Environment string
    The name of the Doppler environment where the config is located
    Project string
    The name of the Doppler project where the config is located
    Name string
    The name of the Doppler config
    Environment string
    The name of the Doppler environment where the config is located
    Project string
    The name of the Doppler project where the config is located
    Name string
    The name of the Doppler config
    environment String
    The name of the Doppler environment where the config is located
    project String
    The name of the Doppler project where the config is located
    name String
    The name of the Doppler config
    environment string
    The name of the Doppler environment where the config is located
    project string
    The name of the Doppler project where the config is located
    name string
    The name of the Doppler config
    environment str
    The name of the Doppler environment where the config is located
    project str
    The name of the Doppler project where the config is located
    name str
    The name of the Doppler config
    environment String
    The name of the Doppler environment where the config is located
    project String
    The name of the Doppler project where the config is located
    name String
    The name of the Doppler config

    Outputs

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

    Get an existing BranchConfig 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?: BranchConfigState, opts?: CustomResourceOptions): BranchConfig
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            environment: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None) -> BranchConfig
    func GetBranchConfig(ctx *Context, name string, id IDInput, state *BranchConfigState, opts ...ResourceOption) (*BranchConfig, error)
    public static BranchConfig Get(string name, Input<string> id, BranchConfigState? state, CustomResourceOptions? opts = null)
    public static BranchConfig get(String name, Output<String> id, BranchConfigState 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:
    Environment string
    The name of the Doppler environment where the config is located
    Name string
    The name of the Doppler config
    Project string
    The name of the Doppler project where the config is located
    Environment string
    The name of the Doppler environment where the config is located
    Name string
    The name of the Doppler config
    Project string
    The name of the Doppler project where the config is located
    environment String
    The name of the Doppler environment where the config is located
    name String
    The name of the Doppler config
    project String
    The name of the Doppler project where the config is located
    environment string
    The name of the Doppler environment where the config is located
    name string
    The name of the Doppler config
    project string
    The name of the Doppler project where the config is located
    environment str
    The name of the Doppler environment where the config is located
    name str
    The name of the Doppler config
    project str
    The name of the Doppler project where the config is located
    environment String
    The name of the Doppler environment where the config is located
    name String
    The name of the Doppler config
    project String
    The name of the Doppler project where the config is located

    Import

    $ pulumi import doppler:index/branchConfig:BranchConfig default <project-name>.<environment-slug>.<config-name>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    doppler pulumiverse/pulumi-doppler
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the doppler Terraform Provider.
    doppler logo
    Doppler v0.7.0 published on Thursday, May 2, 2024 by Pulumiverse