Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. HashiCorp Vault Provider
  3. API Docs
  4. aws
  5. AuthBackendIdentityWhitelist
HashiCorp Vault v6.6.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-vault

vault.aws.AuthBackendIdentityWhitelist

Explore with Pulumi AI

HashiCorp Vault v6.6.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-vault

Configures the periodic tidying operation of the whitelisted identity entries.

For more information, see the Vault docs.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";

const example = new vault.AuthBackend("example", {type: "aws"});
const exampleAuthBackendIdentityWhitelist = new vault.aws.AuthBackendIdentityWhitelist("example", {
    backend: example.path,
    safetyBuffer: 3600,
});
Copy
import pulumi
import pulumi_vault as vault

example = vault.AuthBackend("example", type="aws")
example_auth_backend_identity_whitelist = vault.aws.AuthBackendIdentityWhitelist("example",
    backend=example.path,
    safety_buffer=3600)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := vault.NewAuthBackend(ctx, "example", &vault.AuthBackendArgs{
			Type: pulumi.String("aws"),
		})
		if err != nil {
			return err
		}
		_, err = aws.NewAuthBackendIdentityWhitelist(ctx, "example", &aws.AuthBackendIdentityWhitelistArgs{
			Backend:      example.Path,
			SafetyBuffer: pulumi.Int(3600),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vault = Pulumi.Vault;

return await Deployment.RunAsync(() => 
{
    var example = new Vault.AuthBackend("example", new()
    {
        Type = "aws",
    });

    var exampleAuthBackendIdentityWhitelist = new Vault.Aws.AuthBackendIdentityWhitelist("example", new()
    {
        Backend = example.Path,
        SafetyBuffer = 3600,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.AuthBackend;
import com.pulumi.vault.AuthBackendArgs;
import com.pulumi.vault.aws.AuthBackendIdentityWhitelist;
import com.pulumi.vault.aws.AuthBackendIdentityWhitelistArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new AuthBackend("example", AuthBackendArgs.builder()
            .type("aws")
            .build());

        var exampleAuthBackendIdentityWhitelist = new AuthBackendIdentityWhitelist("exampleAuthBackendIdentityWhitelist", AuthBackendIdentityWhitelistArgs.builder()
            .backend(example.path())
            .safetyBuffer(3600)
            .build());

    }
}
Copy
resources:
  example:
    type: vault:AuthBackend
    properties:
      type: aws
  exampleAuthBackendIdentityWhitelist:
    type: vault:aws:AuthBackendIdentityWhitelist
    name: example
    properties:
      backend: ${example.path}
      safetyBuffer: 3600
Copy

Create AuthBackendIdentityWhitelist Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AuthBackendIdentityWhitelist(name: string, args?: AuthBackendIdentityWhitelistArgs, opts?: CustomResourceOptions);
@overload
def AuthBackendIdentityWhitelist(resource_name: str,
                                 args: Optional[AuthBackendIdentityWhitelistArgs] = None,
                                 opts: Optional[ResourceOptions] = None)

@overload
def AuthBackendIdentityWhitelist(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 backend: Optional[str] = None,
                                 disable_periodic_tidy: Optional[bool] = None,
                                 namespace: Optional[str] = None,
                                 safety_buffer: Optional[int] = None)
func NewAuthBackendIdentityWhitelist(ctx *Context, name string, args *AuthBackendIdentityWhitelistArgs, opts ...ResourceOption) (*AuthBackendIdentityWhitelist, error)
public AuthBackendIdentityWhitelist(string name, AuthBackendIdentityWhitelistArgs? args = null, CustomResourceOptions? opts = null)
public AuthBackendIdentityWhitelist(String name, AuthBackendIdentityWhitelistArgs args)
public AuthBackendIdentityWhitelist(String name, AuthBackendIdentityWhitelistArgs args, CustomResourceOptions options)

type: vault:aws:AuthBackendIdentityWhitelist
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args AuthBackendIdentityWhitelistArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args AuthBackendIdentityWhitelistArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args AuthBackendIdentityWhitelistArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args AuthBackendIdentityWhitelistArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AuthBackendIdentityWhitelistArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var authBackendIdentityWhitelistResource = new Vault.Aws.AuthBackendIdentityWhitelist("authBackendIdentityWhitelistResource", new()
{
    Backend = "string",
    DisablePeriodicTidy = false,
    Namespace = "string",
    SafetyBuffer = 0,
});
Copy
example, err := aws.NewAuthBackendIdentityWhitelist(ctx, "authBackendIdentityWhitelistResource", &aws.AuthBackendIdentityWhitelistArgs{
	Backend:             pulumi.String("string"),
	DisablePeriodicTidy: pulumi.Bool(false),
	Namespace:           pulumi.String("string"),
	SafetyBuffer:        pulumi.Int(0),
})
Copy
var authBackendIdentityWhitelistResource = new AuthBackendIdentityWhitelist("authBackendIdentityWhitelistResource", AuthBackendIdentityWhitelistArgs.builder()
    .backend("string")
    .disablePeriodicTidy(false)
    .namespace("string")
    .safetyBuffer(0)
    .build());
Copy
auth_backend_identity_whitelist_resource = vault.aws.AuthBackendIdentityWhitelist("authBackendIdentityWhitelistResource",
    backend="string",
    disable_periodic_tidy=False,
    namespace="string",
    safety_buffer=0)
Copy
const authBackendIdentityWhitelistResource = new vault.aws.AuthBackendIdentityWhitelist("authBackendIdentityWhitelistResource", {
    backend: "string",
    disablePeriodicTidy: false,
    namespace: "string",
    safetyBuffer: 0,
});
Copy
type: vault:aws:AuthBackendIdentityWhitelist
properties:
    backend: string
    disablePeriodicTidy: false
    namespace: string
    safetyBuffer: 0
Copy

AuthBackendIdentityWhitelist Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AuthBackendIdentityWhitelist resource accepts the following input properties:

Backend Changes to this property will trigger replacement. string
The path of the AWS backend being configured.
DisablePeriodicTidy bool
If set to true, disables the periodic tidying of the identity-whitelist entries.
Namespace Changes to this property will trigger replacement. 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. Available only for Vault Enterprise.
SafetyBuffer int
The amount of extra time, in minutes, that must have passed beyond the roletag expiration, before it is removed from the backend storage.
Backend Changes to this property will trigger replacement. string
The path of the AWS backend being configured.
DisablePeriodicTidy bool
If set to true, disables the periodic tidying of the identity-whitelist entries.
Namespace Changes to this property will trigger replacement. 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. Available only for Vault Enterprise.
SafetyBuffer int
The amount of extra time, in minutes, that must have passed beyond the roletag expiration, before it is removed from the backend storage.
backend Changes to this property will trigger replacement. String
The path of the AWS backend being configured.
disablePeriodicTidy Boolean
If set to true, disables the periodic tidying of the identity-whitelist entries.
namespace Changes to this property will trigger replacement. 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. Available only for Vault Enterprise.
safetyBuffer Integer
The amount of extra time, in minutes, that must have passed beyond the roletag expiration, before it is removed from the backend storage.
backend Changes to this property will trigger replacement. string
The path of the AWS backend being configured.
disablePeriodicTidy boolean
If set to true, disables the periodic tidying of the identity-whitelist entries.
namespace Changes to this property will trigger replacement. 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. Available only for Vault Enterprise.
safetyBuffer number
The amount of extra time, in minutes, that must have passed beyond the roletag expiration, before it is removed from the backend storage.
backend Changes to this property will trigger replacement. str
The path of the AWS backend being configured.
disable_periodic_tidy bool
If set to true, disables the periodic tidying of the identity-whitelist entries.
namespace Changes to this property will trigger replacement. str
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. Available only for Vault Enterprise.
safety_buffer int
The amount of extra time, in minutes, that must have passed beyond the roletag expiration, before it is removed from the backend storage.
backend Changes to this property will trigger replacement. String
The path of the AWS backend being configured.
disablePeriodicTidy Boolean
If set to true, disables the periodic tidying of the identity-whitelist entries.
namespace Changes to this property will trigger replacement. 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. Available only for Vault Enterprise.
safetyBuffer Number
The amount of extra time, in minutes, that must have passed beyond the roletag expiration, before it is removed from the backend storage.

Outputs

All input properties are implicitly available as output properties. Additionally, the AuthBackendIdentityWhitelist 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 string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing AuthBackendIdentityWhitelist Resource

Get an existing AuthBackendIdentityWhitelist 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?: AuthBackendIdentityWhitelistState, opts?: CustomResourceOptions): AuthBackendIdentityWhitelist
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backend: Optional[str] = None,
        disable_periodic_tidy: Optional[bool] = None,
        namespace: Optional[str] = None,
        safety_buffer: Optional[int] = None) -> AuthBackendIdentityWhitelist
func GetAuthBackendIdentityWhitelist(ctx *Context, name string, id IDInput, state *AuthBackendIdentityWhitelistState, opts ...ResourceOption) (*AuthBackendIdentityWhitelist, error)
public static AuthBackendIdentityWhitelist Get(string name, Input<string> id, AuthBackendIdentityWhitelistState? state, CustomResourceOptions? opts = null)
public static AuthBackendIdentityWhitelist get(String name, Output<String> id, AuthBackendIdentityWhitelistState state, CustomResourceOptions options)
resources:  _:    type: vault:aws:AuthBackendIdentityWhitelist    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Backend Changes to this property will trigger replacement. string
The path of the AWS backend being configured.
DisablePeriodicTidy bool
If set to true, disables the periodic tidying of the identity-whitelist entries.
Namespace Changes to this property will trigger replacement. 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. Available only for Vault Enterprise.
SafetyBuffer int
The amount of extra time, in minutes, that must have passed beyond the roletag expiration, before it is removed from the backend storage.
Backend Changes to this property will trigger replacement. string
The path of the AWS backend being configured.
DisablePeriodicTidy bool
If set to true, disables the periodic tidying of the identity-whitelist entries.
Namespace Changes to this property will trigger replacement. 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. Available only for Vault Enterprise.
SafetyBuffer int
The amount of extra time, in minutes, that must have passed beyond the roletag expiration, before it is removed from the backend storage.
backend Changes to this property will trigger replacement. String
The path of the AWS backend being configured.
disablePeriodicTidy Boolean
If set to true, disables the periodic tidying of the identity-whitelist entries.
namespace Changes to this property will trigger replacement. 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. Available only for Vault Enterprise.
safetyBuffer Integer
The amount of extra time, in minutes, that must have passed beyond the roletag expiration, before it is removed from the backend storage.
backend Changes to this property will trigger replacement. string
The path of the AWS backend being configured.
disablePeriodicTidy boolean
If set to true, disables the periodic tidying of the identity-whitelist entries.
namespace Changes to this property will trigger replacement. 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. Available only for Vault Enterprise.
safetyBuffer number
The amount of extra time, in minutes, that must have passed beyond the roletag expiration, before it is removed from the backend storage.
backend Changes to this property will trigger replacement. str
The path of the AWS backend being configured.
disable_periodic_tidy bool
If set to true, disables the periodic tidying of the identity-whitelist entries.
namespace Changes to this property will trigger replacement. str
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. Available only for Vault Enterprise.
safety_buffer int
The amount of extra time, in minutes, that must have passed beyond the roletag expiration, before it is removed from the backend storage.
backend Changes to this property will trigger replacement. String
The path of the AWS backend being configured.
disablePeriodicTidy Boolean
If set to true, disables the periodic tidying of the identity-whitelist entries.
namespace Changes to this property will trigger replacement. 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. Available only for Vault Enterprise.
safetyBuffer Number
The amount of extra time, in minutes, that must have passed beyond the roletag expiration, before it is removed from the backend storage.

Import

AWS auth backend identity whitelists can be imported using auth/, the backend path, and /config/tidy/identity-whitelist e.g.

$ pulumi import vault:aws/authBackendIdentityWhitelist:AuthBackendIdentityWhitelist example auth/aws/config/tidy/identity-whitelist
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Vault pulumi/pulumi-vault
License
Apache-2.0
Notes
This Pulumi package is based on the vault Terraform Provider.
HashiCorp Vault v6.6.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-vault