UNPKG

@pulumi/vault

Version:

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

125 lines (124 loc) 4.88 kB
import * as pulumi from "@pulumi/pulumi"; /** * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as vault from "@pulumi/vault"; * * const test = new vault.terraformcloud.SecretBackend("test", { * backend: "terraform", * description: "Manages the Terraform Cloud backend", * token: "V0idfhi2iksSDU234ucdbi2nidsi...", * }); * const example = new vault.terraformcloud.SecretRole("example", { * backend: test.backend, * name: "test-role", * organization: "example-organization-name", * teamId: "team-ieF4isC...", * }); * ``` * * ## Import * * Terraform Cloud secret backend roles can be imported using the `backend`, `/roles/`, and the `name` e.g. * * ```sh * $ pulumi import vault:terraformcloud/secretRole:SecretRole example terraform/roles/my-role * ``` */ export declare class SecretRole extends pulumi.CustomResource { /** * Get an existing SecretRole 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?: SecretRoleState, opts?: pulumi.CustomResourceOptions): SecretRole; /** * Returns true if the given object is an instance of SecretRole. 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 SecretRole; readonly backend: pulumi.Output<string | undefined>; /** * Maximum TTL for leases associated with this role, in seconds. */ readonly maxTtl: pulumi.Output<number | undefined>; 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>; readonly organization: pulumi.Output<string | undefined>; readonly teamId: pulumi.Output<string | undefined>; /** * Specifies the TTL for this role, in seconds. */ readonly ttl: pulumi.Output<number | undefined>; readonly userId: pulumi.Output<string | undefined>; /** * Create a SecretRole 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?: SecretRoleArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering SecretRole resources. */ export interface SecretRoleState { backend?: pulumi.Input<string>; /** * Maximum TTL for leases associated with this role, in seconds. */ maxTtl?: pulumi.Input<number>; 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>; organization?: pulumi.Input<string>; teamId?: pulumi.Input<string>; /** * Specifies the TTL for this role, in seconds. */ ttl?: pulumi.Input<number>; userId?: pulumi.Input<string>; } /** * The set of arguments for constructing a SecretRole resource. */ export interface SecretRoleArgs { backend?: pulumi.Input<string>; /** * Maximum TTL for leases associated with this role, in seconds. */ maxTtl?: pulumi.Input<number>; 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>; organization?: pulumi.Input<string>; teamId?: pulumi.Input<string>; /** * Specifies the TTL for this role, in seconds. */ ttl?: pulumi.Input<number>; userId?: pulumi.Input<string>; }