Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Doppler
  3. API Docs
  4. secretsSync
  5. Circleci
Doppler v0.9.0 published on Tuesday, Aug 27, 2024 by Pulumiverse
pulumiverse/pulumi-doppler

doppler.secretsSync.Circleci

Explore with Pulumi AI

doppler logo
Doppler v0.9.0 published on Tuesday, Aug 27, 2024 by Pulumiverse
pulumiverse/pulumi-doppler

    Manage a CircleCI Doppler sync.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as doppler from "@pulumiverse/doppler";

const prod = new doppler.integration.Circleci("prod", {
    name: "Production",
    apiToken: "my_api_token",
});
const backendProd = new doppler.secretssync.Circleci("backend_prod", {
    integration: prod.id,
    project: "backend",
    config: "prd",
    resourceType: "project",
    resourceId: "github/myorg/myproject",
    organizationSlug: "myorg",
    deleteBehavior: "leave_in_target",
});

    import pulumi
import pulumiverse_doppler as doppler

prod = doppler.integration.Circleci("prod",
    name="Production",
    api_token="my_api_token")
backend_prod = doppler.secrets_sync.Circleci("backend_prod",
    integration=prod.id,
    project="backend",
    config="prd",
    resource_type="project",
    resource_id="github/myorg/myproject",
    organization_slug="myorg",
    delete_behavior="leave_in_target")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-doppler/sdk/go/doppler/integration"
	"github.com/pulumiverse/pulumi-doppler/sdk/go/doppler/secretsSync"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		prod, err := integration.NewCircleci(ctx, "prod", &integration.CircleciArgs{
			Name:     pulumi.String("Production"),
			ApiToken: pulumi.String("my_api_token"),
		})
		if err != nil {
			return err
		}
		_, err = secretsSync.NewCircleci(ctx, "backend_prod", &secretsSync.CircleciArgs{
			Integration:      prod.ID(),
			Project:          pulumi.String("backend"),
			Config:           pulumi.String("prd"),
			ResourceType:     pulumi.String("project"),
			ResourceId:       pulumi.String("github/myorg/myproject"),
			OrganizationSlug: pulumi.String("myorg"),
			DeleteBehavior:   pulumi.String("leave_in_target"),
		})
		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 prod = new Doppler.Integration.Circleci("prod", new()
    {
        Name = "Production",
        ApiToken = "my_api_token",
    });

    var backendProd = new Doppler.SecretsSync.Circleci("backend_prod", new()
    {
        Integration = prod.Id,
        Project = "backend",
        Config = "prd",
        ResourceType = "project",
        ResourceId = "github/myorg/myproject",
        OrganizationSlug = "myorg",
        DeleteBehavior = "leave_in_target",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.doppler.integration.Circleci;
import com.pulumi.doppler.integration.CircleciArgs;
import com.pulumi.doppler.secretsSync.Circleci;
import com.pulumi.doppler.secretsSync.CircleciArgs;
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 prod = new Circleci("prod", CircleciArgs.builder()
            .name("Production")
            .apiToken("my_api_token")
            .build());

        var backendProd = new Circleci("backendProd", CircleciArgs.builder()
            .integration(prod.id())
            .project("backend")
            .config("prd")
            .resourceType("project")
            .resourceId("github/myorg/myproject")
            .organizationSlug("myorg")
            .deleteBehavior("leave_in_target")
            .build());

    }
}

    resources:
  prod:
    type: doppler:integration:Circleci
    properties:
      name: Production
      apiToken: my_api_token
  backendProd:
    type: doppler:secretsSync:Circleci
    name: backend_prod
    properties:
      integration: ${prod.id}
      project: backend
      config: prd
      resourceType: project
      resourceId: github/myorg/myproject
      organizationSlug: myorg
      deleteBehavior: leave_in_target

    Create Circleci Resource

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

    Constructor syntax

    new Circleci(name: string, args: CircleciArgs, opts?: CustomResourceOptions);
    @overload
