@pulumi/vault
Version:
A Pulumi package for creating and managing HashiCorp Vault cloud resources.
203 lines (202 loc) • 7.73 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as vault from "@pulumi/vault";
*
* const example = new vault.OciAuthBackend("example", {
* path: exampleVaultAuthBackend.path,
* homeTenancyId: "ocid1.tenancy.oc1..aaaaaaaah7zkvaffv26pzyauoe2zbnionqvhvsexamplee557wakiofi4ysgqq",
* });
* ```
*
* ## Import
*
* OCI auth backends can be imported using the backend's `path`, e.g.
*
* ```sh
* $ pulumi import vault:index/ociAuthBackend:OciAuthBackend example oci
* ```
*/
export declare class OciAuthBackend extends pulumi.CustomResource {
/**
* Get an existing OciAuthBackend 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?: OciAuthBackendState, opts?: pulumi.CustomResourceOptions): OciAuthBackend;
/**
* Returns true if the given object is an instance of OciAuthBackend. 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 OciAuthBackend;
/**
* The accessor of the auth backend
*/
readonly accessor: pulumi.Output<string>;
/**
* A description of the auth backend.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Stops rotation of the root credential until set to false.
*/
readonly disableAutomatedRotation: pulumi.Output<boolean | undefined>;
/**
* If set, opts out of mount migration on path updates.
*/
readonly disableRemount: pulumi.Output<boolean | undefined>;
/**
* The Tenancy OCID of your OCI account.
*/
readonly homeTenancyId: 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#namespace).
* *Available only for Vault Enterprise*.
*/
readonly namespace: pulumi.Output<string | undefined>;
/**
* Unique name of the auth backend to configure.
*/
readonly path: pulumi.Output<string | undefined>;
/**
* The period of time in seconds between each rotation of the root credential. Cannot be used with rotation_schedule.
*/
readonly rotationPeriod: pulumi.Output<number | undefined>;
/**
* The cron-style schedule for the root credential to be rotated on. Cannot be used with rotation_period.
*/
readonly rotationSchedule: pulumi.Output<string | undefined>;
/**
* The maximum amount of time in seconds Vault is allowed to complete a rotation once a scheduled rotation is triggered. Can only be used with rotation_schedule.
*/
readonly rotationWindow: pulumi.Output<number | undefined>;
/**
* Extra configuration block. Structure is documented below.
*
* The `tune` block is used to tune the auth backend:
*/
readonly tune: pulumi.Output<outputs.OciAuthBackendTune>;
/**
* Create a OciAuthBackend 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: OciAuthBackendArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering OciAuthBackend resources.
*/
export interface OciAuthBackendState {
/**
* The accessor of the auth backend
*/
accessor?: pulumi.Input<string>;
/**
* A description of the auth backend.
*/
description?: pulumi.Input<string>;
/**
* Stops rotation of the root credential until set to false.
*/
disableAutomatedRotation?: pulumi.Input<boolean>;
/**
* If set, opts out of mount migration on path updates.
*/
disableRemount?: pulumi.Input<boolean>;
/**
* The Tenancy OCID of your OCI account.
*/
homeTenancyId?: 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#namespace).
* *Available only for Vault Enterprise*.
*/
namespace?: pulumi.Input<string>;
/**
* Unique name of the auth backend to configure.
*/
path?: pulumi.Input<string>;
/**
* The period of time in seconds between each rotation of the root credential. Cannot be used with rotation_schedule.
*/
rotationPeriod?: pulumi.Input<number>;
/**
* The cron-style schedule for the root credential to be rotated on. Cannot be used with rotation_period.
*/
rotationSchedule?: pulumi.Input<string>;
/**
* The maximum amount of time in seconds Vault is allowed to complete a rotation once a scheduled rotation is triggered. Can only be used with rotation_schedule.
*/
rotationWindow?: pulumi.Input<number>;
/**
* Extra configuration block. Structure is documented below.
*
* The `tune` block is used to tune the auth backend:
*/
tune?: pulumi.Input<inputs.OciAuthBackendTune>;
}
/**
* The set of arguments for constructing a OciAuthBackend resource.
*/
export interface OciAuthBackendArgs {
/**
* A description of the auth backend.
*/
description?: pulumi.Input<string>;
/**
* Stops rotation of the root credential until set to false.
*/
disableAutomatedRotation?: pulumi.Input<boolean>;
/**
* If set, opts out of mount migration on path updates.
*/
disableRemount?: pulumi.Input<boolean>;
/**
* The Tenancy OCID of your OCI account.
*/
homeTenancyId: 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#namespace).
* *Available only for Vault Enterprise*.
*/
namespace?: pulumi.Input<string>;
/**
* Unique name of the auth backend to configure.
*/
path?: pulumi.Input<string>;
/**
* The period of time in seconds between each rotation of the root credential. Cannot be used with rotation_schedule.
*/
rotationPeriod?: pulumi.Input<number>;
/**
* The cron-style schedule for the root credential to be rotated on. Cannot be used with rotation_period.
*/
rotationSchedule?: pulumi.Input<string>;
/**
* The maximum amount of time in seconds Vault is allowed to complete a rotation once a scheduled rotation is triggered. Can only be used with rotation_schedule.
*/
rotationWindow?: pulumi.Input<number>;
/**
* Extra configuration block. Structure is documented below.
*
* The `tune` block is used to tune the auth backend:
*/
tune?: pulumi.Input<inputs.OciAuthBackendTune>;
}