HashiCorp Vault v6.6.0, Mar 13 25

HashiCorp Vault v6.6.0 published on Thursday, Mar 13, 2025 by Pulumi

vault.ssh.SecretBackendCa

Explore with Pulumi AI

HashiCorp Vault v6.6.0 published on Thursday, Mar 13, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const example = new vault.Mount("example", {type: "ssh"});
const foo = new vault.ssh.SecretBackendCa("foo", {backend: example.path});

import pulumi
import pulumi_vault as vault

example = vault.Mount("example", type="ssh")
foo = vault.ssh.SecretBackendCa("foo", backend=example.path)

package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault"
	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/ssh"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := vault.NewMount(ctx, "example", &vault.MountArgs{
			Type: pulumi.String("ssh"),
		})
		if err != nil {
			return err
		}
		_, err = ssh.NewSecretBackendCa(ctx, "foo", &ssh.SecretBackendCaArgs{
			Backend: example.Path,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Vault.Mount("example", new()
    {
        Type = "ssh",
    });

    var foo = new Vault.Ssh.SecretBackendCa("foo", new()
    {
        Backend = example.Path,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.Mount;
import com.pulumi.vault.MountArgs;
import com.pulumi.vault.ssh.SecretBackendCa;
import com.pulumi.vault.ssh.SecretBackendCaArgs;
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 example = new Mount("example", MountArgs.builder()
            .type("ssh")
            .build());

        var foo = new SecretBackendCa("foo", SecretBackendCaArgs.builder()
            .backend(example.path())
            .build());

    }
}

resources:
  example:
    type: vault:Mount
    properties:
      type: ssh
  foo:
    type: vault:ssh:SecretBackendCa
    properties:
      backend: ${example.path}

Create SecretBackendCa Resource

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

new SecretBackendCa(name: string, args?: SecretBackendCaArgs, opts?: CustomResourceOptions);

@overload
def SecretBackendCa(resource_name: str,
                    args: Optional[SecretBackendCaArgs] = None,
                    opts: Optional[ResourceOptions] = None)

@overload
def SecretBackendCa(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    backend: Optional[str] = None,
                    generate_signing_key: Optional[bool] = None,
                    key_bits: Optional[int] = None,
                    key_type: Optional[str] = None,
                    namespace: Optional[str] = None,
                    private_key: Optional[str] = None,
                    public_key: Optional[str] = None)

func NewSecretBackendCa(ctx *Context, name string, args *SecretBackendCaArgs, opts ...ResourceOption) (*SecretBackendCa, error)

public SecretBackendCa(string name, SecretBackendCaArgs? args = null, CustomResourceOptions? opts = null)

public SecretBackendCa(String name, SecretBackendCaArgs args)
public SecretBackendCa(String name, SecretBackendCaArgs args, CustomResourceOptions options)

type: vault:ssh:SecretBackendCa
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 SecretBackendCaArgs: 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 SecretBackendCaArgs: 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 SecretBackendCaArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SecretBackendCaArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SecretBackendCaArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var secretBackendCaResource = new Vault.Ssh.SecretBackendCa("secretBackendCaResource", new()
{
    Backend = "string",
    GenerateSigningKey = false,
    KeyBits = 0,
    KeyType = "string",
    Namespace = "string",
    PrivateKey = "string",
    PublicKey = "string",
});

example, err := ssh.NewSecretBackendCa(ctx, "secretBackendCaResource", &ssh.SecretBackendCaArgs{
	Backend:            pulumi.String("string"),
	GenerateSigningKey: pulumi.Bool(false),
	KeyBits:            pulumi.Int(0),
	KeyType:            pulumi.String("string"),
	Namespace:          pulumi.String("string"),
	PrivateKey:         pulumi.String("string"),
	PublicKey:          pulumi.String("string"),
})

var secretBackendCaResource = new SecretBackendCa("secretBackendCaResource", SecretBackendCaArgs.builder()
    .backend("string")
    .generateSigningKey(false)
    .keyBits(0)
    .keyType("string")
    .namespace("string")
    .privateKey("string")
    .publicKey("string")
    .build());

secret_backend_ca_resource = vault.ssh.SecretBackendCa("secretBackendCaResource",
    backend="string",
    generate_signing_key=False,
    key_bits=0,
    key_type="string",
    namespace="string",
    private_key="string",
    public_key="string")

const secretBackendCaResource = new vault.ssh.SecretBackendCa("secretBackendCaResource", {
    backend: "string",
    generateSigningKey: false,
    keyBits: 0,
    keyType: "string",
    namespace: "string",
    privateKey: "string",
    publicKey: "string",
});

type: vault:ssh:SecretBackendCa
properties:
    backend: string
    generateSigningKey: false
    keyBits: 0
    keyType: string
    namespace: string
    privateKey: string
    publicKey: string

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

Backend string: The path where the SSH secret backend is mounted. Defaults to 'ssh'
GenerateSigningKey bool: Whether Vault should generate the signing key pair internally. Defaults to true
KeyBits int: Specifies the desired key bits for the generated SSH CA key when generate_signing_key is set to true.
KeyType string: Specifies the desired key type for the generated SSH CA key when generate_signing_key is set to true.
Namespace string: The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
PrivateKey string: Private key part the SSH CA key pair; required if generate_signing_key is false.
PublicKey string: The public key part the SSH CA key pair; required if generate_signing_key is false.

Backend string: The path where the SSH secret backend is mounted. Defaults to 'ssh'
GenerateSigningKey bool: Whether Vault should generate the signing key pair internally. Defaults to true
KeyBits int: Specifies the desired key bits for the generated SSH CA key when generate_signing_key is set to true.
KeyType string: Specifies the desired key type for the generated SSH CA key when generate_signing_key is set to true.
Namespace string: The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
PrivateKey string: Private key part the SSH CA key pair; required if generate_signing_key is false.
PublicKey string: The public key part the SSH CA key pair; required if generate_signing_key is false.

backend String: The path where the SSH secret backend is mounted. Defaults to 'ssh'
generateSigningKey Boolean: Whether Vault should generate the signing key pair internally. Defaults to true
keyBits Integer: Specifies the desired key bits for the generated SSH CA key when generate_signing_key is set to true.
keyType String: Specifies the desired key type for the generated SSH CA key when generate_signing_key is set to true.
namespace String: The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
privateKey String: Private key part the SSH CA key pair; required if generate_signing_key is false.
publicKey String: The public key part the SSH CA key pair; required if generate_signing_key is false.

backend string: The path where the SSH secret backend is mounted. Defaults to 'ssh'
generateSigningKey boolean: Whether Vault should generate the signing key pair internally. Defaults to true
keyBits number: Specifies the desired key bits for the generated SSH CA key when generate_signing_key is set to true.
keyType string: Specifies the desired key type for the generated SSH CA key when generate_signing_key is set to true.
namespace string: The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
privateKey string: Private key part the SSH CA key pair; required if generate_signing_key is false.
publicKey string: The public key part the SSH CA key pair; required if generate_signing_key is false.

backend str: The path where the SSH secret backend is mounted. Defaults to 'ssh'
generate_signing_key bool: Whether Vault should generate the signing key pair internally. Defaults to true
key_bits int: Specifies the desired key bits for the generated SSH CA key when generate_signing_key is set to true.
key_type str: Specifies the desired key type for the generated SSH CA key when generate_signing_key is set to true.
namespace str: The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
private_key str: Private key part the SSH CA key pair; required if generate_signing_key is false.
public_key str: The public key part the SSH CA key pair; required if generate_signing_key is false.

backend String: The path where the SSH secret backend is mounted. Defaults to 'ssh'
generateSigningKey Boolean: Whether Vault should generate the signing key pair internally. Defaults to true
keyBits Number: Specifies the desired key bits for the generated SSH CA key when generate_signing_key is set to true.
keyType String: Specifies the desired key type for the generated SSH CA key when generate_signing_key is set to true.
namespace String: The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
privateKey String: Private key part the SSH CA key pair; required if generate_signing_key is false.
publicKey String: The public key part the SSH CA key pair; required if generate_signing_key is false.

Outputs

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

Get an existing SecretBackendCa resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: SecretBackendCaState, opts?: CustomResourceOptions): SecretBackendCa

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backend: Optional[str] = None,
        generate_signing_key: Optional[bool] = None,
        key_bits: Optional[int] = None,
        key_type: Optional[str] = None,
        namespace: Optional[str] = None,
        private_key: Optional[str] = None,
        public_key: Optional[str] = None) -> SecretBackendCa

