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

doppler.Secret

Explore with Pulumi AI

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

    Manage a single Doppler secret in a config.

    Create Secret Resource

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

    Constructor syntax

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

@overload
def Secret(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           config: Optional[str] = None,
           name: Optional[str] = None,
           project: Optional[str] = None,
           value: Optional[str] = None,
           visibility: Optional[str] = None)
    func NewSecret(ctx *Context, name string, args SecretArgs, opts ...ResourceOption) (*Secret, error)
    public Secret(string name, SecretArgs args, CustomResourceOptions? opts = null)
    public Secret(String name, SecretArgs args)
public Secret(String name, SecretArgs args, CustomResourceOptions options)

    type: doppler:Secret
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 SecretArgs
    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 SecretArgs
    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 SecretArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SecretArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SecretArgs
    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 secretResource = new Doppler.Secret("secretResource", new()
{
    Config = "string",
    Name = "string",
    Project = "string",
    Value = "string",
    Visibility = "string",
});

    example, err := doppler.NewSecret(ctx, "secretResource", &doppler.SecretArgs{
	Config:     pulumi.String("string"),
	Name:       pulumi.String("string"),
	Project:    pulumi.String("string"),
	Value:      pulumi.String("string"),
	Visibility: pulumi.String("string"),
})

    var secretResource = new Secret("secretResource", SecretArgs.builder()
    .config("string")
    .name("string")
    .project("string")
    .value("string")
    .visibility("string")
    .build());

    secret_resource = doppler.Secret("secretResource",
    config="string",
    name="string",
    project="string",
    value="string",
    visibility="string")

    const secretResource = new doppler.Secret("secretResource", {
    config: "string",
    name: "string",
    project: "string",
    value: "string",
    visibility: "string",
});

    type: doppler:Secret
properties:
    config: string
    name: string
    project: string
    value: string
    visibility: string

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

    Config string
    The name of the Doppler config
    Name string
    The name of the Doppler secret
    Project string
    The name of the Doppler project
    Value string
    The raw secret value
    Visibility string
    The visibility of the secret
    Config string
    The name of the Doppler config
    Name string
    The name of the Doppler secret
    Project string
    The name of the Doppler project
    Value string
    The raw secret value
    Visibility string
    The visibility of the secret
    config String
    The name of the Doppler config
    name String
    The name of the Doppler secret
    project String
    The name of the Doppler project
    value String
    The raw secret value
    visibility String
    The visibility of the secret
    config string
    The name of the Doppler config
    name string
    The name of the Doppler secret
    project string
    The name of the Doppler project
    value string
    The raw secret value
    visibility string
    The visibility of the secret
    config str
    The name of the Doppler config
    name str
    The name of the Doppler secret
    project str
    The name of the Doppler project
    value str
    The raw secret value
    visibility str
    The visibility of the secret
    config String
    The name of the Doppler config
    name String
    The name of the Doppler secret
    project String
    The name of the Doppler project
    value String
    The raw secret value
    visibility String
    The visibility of the secret

    Outputs

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

    Computed string
    The computed secret value, after resolving secret references
    Id string
    The provider-assigned unique ID for this managed resource.
    Computed string
    The computed secret value, after resolving secret references
    Id string
    The provider-assigned unique ID for this managed resource.
    computed String
    The computed secret value, after resolving secret references
    id String
    The provider-assigned unique ID for this managed resource.
    computed string
    The computed secret value, after resolving secret references
    id string
    The provider-assigned unique ID for this managed resource.
    computed str
    The computed secret value, after resolving secret references
    id str
    The provider-assigned unique ID for this managed resource.
    computed String
    The computed secret value, after resolving secret references
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Secret Resource

    Get an existing Secret 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?: SecretState, opts?: CustomResourceOptions): Secret
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        computed: Optional[str] = None,
        config: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        value: Optional[str] = None,
        visibility: Optional[str] = None) -> Secret
    func GetSecret(ctx *Context, name string, id IDInput, state *SecretState, opts ...ResourceOption) (*Secret, error)
    public static Secret Get(string name, Input<string> id, SecretState? state, CustomResourceOptions? opts = null)
    public static Secret get(String name, Output<String> id, SecretState 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:
    Computed string
    The computed secret value, after resolving secret references
    Config string
    The name of the Doppler config
    Name string
    The name of the Doppler secret
    Project string
    The name of the Doppler project
    Value string
    The raw secret value
    Visibility string
    The visibility of the secret
    Computed string
    The computed secret value, after resolving secret references
    Config string
    The name of the Doppler config
    Name string
    The name of the Doppler secret
    Project string
    The name of the Doppler project
    Value string
    The raw secret value
    Visibility string
    The visibility of the secret
    computed String
    The computed secret value, after resolving secret references
    config String
    The name of the Doppler config
    name String
    The name of the Doppler secret
    project String
    The name of the Doppler project
    value String
    The raw secret value
    visibility String
    The visibility of the secret
    computed string
    The computed secret value, after resolving secret references
    config string
    The name of the Doppler config
    name string
    The name of the Doppler secret
    project string
    The name of the Doppler project
    value string
    The raw secret value
    visibility string
    The visibility of the secret
    computed str
    The computed secret value, after resolving secret references
    config str
    The name of the Doppler config
    name str
    The name of the Doppler secret
    project str
    The name of the Doppler project
    value str
    The raw secret value
    visibility str
    The visibility of the secret
    computed String
    The computed secret value, after resolving secret references
    config String
    The name of the Doppler config
    name String
    The name of the Doppler secret
    project String
    The name of the Doppler project
    value String
    The raw secret value
    visibility String
    The visibility of the secret

    Import

    $ pulumi import doppler:index/secret:Secret default <project-name>.<config-name>.<secret-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.9.0 published on Tuesday, Aug 27, 2024 by Pulumiverse
    pulumiverse/pulumi-doppler