1. Packages
  2. Koyeb
  3. API Docs
  4. getSecret
Viewing docs for Koyeb v0.1.11
published on Monday, Dec 9, 2024 by Koyeb
Schema (JSON)
koyeb/pulumi-koyeb

koyeb.getSecret

koyeb logo
Viewing docs for Koyeb v0.1.11
published on Monday, Dec 9, 2024 by Koyeb
Schema (JSON)
koyeb/pulumi-koyeb

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as koyeb from "@pulumi/koyeb";

const my-secret = koyeb.getSecret({
    name: "my-secret",
});

    import pulumi
import pulumi_koyeb as koyeb

my_secret = koyeb.get_secret(name="my-secret")

    package main

import (
	"github.com/koyeb/pulumi-koyeb/sdk/go/koyeb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := koyeb.LookupSecret(ctx, &koyeb.LookupSecretArgs{
			Name: "my-secret",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Koyeb = Pulumi.Koyeb;

return await Deployment.RunAsync(() => 
{
    var my_secret = Koyeb.GetSecret.Invoke(new()
    {
        Name = "my-secret",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.koyeb.KoyebFunctions;
import com.pulumi.koyeb.inputs.GetSecretArgs;
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) {
        final var my-secret = KoyebFunctions.getSecret(GetSecretArgs.builder()
            .name("my-secret")
            .build());

    }
}

    variables:
  my-secret:
    fn::invoke:
      Function: koyeb:getSecret
      Arguments:
        name: my-secret

    Using getSecret

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSecret(args: GetSecretArgs, opts?: InvokeOptions): Promise<GetSecretResult>
function getSecretOutput(args: GetSecretOutputArgs, opts?: InvokeOptions): Output<GetSecretResult>
    def get_secret(azure_container_registry: Optional[GetSecretAzureContainerRegistry] = None,
               digital_ocean_container_registry: Optional[GetSecretDigitalOceanContainerRegistry] = None,
               docker_hub_registry: Optional[GetSecretDockerHubRegistry] = None,
               github_registry: Optional[GetSecretGithubRegistry] = None,
               gitlab_registry: Optional[GetSecretGitlabRegistry] = None,
               name: Optional[str] = None,
               private_registry: Optional[GetSecretPrivateRegistry] = None,
               type: Optional[str] = None,
               value: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetSecretResult
def get_secret_output(azure_container_registry: Optional[pulumi.Input[GetSecretAzureContainerRegistryArgs]] = None,
               digital_ocean_container_registry: Optional[pulumi.Input[GetSecretDigitalOceanContainerRegistryArgs]] = None,
               docker_hub_registry: Optional[pulumi.Input[GetSecretDockerHubRegistryArgs]] = None,
               github_registry: Optional[pulumi.Input[GetSecretGithubRegistryArgs]] = None,
               gitlab_registry: Optional[pulumi.Input[GetSecretGitlabRegistryArgs]] = None,
               name: Optional[pulumi.Input[str]] = None,
               private_registry: Optional[pulumi.Input[GetSecretPrivateRegistryArgs]] = None,
               type: Optional[pulumi.Input[str]] = None,
               value: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetSecretResult]
    func LookupSecret(ctx *Context, args *LookupSecretArgs, opts ...InvokeOption) (*LookupSecretResult, error)
func LookupSecretOutput(ctx *Context, args *LookupSecretOutputArgs, opts ...InvokeOption) LookupSecretResultOutput

    > Note: This function is named LookupSecret in the Go SDK.

    public static class GetSecret 
{
    public static Task<GetSecretResult> InvokeAsync(GetSecretArgs args, InvokeOptions? opts = null)
    public static Output<GetSecretResult> Invoke(GetSecretInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSecretResult> getSecret(GetSecretArgs args, InvokeOptions options)
public static Output<GetSecretResult> getSecret(GetSecretArgs args, InvokeOptions options)

    fn::invoke:
  function: koyeb:index/getSecret:getSecret
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The secret name
    AzureContainerRegistry GetSecretAzureContainerRegistry
    The azurecontainerregistry configuration to use
    DigitalOceanContainerRegistry GetSecretDigitalOceanContainerRegistry
    The digitaloceancontainer*registry configuration to use
    DockerHubRegistry GetSecretDockerHubRegistry
    The dockerhubregistry configuration to use
    GithubRegistry GetSecretGithubRegistry
    The github*registry configuration to use
    GitlabRegistry GetSecretGitlabRegistry
    The gitlab*registry configuration to use
    PrivateRegistry GetSecretPrivateRegistry
    The private*registry configuration to use
    Type string
    The secret type
    Value string
    The secret value
    Name string
    The secret name
    AzureContainerRegistry GetSecretAzureContainerRegistry
    The azurecontainerregistry configuration to use
    DigitalOceanContainerRegistry GetSecretDigitalOceanContainerRegistry
    The digitaloceancontainer*registry configuration to use
    DockerHubRegistry GetSecretDockerHubRegistry
    The dockerhubregistry configuration to use
    GithubRegistry GetSecretGithubRegistry
    The github*registry configuration to use
    GitlabRegistry GetSecretGitlabRegistry
    The gitlab*registry configuration to use
    PrivateRegistry GetSecretPrivateRegistry
    The private*registry configuration to use
    Type string
    The secret type
    Value string
    The secret value
    name String
    The secret name
    azureContainerRegistry GetSecretAzureContainerRegistry
    The azurecontainerregistry configuration to use
    digitalOceanContainerRegistry GetSecretDigitalOceanContainerRegistry
    The digitaloceancontainer*registry configuration to use
    dockerHubRegistry GetSecretDockerHubRegistry
    The dockerhubregistry configuration to use
    githubRegistry GetSecretGithubRegistry
    The github*registry configuration to use
    gitlabRegistry GetSecretGitlabRegistry
    The gitlab*registry configuration to use
    privateRegistry GetSecretPrivateRegistry
    The private*registry configuration to use
    type String
    The secret type
    value String
    The secret value
    name string
    The secret name
    azureContainerRegistry GetSecretAzureContainerRegistry
    The azurecontainerregistry configuration to use
    digitalOceanContainerRegistry GetSecretDigitalOceanContainerRegistry
    The digitaloceancontainer*registry configuration to use
    dockerHubRegistry GetSecretDockerHubRegistry
    The dockerhubregistry configuration to use
    githubRegistry GetSecretGithubRegistry
    The github*registry configuration to use
    gitlabRegistry GetSecretGitlabRegistry
    The gitlab*registry configuration to use
    privateRegistry GetSecretPrivateRegistry
    The private*registry configuration to use
    type string
    The secret type
    value string
    The secret value
    name str
    The secret name
    azure_container_registry GetSecretAzureContainerRegistry
    The azurecontainerregistry configuration to use
    digital_ocean_container_registry GetSecretDigitalOceanContainerRegistry
    The digitaloceancontainer*registry configuration to use
    docker_hub_registry GetSecretDockerHubRegistry
    The dockerhubregistry configuration to use
    github_registry GetSecretGithubRegistry
    The github*registry configuration to use
    gitlab_registry GetSecretGitlabRegistry
    The gitlab*registry configuration to use
    private_registry GetSecretPrivateRegistry
    The private*registry configuration to use
    type str
    The secret type
    value str
    The secret value
    name String
    The secret name
    azureContainerRegistry Property Map
    The azurecontainerregistry configuration to use
    digitalOceanContainerRegistry Property Map
    The digitaloceancontainer*registry configuration to use
    dockerHubRegistry Property Map
    The dockerhubregistry configuration to use
    githubRegistry Property Map
    The github*registry configuration to use
    gitlabRegistry Property Map
    The gitlab*registry configuration to use
    privateRegistry Property Map
    The private*registry configuration to use
    type String
    The secret type
    value String
    The secret value

    getSecret Result

    The following output properties are available:

    CreatedAt string
    The date and time of when the secret was created
    Id string
    The secret ID
    Name string
    The secret name
    OrganizationId string
    The organization ID owning the secret
    UpdatedAt string
    The date and time of when the secret was last updated
    AzureContainerRegistry GetSecretAzureContainerRegistry
    The azurecontainerregistry configuration to use
    DigitalOceanContainerRegistry GetSecretDigitalOceanContainerRegistry
    The digitaloceancontainer*registry configuration to use
    DockerHubRegistry GetSecretDockerHubRegistry
    The dockerhubregistry configuration to use
    GithubRegistry GetSecretGithubRegistry
    The github*registry configuration to use
    GitlabRegistry GetSecretGitlabRegistry
    The gitlab*registry configuration to use
    PrivateRegistry GetSecretPrivateRegistry
    The private*registry configuration to use
    Type string
    The secret type
    Value string
    The secret value
    CreatedAt string
    The date and time of when the secret was created
    Id string
    The secret ID
    Name string
    The secret name
    OrganizationId string
    The organization ID owning the secret
    UpdatedAt string
    The date and time of when the secret was last updated
    AzureContainerRegistry GetSecretAzureContainerRegistry
    The azurecontainerregistry configuration to use
    DigitalOceanContainerRegistry GetSecretDigitalOceanContainerRegistry
    The digitaloceancontainer*registry configuration to use
    DockerHubRegistry GetSecretDockerHubRegistry
    The dockerhubregistry configuration to use
    GithubRegistry GetSecretGithubRegistry
    The github*registry configuration to use
    GitlabRegistry GetSecretGitlabRegistry
    The gitlab*registry configuration to use
    PrivateRegistry GetSecretPrivateRegistry
    The private*registry configuration to use
    Type string
    The secret type
    Value string
    The secret value
    createdAt String
    The date and time of when the secret was created
    id String
    The secret ID
    name String
    The secret name
    organizationId String
    The organization ID owning the secret
    updatedAt String
    The date and time of when the secret was last updated
    azureContainerRegistry GetSecretAzureContainerRegistry
    The azurecontainerregistry configuration to use
    digitalOceanContainerRegistry GetSecretDigitalOceanContainerRegistry
    The digitaloceancontainer*registry configuration to use
    dockerHubRegistry GetSecretDockerHubRegistry
    The dockerhubregistry configuration to use
    githubRegistry GetSecretGithubRegistry
    The github*registry configuration to use
    gitlabRegistry GetSecretGitlabRegistry
    The gitlab*registry configuration to use
    privateRegistry GetSecretPrivateRegistry
    The private*registry configuration to use
    type String
    The secret type
    value String
    The secret value
    createdAt string
    The date and time of when the secret was created
    id string
    The secret ID
    name string
    The secret name
    organizationId string
    The organization ID owning the secret
    updatedAt string
    The date and time of when the secret was last updated
    azureContainerRegistry GetSecretAzureContainerRegistry
    The azurecontainerregistry configuration to use
    digitalOceanContainerRegistry GetSecretDigitalOceanContainerRegistry
    The digitaloceancontainer*registry configuration to use
    dockerHubRegistry GetSecretDockerHubRegistry
    The dockerhubregistry configuration to use
    githubRegistry GetSecretGithubRegistry
    The github*registry configuration to use
    gitlabRegistry GetSecretGitlabRegistry
    The gitlab*registry configuration to use
    privateRegistry GetSecretPrivateRegistry
    The private*registry configuration to use
    type string
    The secret type
    value string
    The secret value
    created_at str
    The date and time of when the secret was created
    id str
    The secret ID
    name str
    The secret name
    organization_id str
    The organization ID owning the secret
    updated_at str
    The date and time of when the secret was last updated
    azure_container_registry GetSecretAzureContainerRegistry
    The azurecontainerregistry configuration to use
    digital_ocean_container_registry GetSecretDigitalOceanContainerRegistry
    The digitaloceancontainer*registry configuration to use
    docker_hub_registry GetSecretDockerHubRegistry
    The dockerhubregistry configuration to use
    github_registry GetSecretGithubRegistry
    The github*registry configuration to use
    gitlab_registry GetSecretGitlabRegistry
    The gitlab*registry configuration to use
    private_registry GetSecretPrivateRegistry
    The private*registry configuration to use
    type str
    The secret type
    value str
    The secret value
    createdAt String
    The date and time of when the secret was created
    id String
    The secret ID
    name String
    The secret name
    organizationId String
    The organization ID owning the secret
    updatedAt String
    The date and time of when the secret was last updated
    azureContainerRegistry Property Map
    The azurecontainerregistry configuration to use
    digitalOceanContainerRegistry Property Map
    The digitaloceancontainer*registry configuration to use
    dockerHubRegistry Property Map
    The dockerhubregistry configuration to use
    githubRegistry Property Map
    The github*registry configuration to use
    gitlabRegistry Property Map
    The gitlab*registry configuration to use
    privateRegistry Property Map
    The private*registry configuration to use
    type String
    The secret type
    value String
    The secret value

    Supporting Types

    GetSecretAzureContainerRegistry

    Password string
    The registry password
    RegistryName string
    The registry name
    Username string
    The registry username
    Password string
    The registry password
    RegistryName string
    The registry name
    Username string
    The registry username
    password String
    The registry password
    registryName String
    The registry name
    username String
    The registry username
    password string
    The registry password
    registryName string
    The registry name
    username string
    The registry username
    password str
    The registry password
    registry_name str
    The registry name
    username str
    The registry username
    password String
    The registry password
    registryName String
    The registry name
    username String
    The registry username

    GetSecretDigitalOceanContainerRegistry

    Password string
    The registry password
    Username string
    The registry username
    Password string
    The registry password
    Username string
    The registry username
    password String
    The registry password
    username String
    The registry username
    password string
    The registry password
    username string
    The registry username
    password str
    The registry password
    username str
    The registry username
    password String
    The registry password
    username String
    The registry username

    GetSecretDockerHubRegistry

    Password string
    The registry password
    Username string
    The registry username
    Password string
    The registry password
    Username string
    The registry username
    password String
    The registry password
    username String
    The registry username
    password string
    The registry password
    username string
    The registry username
    password str
    The registry password
    username str
    The registry username
    password String
    The registry password
    username String
    The registry username

    GetSecretGithubRegistry

    Password string
    The registry password
    Username string
    The registry username
    Password string
    The registry password
    Username string
    The registry username
    password String
    The registry password
    username String
    The registry username
    password string
    The registry password
    username string
    The registry username
    password str
    The registry password
    username str
    The registry username
    password String
    The registry password
    username String
    The registry username

    GetSecretGitlabRegistry

    Password string
    The registry password
    Username string
    The registry username
    Password string
    The registry password
    Username string
    The registry username
    password String
    The registry password
    username String
    The registry username
    password string
    The registry password
    username string
    The registry username
    password str
    The registry password
    username str
    The registry username
    password String
    The registry password
    username String
    The registry username

    GetSecretPrivateRegistry

    Password string
    The registry password
    Url string
    The registry URL
    Username string
    The registry username
    Password string
    The registry password
    Url string
    The registry URL
    Username string
    The registry username
    password String
    The registry password
    url String
    The registry URL
    username String
    The registry username
    password string
    The registry password
    url string
    The registry URL
    username string
    The registry username
    password str
    The registry password
    url str
    The registry URL
    username str
    The registry username
    password String
    The registry password
    url String
    The registry URL
    username String
    The registry username

    Package Details

    Repository
    koyeb koyeb/pulumi-koyeb
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the koyeb Terraform Provider.
    koyeb logo
    Viewing docs for Koyeb v0.1.11
    published on Monday, Dec 9, 2024 by Koyeb
    Schema (JSON)
    koyeb/pulumi-koyeb
      Try Pulumi Cloud free. Your team will thank you.