@pulumi/vault
Version:
A Pulumi package for creating and managing HashiCorp Vault cloud resources.
178 lines (177 loc) • 6.55 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as vault from "@pulumi/vault";
*
* const config = new vault.ad.SecretBackend("config", {
* backend: "ad",
* binddn: "CN=Administrator,CN=Users,DC=corp,DC=example,DC=net",
* bindpass: "SuperSecretPassw0rd",
* url: "ldaps://ad",
* insecureTls: true,
* userdn: "CN=Users,DC=corp,DC=example,DC=net",
* });
* const qa = new vault.ad.SecretLibrary("qa", {
* backend: config.backend,
* name: "qa",
* serviceAccountNames: [
* "Bob",
* "Mary",
* ],
* ttl: 60,
* disableCheckInEnforcement: true,
* maxTtl: 120,
* });
* ```
*
* ## Import
*
* AD secret backend libraries can be imported using the `path`, e.g.
*
* ```sh
* $ pulumi import vault:ad/secretLibrary:SecretLibrary role ad/library/bob
* ```
*/
export declare class SecretLibrary extends pulumi.CustomResource {
/**
* Get an existing SecretLibrary 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?: SecretLibraryState, opts?: pulumi.CustomResourceOptions): SecretLibrary;
/**
* Returns true if the given object is an instance of SecretLibrary. 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 SecretLibrary;
/**
* The path the AD secret backend is mounted at,
* with no leading or trailing `/`s.
*/
readonly backend: pulumi.Output<string>;
/**
* Disable enforcing that service accounts must be checked in by the entity or client token that checked them out.
*/
readonly disableCheckInEnforcement: pulumi.Output<boolean | undefined>;
/**
* The maximum password time-to-live in seconds. Defaults to the configuration
* maxTtl if not provided.
*/
readonly maxTtl: pulumi.Output<number>;
/**
* The name to identify this set of service accounts.
* Must be unique within the backend.
*/
readonly name: pulumi.Output<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*.
*/
readonly namespace: pulumi.Output<string | undefined>;
/**
* Specifies the slice of service accounts mapped to this set.
*/
readonly serviceAccountNames: pulumi.Output<string[]>;
/**
* The password time-to-live in seconds. Defaults to the configuration
* ttl if not provided.
*/
readonly ttl: pulumi.Output<number>;
/**
* Create a SecretLibrary 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: SecretLibraryArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SecretLibrary resources.
*/
export interface SecretLibraryState {
/**
* The path the AD secret backend is mounted at,
* with no leading or trailing `/`s.
*/
backend?: pulumi.Input<string>;
/**
* Disable enforcing that service accounts must be checked in by the entity or client token that checked them out.
*/
disableCheckInEnforcement?: pulumi.Input<boolean>;
/**
* The maximum password time-to-live in seconds. Defaults to the configuration
* maxTtl if not provided.
*/
maxTtl?: pulumi.Input<number>;
/**
* The name to identify this set of service accounts.
* Must be unique within the backend.
*/
name?: 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>;
/**
* Specifies the slice of service accounts mapped to this set.
*/
serviceAccountNames?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The password time-to-live in seconds. Defaults to the configuration
* ttl if not provided.
*/
ttl?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a SecretLibrary resource.
*/
export interface SecretLibraryArgs {
/**
* The path the AD secret backend is mounted at,
* with no leading or trailing `/`s.
*/
backend: pulumi.Input<string>;
/**
* Disable enforcing that service accounts must be checked in by the entity or client token that checked them out.
*/
disableCheckInEnforcement?: pulumi.Input<boolean>;
/**
* The maximum password time-to-live in seconds. Defaults to the configuration
* maxTtl if not provided.
*/
maxTtl?: pulumi.Input<number>;
/**
* The name to identify this set of service accounts.
* Must be unique within the backend.
*/
name?: 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>;
/**
* Specifies the slice of service accounts mapped to this set.
*/
serviceAccountNames: pulumi.Input<pulumi.Input<string>[]>;
/**
* The password time-to-live in seconds. Defaults to the configuration
* ttl if not provided.
*/
ttl?: pulumi.Input<number>;
}