def Circleci(resource_name: str,
             args: CircleciArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Circleci(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             config: Optional[str] = None,
             integration: Optional[str] = None,
             organization_slug: Optional[str] = None,
             project: Optional[str] = None,
             resource_id: Optional[str] = None,
             resource_type: Optional[str] = None,
             delete_behavior: Optional[str] = None)
    func NewCircleci(ctx *Context, name string, args CircleciArgs, opts ...ResourceOption) (*Circleci, error)
    public Circleci(string name, CircleciArgs args, CustomResourceOptions? opts = null)
    public Circleci(String name, CircleciArgs args)
public Circleci(String name, CircleciArgs args, CustomResourceOptions options)

    type: doppler:secretsSync:Circleci
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 CircleciArgs
    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 CircleciArgs
    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 CircleciArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CircleciArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CircleciArgs
    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 dopplerCircleciResource = new Doppler.SecretsSync.Circleci("dopplerCircleciResource", new()
{
    Config = "string",
    Integration = "string",
    OrganizationSlug = "string",
    Project = "string",
    ResourceId = "string",
    ResourceType = "string",
    DeleteBehavior = "string",
});

    example, err := secretsSync.NewCircleci(ctx, "dopplerCircleciResource", &secretsSync.CircleciArgs{
	Config:           pulumi.String("string"),
	Integration:      pulumi.String("string"),
	OrganizationSlug: pulumi.String("string"),
	Project:          pulumi.String("string"),
	ResourceId:       pulumi.String("string"),
	ResourceType:     pulumi.String("string"),
	DeleteBehavior:   pulumi.String("string"),
})

    var dopplerCircleciResource = new Circleci("dopplerCircleciResource", CircleciArgs.builder()
    .config("string")
    .integration("string")
    .organizationSlug("string")
    .project("string")
    .resourceId("string")
    .resourceType("string")
    .deleteBehavior("string")
    .build());

    doppler_circleci_resource = doppler.secrets_sync.Circleci("dopplerCircleciResource",
    config="string",
    integration="string",
    organization_slug="string",
    project="string",
    resource_id="string",
    resource_type="string",
    delete_behavior="string")

    const dopplerCircleciResource = new doppler.secretssync.Circleci("dopplerCircleciResource", {
    config: "string",
    integration: "string",
    organizationSlug: "string",
    project: "string",
    resourceId: "string",
    resourceType: "string",
    deleteBehavior: "string",
});

    type: doppler:secretsSync:Circleci
properties:
    config: string
    deleteBehavior: string
    integration: string
    organizationSlug: string
    project: string
    resourceId: string
    resourceType: string

    Circleci Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Circleci resource accepts the following input properties:

    Config string
    The name of the Doppler config
    Integration string
    The slug of the integration to use for this sync
    OrganizationSlug string
    The organization slug where the resource is located
    Project string
    The name of the Doppler project
    ResourceId string
    The resource ID (either project or context) to sync to
    ResourceType string
    Either "project" or "context", based on the resource type to sync to
    DeleteBehavior string
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    Config string
    The name of the Doppler config
    Integration string
    The slug of the integration to use for this sync
    OrganizationSlug string
    The organization slug where the resource is located
    Project string
    The name of the Doppler project
    ResourceId string
    The resource ID (either project or context) to sync to
    ResourceType string
    Either "project" or "context", based on the resource type to sync to
    DeleteBehavior string
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    config String
    The name of the Doppler config
    integration String
    The slug of the integration to use for this sync
    organizationSlug String
    The organization slug where the resource is located
    project String
    The name of the Doppler project
    resourceId String
    The resource ID (either project or context) to sync to
    resourceType String
    Either "project" or "context", based on the resource type to sync to
    deleteBehavior String
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    config string
    The name of the Doppler config
    integration string
    The slug of the integration to use for this sync
    organizationSlug string
    The organization slug where the resource is located
    project string
    The name of the Doppler project
    resourceId string
    The resource ID (either project or context) to sync to
    resourceType string
    Either "project" or "context", based on the resource type to sync to
    deleteBehavior string
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    config str
    The name of the Doppler config
    integration str
    The slug of the integration to use for this sync
    organization_slug str
    The organization slug where the resource is located
    project str
    The name of the Doppler project
    resource_id str
    The resource ID (either project or context) to sync to
    resource_type str
    Either "project" or "context", based on the resource type to sync to
    delete_behavior str
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    config String
    The name of the Doppler config
    integration String
    The slug of the integration to use for this sync
    organizationSlug String
    The organization slug where the resource is located
    project String
    The name of the Doppler project
    resourceId String
    The resource ID (either project or context) to sync to
    resourceType String
    Either "project" or "context", based on the resource type to sync to
    deleteBehavior String
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.

    Outputs

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

    Get an existing Circleci 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?: CircleciState, opts?: CustomResourceOptions): Circleci
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[str] = None,
        delete_behavior: Optional[str] = None,
        integration: Optional[str] = None,
        organization_slug: Optional[str] = None,
        project: Optional[str] = None,
        resource_id: Optional[str] = None,
        resource_type: Optional[str] = None) -> Circleci
    func GetCircleci(ctx *Context, name string, id IDInput, state *CircleciState, opts ...ResourceOption) (*Circleci, error)
    public static Circleci Get(string name, Input<string> id, CircleciState? state, CustomResourceOptions? opts = null)
    public static Circleci get(String name, Output<String> id, CircleciState 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:
    Config string
    The name of the Doppler config
    DeleteBehavior string
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    Integration string
    The slug of the integration to use for this sync
    OrganizationSlug string
    The organization slug where the resource is located
    Project string
    The name of the Doppler project
    ResourceId string
    The resource ID (either project or context) to sync to
    ResourceType string
    Either "project" or "context", based on the resource type to sync to
    Config string
    The name of the Doppler config
    DeleteBehavior string
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    Integration string
    The slug of the integration to use for this sync
    OrganizationSlug string
    The organization slug where the resource is located
    Project string
    The name of the Doppler project
    ResourceId string
    The resource ID (either project or context) to sync to
    ResourceType string
    Either "project" or "context", based on the resource type to sync to
    config String
    The name of the Doppler config
    deleteBehavior String
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    integration String
    The slug of the integration to use for this sync
    organizationSlug String
    The organization slug where the resource is located
    project String
    The name of the Doppler project
    resourceId String
    The resource ID (either project or context) to sync to
    resourceType String
    Either "project" or "context", based on the resource type to sync to
    config string
    The name of the Doppler config
    deleteBehavior string
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    integration string
    The slug of the integration to use for this sync
    organizationSlug string
    The organization slug where the resource is located
    project string
    The name of the Doppler project
    resourceId string
    The resource ID (either project or context) to sync to
    resourceType string
    Either "project" or "context", based on the resource type to sync to
    config str
    The name of the Doppler config
    delete_behavior str
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    integration str
    The slug of the integration to use for this sync
    organization_slug str
    The organization slug where the resource is located
    project str
    The name of the Doppler project
    resource_id str
    The resource ID (either project or context) to sync to
    resource_type str
    Either "project" or "context", based on the resource type to sync to
    config String
    The name of the Doppler config
    deleteBehavior String
    The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either leave_in_target (default) or delete_from_target.
    integration String
    The slug of the integration to use for this sync
    organizationSlug String
    The organization slug where the resource is located
    project String
    The name of the Doppler project
    resourceId String
    The resource ID (either project or context) to sync to
    resourceType String
    Either "project" or "context", based on the resource type to sync to

    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.9.0 published on Tuesday, Aug 27, 2024 by Pulumiverse
    pulumiverse/pulumi-doppler