@pulumi/vault
Version:
A Pulumi package for creating and managing HashiCorp Vault cloud resources.
115 lines (114 loc) • 4.32 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage Role Governing Policy (RGP) via [Sentinel](https://www.vaultproject.io/docs/enterprise/sentinel/index.html).
*
* **Note** this feature is available only with Vault Enterprise.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as vault from "@pulumi/vault";
*
* const allow_all = new vault.RgpPolicy("allow-all", {
* name: "allow-all",
* enforcementLevel: "soft-mandatory",
* policy: `main = rule {
* true
* }
* `,
* });
* ```
*/
export declare class RgpPolicy extends pulumi.CustomResource {
/**
* Get an existing RgpPolicy 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?: RgpPolicyState, opts?: pulumi.CustomResourceOptions): RgpPolicy;
/**
* Returns true if the given object is an instance of RgpPolicy. 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 RgpPolicy;
/**
* Enforcement level of Sentinel policy. Can be either `advisory` or `soft-mandatory` or `hard-mandatory`
*/
readonly enforcementLevel: pulumi.Output<string>;
/**
* The name of the policy
*/
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>;
/**
* String containing a Sentinel policy
*/
readonly policy: pulumi.Output<string>;
/**
* Create a RgpPolicy 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: RgpPolicyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RgpPolicy resources.
*/
export interface RgpPolicyState {
/**
* Enforcement level of Sentinel policy. Can be either `advisory` or `soft-mandatory` or `hard-mandatory`
*/
enforcementLevel?: pulumi.Input<string>;
/**
* The name of the policy
*/
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>;
/**
* String containing a Sentinel policy
*/
policy?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a RgpPolicy resource.
*/
export interface RgpPolicyArgs {
/**
* Enforcement level of Sentinel policy. Can be either `advisory` or `soft-mandatory` or `hard-mandatory`
*/
enforcementLevel: pulumi.Input<string>;
/**
* The name of the policy
*/
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>;
/**
* String containing a Sentinel policy
*/
policy: pulumi.Input<string>;
}