HashiCorp Vault

v5.1.0 published on Thursday, Dec 30, 2021 by Pulumi

QuotaLeaseCount

Manage lease count quotas which enforce the number of leases that can be created. A lease count quota can be created at the root level or defined on a namespace or mount by specifying a path when creating the quota.

See Vault’s Documentation for more information.

Note this feature is available only with Vault Enterprise.

Example Usage

using Pulumi;
using Vault = Pulumi.Vault;

class MyStack : Stack
{
    public MyStack()
    {
        var @global = new Vault.QuotaLeaseCount("global", new Vault.QuotaLeaseCountArgs
        {
            MaxLeases = 100,
            Path = "",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v5/go/vault"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vault.NewQuotaLeaseCount(ctx, "global", &vault.QuotaLeaseCountArgs{
			MaxLeases: pulumi.Int(100),
			Path:      pulumi.String(""),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_vault as vault

global_ = vault.QuotaLeaseCount("global",
    max_leases=100,
    path="")
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";

const global = new vault.QuotaLeaseCount("global", {
    maxLeases: 100,
    path: "",
});

Create a QuotaLeaseCount Resource

new QuotaLeaseCount(name: string, args: QuotaLeaseCountArgs, opts?: CustomResourceOptions);
@overload
def QuotaLeaseCount(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    max_leases: Optional[int] = None,
                    name: Optional[str] = None,
                    path: Optional[str] = None)
@overload
def QuotaLeaseCount(resource_name: str,
                    args: QuotaLeaseCountArgs,
                    opts: Optional[ResourceOptions] = None)
func NewQuotaLeaseCount(ctx *Context, name string, args QuotaLeaseCountArgs, opts ...ResourceOption) (*QuotaLeaseCount, error)
public QuotaLeaseCount(string name, QuotaLeaseCountArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args QuotaLeaseCountArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args QuotaLeaseCountArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args QuotaLeaseCountArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args QuotaLeaseCountArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

QuotaLeaseCount Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The QuotaLeaseCount resource accepts the following input properties:

MaxLeases int
The maximum number of leases to be allowed by the quota rule. The max_leases must be positive.
Name string
Name of the rate limit quota
Path string
Path of the mount or namespace to apply the quota. A blank path configures a global rate limit quota. For example namespace1/ adds a quota to a full namespace, namespace1/auth/userpass adds a quota to userpass in namespace1. Updating this field on an existing quota can have “moving” effects. For example, updating auth/userpass to namespace1/auth/userpass moves this quota from being a global mount quota to a namespace specific mount quota. Note, namespaces are supported in Enterprise only.
MaxLeases int
The maximum number of leases to be allowed by the quota rule. The max_leases must be positive.
Name string
Name of the rate limit quota
Path string
Path of the mount or namespace to apply the quota. A blank path configures a global rate limit quota. For example namespace1/ adds a quota to a full namespace, namespace1/auth/userpass adds a quota to userpass in namespace1. Updating this field on an existing quota can have “moving” effects. For example, updating auth/userpass to namespace1/auth/userpass moves this quota from being a global mount quota to a namespace specific mount quota. Note, namespaces are supported in Enterprise only.
maxLeases number
The maximum number of leases to be allowed by the quota rule. The max_leases must be positive.
name string
Name of the rate limit quota
path string
Path of the mount or namespace to apply the quota. A blank path configures a global rate limit quota. For example namespace1/ adds a quota to a full namespace, namespace1/auth/userpass adds a quota to userpass in namespace1. Updating this field on an existing quota can have “moving” effects. For example, updating auth/userpass to namespace1/auth/userpass moves this quota from being a global mount quota to a namespace specific mount quota. Note, namespaces are supported in Enterprise only.
max_leases int
The maximum number of leases to be allowed by the quota rule. The max_leases must be positive.
name str
Name of the rate limit quota
path str
Path of the mount or namespace to apply the quota. A blank path configures a global rate limit quota. For example namespace1/ adds a quota to a full namespace, namespace1/auth/userpass adds a quota to userpass in namespace1. Updating this field on an existing quota can have “moving” effects. For example, updating auth/userpass to namespace1/auth/userpass moves this quota from being a global mount quota to a namespace specific mount quota. Note, namespaces are supported in Enterprise only.

Outputs

All input properties are implicitly available as output properties. Additionally, the QuotaLeaseCount resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing QuotaLeaseCount Resource

Get an existing QuotaLeaseCount resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: QuotaLeaseCountState, opts?: CustomResourceOptions): QuotaLeaseCount
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        max_leases: Optional[int] = None,
        name: Optional[str] = None,
        path: Optional[str] = None) -> QuotaLeaseCount
func GetQuotaLeaseCount(ctx *Context, name string, id IDInput, state *QuotaLeaseCountState, opts ...ResourceOption) (*QuotaLeaseCount, error)
public static QuotaLeaseCount Get(string name, Input<string> id, QuotaLeaseCountState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

MaxLeases int
The maximum number of leases to be allowed by the quota rule. The max_leases must be positive.
Name string
Name of the rate limit quota
Path string
Path of the mount or namespace to apply the quota. A blank path configures a global rate limit quota. For example namespace1/ adds a quota to a full namespace, namespace1/auth/userpass adds a quota to userpass in namespace1. Updating this field on an existing quota can have “moving” effects. For example, updating auth/userpass to namespace1/auth/userpass moves this quota from being a global mount quota to a namespace specific mount quota. Note, namespaces are supported in Enterprise only.
MaxLeases int
The maximum number of leases to be allowed by the quota rule. The max_leases must be positive.
Name string
Name of the rate limit quota
Path string
Path of the mount or namespace to apply the quota. A blank path configures a global rate limit quota. For example namespace1/ adds a quota to a full namespace, namespace1/auth/userpass adds a quota to userpass in namespace1. Updating this field on an existing quota can have “moving” effects. For example, updating auth/userpass to namespace1/auth/userpass moves this quota from being a global mount quota to a namespace specific mount quota. Note, namespaces are supported in Enterprise only.
maxLeases number
The maximum number of leases to be allowed by the quota rule. The max_leases must be positive.
name string
Name of the rate limit quota
path string
Path of the mount or namespace to apply the quota. A blank path configures a global rate limit quota. For example namespace1/ adds a quota to a full namespace, namespace1/auth/userpass adds a quota to userpass in namespace1. Updating this field on an existing quota can have “moving” effects. For example, updating auth/userpass to namespace1/auth/userpass moves this quota from being a global mount quota to a namespace specific mount quota. Note, namespaces are supported in Enterprise only.
max_leases int
The maximum number of leases to be allowed by the quota rule. The max_leases must be positive.
name str
Name of the rate limit quota
path str
Path of the mount or namespace to apply the quota. A blank path configures a global rate limit quota. For example namespace1/ adds a quota to a full namespace, namespace1/auth/userpass adds a quota to userpass in namespace1. Updating this field on an existing quota can have “moving” effects. For example, updating auth/userpass to namespace1/auth/userpass moves this quota from being a global mount quota to a namespace specific mount quota. Note, namespaces are supported in Enterprise only.

Import

Lease count quotas can be imported using their names

 $ pulumi import vault:index/quotaLeaseCount:QuotaLeaseCount global global

Package Details

Repository
https://github.com/pulumi/pulumi-vault
License
Apache-2.0
Notes
This Pulumi package is based on the vault Terraform Provider.