@pulumiverse/cpln/secret.d.ts

A Pulumi package for creating and managing Control Plane (cpln) resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
export declare class Secret extends pulumi.CustomResource {
    /**
     * Get an existing Secret resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SecretState, opts?: pulumi.CustomResourceOptions): Secret;
    /**
     * Returns true if the given object is an instance of Secret.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is Secret;
    /**
     * [Reference Page](https://docs.controlplane.com/reference/secret#aws).
     */
    readonly aws: pulumi.Output<outputs.SecretAws | undefined>;
    /**
     * [Reference Page](https://docs.controlplane.com/reference/secret#azure-connector).
     */
    readonly azureConnector: pulumi.Output<outputs.SecretAzureConnector | undefined>;
    /**
     * JSON string containing the Docker secret. [Reference Page](https://docs.controlplane.com/reference/secret#azure).
     */
    readonly azureSdk: pulumi.Output<string | undefined>;
    /**
     * The ID, in GUID format, of the secret.
     */
    readonly cplnId: pulumi.Output<string>;
    /**
     * Description of the secret.
     */
    readonly description: pulumi.Output<string>;
    /**
     * List of unique key-value pairs. [Reference Page](https://docs.controlplane.com/reference/secret#dictionary).
     */
    readonly dictionary: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * If a dictionary secret is defined, this output will be a key-value map in the following format: `key = cpln://secret/SECRET_NAME.key`.
     */
    readonly dictionaryAsEnvs: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * JSON string containing the Docker secret. [Reference Page](https://docs.controlplane.com/reference/secret#docker).
     */
    readonly docker: pulumi.Output<string | undefined>;
    readonly ecr: pulumi.Output<outputs.SecretEcr | undefined>;
    /**
     * JSON string containing the GCP secret. [Reference Page](https://docs.controlplane.com/reference/secret#gcp)
     */
    readonly gcp: pulumi.Output<string | undefined>;
    /**
     * [Reference Page](https://docs.controlplane.com/reference/secret#keypair).
     */
    readonly keypair: pulumi.Output<outputs.SecretKeypair | undefined>;
    /**
     * Name of the secret.
     */
    readonly name: pulumi.Output<string>;
    /**
     * [Reference Page](https://docs.controlplane.com/reference/secret#nats-account).
     */
    readonly natsAccount: pulumi.Output<outputs.SecretNatsAccount | undefined>;
    /**
     * [Reference Page](https://docs.controlplane.com/reference/secret#opaque).
     */
    readonly opaque: pulumi.Output<outputs.SecretOpaque | undefined>;
    /**
     * Output used when linking a secret to an environment variable or volume.
     */
    readonly secretLink: pulumi.Output<string>;
    /**
     * Full link to this resource. Can be referenced by other resources.
     */
    readonly selfLink: pulumi.Output<string>;
    /**
     * Key-value map of resource tags.
     */
    readonly tags: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * [Reference Page](https://docs.controlplane.com/reference/secret#tls).
     */
    readonly tls: pulumi.Output<outputs.SecretTls | undefined>;
    /**
     * [Reference Page](https://docs.controlplane.com/reference/secret#username).
     */
    readonly userpass: pulumi.Output<outputs.SecretUserpass | undefined>;
    /**
     * Create a Secret resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args?: SecretArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Secret resources.
 */
export interface SecretState {
    /**
     * [Reference Page](https://docs.controlplane.com/reference/secret#aws).
     */
    aws?: pulumi.Input<inputs.SecretAws>;
    /**
     * [Reference Page](https://docs.controlplane.com/reference/secret#azure-connector).
     */
    azureConnector?: pulumi.Input<inputs.SecretAzureConnector>;
    /**
     * JSON string containing the Docker secret. [Reference Page](https://docs.controlplane.com/reference/secret#azure).
     */
    azureSdk?: pulumi.Input<string>;
    /**
     * The ID, in GUID format, of the secret.
     */
    cplnId?: pulumi.Input<string>;
    /**
     * Description of the secret.
     */
    description?: pulumi.Input<string>;
    /**
     * List of unique key-value pairs. [Reference Page](https://docs.controlplane.com/reference/secret#dictionary).
     */
    dictionary?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * If a dictionary secret is defined, this output will be a key-value map in the following format: `key = cpln://secret/SECRET_NAME.key`.
     */
    dictionaryAsEnvs?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * JSON string containing the Docker secret. [Reference Page](https://docs.controlplane.com/reference/secret#docker).
     */
    docker?: pulumi.Input<string>;
    ecr?: pulumi.Input<inputs.SecretEcr>;
    /**
     * JSON string containing the GCP secret. [Reference Page](https://docs.controlplane.com/reference/secret#gcp)
     */
    gcp?: pulumi.Input<string>;
    /**
     * [Reference Page](https://docs.controlplane.com/reference/secret#keypair).
     */
    keypair?: pulumi.Input<inputs.SecretKeypair>;
    /**
     * Name of the secret.
     */
    name?: pulumi.Input<string>;
    /**
     * [Reference Page](https://docs.controlplane.com/reference/secret#nats-account).
     */
    natsAccount?: pulumi.Input<inputs.SecretNatsAccount>;
    /**
     * [Reference Page](https://docs.controlplane.com/reference/secret#opaque).
     */
    opaque?: pulumi.Input<inputs.SecretOpaque>;
    /**
     * Output used when linking a secret to an environment variable or volume.
     */
    secretLink?: pulumi.Input<string>;
    /**
     * Full link to this resource. Can be referenced by other resources.
     */
    selfLink?: pulumi.Input<string>;
    /**
     * Key-value map of resource tags.
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * [Reference Page](https://docs.controlplane.com/reference/secret#tls).
     */
    tls?: pulumi.Input<inputs.SecretTls>;
    /**
     * [Reference Page](https://docs.controlplane.com/reference/secret#username).
     */
    userpass?: pulumi.Input<inputs.SecretUserpass>;
}
/**
 * The set of arguments for constructing a Secret resource.
 */
export interface SecretArgs {
    /**
     * [Reference Page](https://docs.controlplane.com/reference/secret#aws).
     */
    aws?: pulumi.Input<inputs.SecretAws>;
    /**
     * [Reference Page](https://docs.controlplane.com/reference/secret#azure-connector).
     */
    azureConnector?: pulumi.Input<inputs.SecretAzureConnector>;
    /**
     * JSON string containing the Docker secret. [Reference Page](https://docs.controlplane.com/reference/secret#azure).
     */
    azureSdk?: pulumi.Input<string>;
    /**
     * Description of the secret.
     */
    description?: pulumi.Input<string>;
    /**
     * List of unique key-value pairs. [Reference Page](https://docs.controlplane.com/reference/secret#dictionary).
     */
    dictionary?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * JSON string containing the Docker secret. [Reference Page](https://docs.controlplane.com/reference/secret#docker).
     */
    docker?: pulumi.Input<string>;
    ecr?: pulumi.Input<inputs.SecretEcr>;
    /**
     * JSON string containing the GCP secret. [Reference Page](https://docs.controlplane.com/reference/secret#gcp)
     */
    gcp?: pulumi.Input<string>;
    /**
     * [Reference Page](https://docs.controlplane.com/reference/secret#keypair).
     */
    keypair?: pulumi.Input<inputs.SecretKeypair>;
    /**
     * Name of the secret.
     */
    name?: pulumi.Input<string>;
    /**
     * [Reference Page](https://docs.controlplane.com/reference/secret#nats-account).
     */
    natsAccount?: pulumi.Input<inputs.SecretNatsAccount>;
    /**
     * [Reference Page](https://docs.controlplane.com/reference/secret#opaque).
     */
    opaque?: pulumi.Input<inputs.SecretOpaque>;
    /**
     * Key-value map of resource tags.
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * [Reference Page](https://docs.controlplane.com/reference/secret#tls).
     */
    tls?: pulumi.Input<inputs.SecretTls>;
    /**
     * [Reference Page](https://docs.controlplane.com/reference/secret#username).
     */
    userpass?: pulumi.Input<inputs.SecretUserpass>;
}