HashiCorp Vault

v5.7.0 published on Thursday, Oct 13, 2022 by Pulumi

AuthBackendIdentityWhitelist

Configures the periodic tidying operation of the whitelisted identity entries.

For more information, see the Vault docs.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Vault = Pulumi.Vault;

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

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

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleAuthBackend, err := vault.NewAuthBackend(ctx, "exampleAuthBackend", &vault.AuthBackendArgs{
			Type: pulumi.String("aws"),
		})
		if err != nil {
			return err
		}
		_, err = aws.NewAuthBackendIdentityWhitelist(ctx, "exampleAuthBackendIdentityWhitelist", &aws.AuthBackendIdentityWhitelistArgs{
			Backend:      exampleAuthBackend.Path,
			SafetyBuffer: pulumi.Int(3600),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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 exampleAuthBackend = new AuthBackend("exampleAuthBackend", AuthBackendArgs.builder()        
            .type("aws")
            .build());

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

    }
}
import pulumi
import pulumi_vault as vault

example_auth_backend = vault.AuthBackend("exampleAuthBackend", type="aws")
example_auth_backend_identity_whitelist = vault.aws.AuthBackendIdentityWhitelist("exampleAuthBackendIdentityWhitelist",
    backend=example_auth_backend.path,
    safety_buffer=3600)
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";

const exampleAuthBackend = new vault.AuthBackend("exampleAuthBackend", {type: "aws"});
const exampleAuthBackendIdentityWhitelist = new vault.aws.AuthBackendIdentityWhitelist("exampleAuthBackendIdentityWhitelist", {
    backend: exampleAuthBackend.path,
    safetyBuffer: 3600,
});
resources:
  exampleAuthBackend:
    type: vault:AuthBackend
    properties:
      type: aws
  exampleAuthBackendIdentityWhitelist:
    type: vault:aws:AuthBackendIdentityWhitelist
    properties:
      backend: ${exampleAuthBackend.path}
      safetyBuffer: 3600

Create AuthBackendIdentityWhitelist Resource

new AuthBackendIdentityWhitelist(name: string, args?: AuthBackendIdentityWhitelistArgs, opts?: CustomResourceOptions);
@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)
@overload
def AuthBackendIdentityWhitelist(resource_name: str,
                                 args: Optional[AuthBackendIdentityWhitelistArgs] = None,
                                 opts: Optional[ResourceOptions] = 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.

name 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 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 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 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 String
The unique name of the resource.
args AuthBackendIdentityWhitelistArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

The AuthBackendIdentityWhitelist resource accepts the following input properties:

Backend 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 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 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 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 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 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 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 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 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 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 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 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)
Resource lookup is not supported in YAML
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.
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:
Backend 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 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 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 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 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 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 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 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 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 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 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 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

Package Details

Repository
https://github.com/pulumi/pulumi-vault
License
Apache-2.0
Notes

This Pulumi package is based on the vault Terraform Provider.