@pulumi/vault/ssh/secretBackendCa.d.ts

A Pulumi package for creating and managing HashiCorp Vault cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Provides a resource to manage CA information in an SSH secret backend
 * [SSH secret backend within Vault](https://www.vaultproject.io/docs/secrets/ssh/index.html).
 *
 * ## Example Usage
 *
 * ```typescript
 * 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
 *
 * SSH secret backend CAs can be imported using the `path`, e.g.
 *
 * ```sh
 * $ pulumi import vault:ssh/secretBackendCa:SecretBackendCa foo ssh
 * ```
 */
export declare class SecretBackendCa extends pulumi.CustomResource {
    /**
     * Get an existing SecretBackendCa 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?: SecretBackendCaState, opts?: pulumi.CustomResourceOptions): SecretBackendCa;
    /**
     * Returns true if the given object is an instance of SecretBackendCa.  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 SecretBackendCa;
    /**
     * The path where the SSH secret backend is mounted. Defaults to 'ssh'
     */
    readonly backend: pulumi.Output<string | undefined>;
    /**
     * Whether Vault should generate the signing key pair internally. Defaults to true
     */
    readonly generateSigningKey: pulumi.Output<boolean | undefined>;
    /**
     * Specifies the desired key bits for the generated SSH CA key when `generateSigningKey` is set to `true`.
     */
    readonly keyBits: pulumi.Output<number | undefined>;
    /**
     * Specifies the desired key type for the generated SSH CA key when `generateSigningKey` is set to `true`.
     */
    readonly keyType: pulumi.Output<string | undefined>;
    /**
     * The id of the managed key to use. When using a managed key, this field or managedKeyName is required.
     */
    readonly managedKeyId: pulumi.Output<string | undefined>;
    /**
     * The name of the managed key to use. When using a managed key, this field or managedKeyId is required.
     */
    readonly managedKeyName: pulumi.Output<string | undefined>;
    /**
     * 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](https://www.terraform.io/docs/providers/vault/index.html#namespace).
     * *Available only for Vault Enterprise*.
     */
    readonly namespace: pulumi.Output<string | undefined>;
    /**
     * The private key part the SSH CA key pair; required if generateSigningKey is false.
     */
    readonly privateKey: pulumi.Output<string>;
    /**
     * The public key part the SSH CA key pair; required if generateSigningKey is false.
     */
    readonly publicKey: pulumi.Output<string>;
    /**
     * Create a SecretBackendCa 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?: SecretBackendCaArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering SecretBackendCa resources.
 */
export interface SecretBackendCaState {
    /**
     * The path where the SSH secret backend is mounted. Defaults to 'ssh'
     */
    backend?: pulumi.Input<string>;
    /**
     * Whether Vault should generate the signing key pair internally. Defaults to true
     */
    generateSigningKey?: pulumi.Input<boolean>;
    /**
     * Specifies the desired key bits for the generated SSH CA key when `generateSigningKey` is set to `true`.
     */
    keyBits?: pulumi.Input<number>;
    /**
     * Specifies the desired key type for the generated SSH CA key when `generateSigningKey` is set to `true`.
     */
    keyType?: pulumi.Input<string>;
    /**
     * The id of the managed key to use. When using a managed key, this field or managedKeyName is required.
     */
    managedKeyId?: pulumi.Input<string>;
    /**
     * The name of the managed key to use. When using a managed key, this field or managedKeyId is required.
     */
    managedKeyName?: pulumi.Input<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](https://www.terraform.io/docs/providers/vault/index.html#namespace).
     * *Available only for Vault Enterprise*.
     */
    namespace?: pulumi.Input<string>;
    /**
     * The private key part the SSH CA key pair; required if generateSigningKey is false.
     */
    privateKey?: pulumi.Input<string>;
    /**
     * The public key part the SSH CA key pair; required if generateSigningKey is false.
     */
    publicKey?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a SecretBackendCa resource.
 */
export interface SecretBackendCaArgs {
    /**
     * The path where the SSH secret backend is mounted. Defaults to 'ssh'
     */
    backend?: pulumi.Input<string>;
    /**
     * Whether Vault should generate the signing key pair internally. Defaults to true
     */
    generateSigningKey?: pulumi.Input<boolean>;
    /**
     * Specifies the desired key bits for the generated SSH CA key when `generateSigningKey` is set to `true`.
     */
    keyBits?: pulumi.Input<number>;
    /**
     * Specifies the desired key type for the generated SSH CA key when `generateSigningKey` is set to `true`.
     */
    keyType?: pulumi.Input<string>;
    /**
     * The id of the managed key to use. When using a managed key, this field or managedKeyName is required.
     */
    managedKeyId?: pulumi.Input<string>;
    /**
     * The name of the managed key to use. When using a managed key, this field or managedKeyId is required.
     */
    managedKeyName?: pulumi.Input<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](https://www.terraform.io/docs/providers/vault/index.html#namespace).
     * *Available only for Vault Enterprise*.
     */
    namespace?: pulumi.Input<string>;
    /**
     * The private key part the SSH CA key pair; required if generateSigningKey is false.
     */
    privateKey?: pulumi.Input<string>;
    /**
     * The public key part the SSH CA key pair; required if generateSigningKey is false.
     */
    publicKey?: pulumi.Input<string>;
}