func GetSecretBackendCa(ctx *Context, name string, id IDInput, state *SecretBackendCaState, opts ...ResourceOption) (*SecretBackendCa, error)

public static SecretBackendCa Get(string name, Input<string> id, SecretBackendCaState? state, CustomResourceOptions? opts = null)

public static SecretBackendCa get(String name, Output<String> id, SecretBackendCaState state, CustomResourceOptions options)

resources:  _:    type: vault:ssh:SecretBackendCa    get:      id: ${id}

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:

Backend string: The path where the SSH secret backend is mounted. Defaults to 'ssh'
GenerateSigningKey bool: Whether Vault should generate the signing key pair internally. Defaults to true
KeyBits int: Specifies the desired key bits for the generated SSH CA key when generate_signing_key is set to true.
KeyType string: Specifies the desired key type for the generated SSH CA key when generate_signing_key is set to true.
Namespace string: The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
PrivateKey string: Private key part the SSH CA key pair; required if generate_signing_key is false.
PublicKey string: The public key part the SSH CA key pair; required if generate_signing_key is false.

Backend string: The path where the SSH secret backend is mounted. Defaults to 'ssh'
GenerateSigningKey bool: Whether Vault should generate the signing key pair internally. Defaults to true
KeyBits int: Specifies the desired key bits for the generated SSH CA key when generate_signing_key is set to true.
KeyType string: Specifies the desired key type for the generated SSH CA key when generate_signing_key is set to true.
Namespace string: The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
PrivateKey string: Private key part the SSH CA key pair; required if generate_signing_key is false.
PublicKey string: The public key part the SSH CA key pair; required if generate_signing_key is false.

