@pulumi/vault
Version:
A Pulumi package for creating and managing HashiCorp Vault cloud resources.
131 lines (130 loc) • 4.65 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages OIDC Assignments in a Vault server. See the [Vault documentation](https://www.vaultproject.io/api-docs/secret/identity/oidc-provider#create-or-update-an-assignment)
* for more information.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as vault from "@pulumi/vault";
*
* const internal = new vault.identity.Group("internal", {
* name: "internal",
* type: "internal",
* policies: [
* "dev",
* "test",
* ],
* });
* const test = new vault.identity.Entity("test", {
* name: "test",
* policies: ["test"],
* });
* const _default = new vault.identity.OidcAssignment("default", {
* name: "assignment",
* entityIds: [test.id],
* groupIds: [internal.id],
* });
* ```
*
* ## Import
*
* OIDC Assignments can be imported using the `name`, e.g.
*
* ```sh
* $ pulumi import vault:identity/oidcAssignment:OidcAssignment default assignment
* ```
*/
export declare class OidcAssignment extends pulumi.CustomResource {
/**
* Get an existing OidcAssignment 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?: OidcAssignmentState, opts?: pulumi.CustomResourceOptions): OidcAssignment;
/**
* Returns true if the given object is an instance of OidcAssignment. 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 OidcAssignment;
/**
* A set of Vault entity IDs.
*/
readonly entityIds: pulumi.Output<string[] | undefined>;
/**
* A set of Vault group IDs.
*/
readonly groupIds: pulumi.Output<string[] | undefined>;
/**
* The name of the assignment.
*/
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>;
/**
* Create a OidcAssignment 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?: OidcAssignmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering OidcAssignment resources.
*/
export interface OidcAssignmentState {
/**
* A set of Vault entity IDs.
*/
entityIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* A set of Vault group IDs.
*/
groupIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name of the assignment.
*/
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>;
}
/**
* The set of arguments for constructing a OidcAssignment resource.
*/
export interface OidcAssignmentArgs {
/**
* A set of Vault entity IDs.
*/
entityIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* A set of Vault group IDs.
*/
groupIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name of the assignment.
*/
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>;
}