backend String: The path where the SSH secret backend is mounted. Defaults to 'ssh'
generateSigningKey Boolean: Whether Vault should generate the signing key pair internally. Defaults to true
keyBits Integer: Specifies the desired key bits for the generated SSH CA key when generate_signing_key is set to true.
keyType String: Specifies the desired key type for the generated SSH CA key when generate_signing_key is set to true.
namespace String: The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
privateKey String: Private key part the SSH CA key pair; required if generate_signing_key is false.
publicKey String: The public key part the SSH CA key pair; required if generate_signing_key is false.

backend string: The path where the SSH secret backend is mounted. Defaults to 'ssh'
generateSigningKey boolean: Whether Vault should generate the signing key pair internally. Defaults to true
keyBits number: Specifies the desired key bits for the generated SSH CA key when generate_signing_key is set to true.
keyType string: Specifies the desired key type for the generated SSH CA key when generate_signing_key is set to true.
namespace string: The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
privateKey string: Private key part the SSH CA key pair; required if generate_signing_key is false.
publicKey string: The public key part the SSH CA key pair; required if generate_signing_key is false.

backend str: The path where the SSH secret backend is mounted. Defaults to 'ssh'
generate_signing_key bool: Whether Vault should generate the signing key pair internally. Defaults to true
key_bits int: Specifies the desired key bits for the generated SSH CA key when generate_signing_key is set to true.
key_type str: Specifies the desired key type for the generated SSH CA key when generate_signing_key is set to true.
namespace str: The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
private_key str: Private key part the SSH CA key pair; required if generate_signing_key is false.
public_key str: The public key part the SSH CA key pair; required if generate_signing_key is false.

backend String: The path where the SSH secret backend is mounted. Defaults to 'ssh'
generateSigningKey Boolean: Whether Vault should generate the signing key pair internally. Defaults to true
keyBits Number: Specifies the desired key bits for the generated SSH CA key when generate_signing_key is set to true.
keyType String: Specifies the desired key type for the generated SSH CA key when generate_signing_key is set to true.
namespace String: The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
privateKey String: Private key part the SSH CA key pair; required if generate_signing_key is false.
publicKey String: The public key part the SSH CA key pair; required if generate_signing_key is false.

Import

SSH secret backend CAs can be imported using the path, e.g.

$ pulumi import vault:ssh/secretBackendCa:SecretBackendCa foo ssh

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

Package Details

Repository: Vault pulumi/pulumi-vault
License: Apache-2.0
Notes: This Pulumi package is based on the vault Terraform Provider.

HashiCorp Vault v6.6.0 published on Thursday, Mar 13, 2025 by Pulumi

pulumi/pulumi-vault

vault.ssh.SecretBackendCa

On this page

On this page

Example Usage

Create SecretBackendCa Resource

Constructor syntax

Parameters

Constructor example

SecretBackendCa Resource Properties

Inputs

Outputs

Look up Existing SecretBackendCa Resource

Import

Package Details

On this page

On this page