HashiCorp Vault

Pulumi Official
Package maintained by Pulumi
v5.5.0 published on Tuesday, May 31, 2022 by Pulumi

Endpoint

Required Vault Capabilities

Use of this resource requires the create or update capability (depending on whether the resource already exists) on the given path. If disable_delete is false, the delete capbility is also required. If disable_delete is false, the read capbility is required.

Example Usage

using Pulumi;
using Vault = Pulumi.Vault;

class MyStack : Stack
{
    public MyStack()
    {
        var userpass = new Vault.AuthBackend("userpass", new Vault.AuthBackendArgs
        {
            Type = "userpass",
        });
        var u1 = new Vault.Generic.Endpoint("u1", new Vault.Generic.EndpointArgs
        {
            Path = "auth/userpass/users/u1",
            IgnoreAbsentFields = true,
            DataJson = @"{
  ""policies"": [""p1""],
  ""password"": ""changeme""
}
",
        }, new CustomResourceOptions
        {
            DependsOn = 
            {
                userpass,
            },
        });
        var u1Token = new Vault.Generic.Endpoint("u1Token", new Vault.Generic.EndpointArgs
        {
            Path = "auth/userpass/login/u1",
            DisableRead = true,
            DisableDelete = true,
            DataJson = @"{
  ""password"": ""changeme""
}
",
        }, new CustomResourceOptions
        {
            DependsOn = 
            {
                u1,
            },
        });
        var u1Entity = new Vault.Generic.Endpoint("u1Entity", new Vault.Generic.EndpointArgs
        {
            DisableRead = true,
            DisableDelete = true,
            Path = "identity/lookup/entity",
            IgnoreAbsentFields = true,
            WriteFields = 
            {
                "id",
            },
            DataJson = @"{
  ""alias_name"": ""u1"",
  ""alias_mount_accessor"": vault_auth_backend.userpass.accessor
}
",
        }, new CustomResourceOptions
        {
            DependsOn = 
            {
                u1Token,
            },
        });
        this.U1Id = u1Entity.WriteData.Apply(writeData => writeData.Id);
    }

    [Output("u1Id")]
    public Output<string> U1Id { get; set; }
}
package main

import (
	"fmt"

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		userpass, err := vault.NewAuthBackend(ctx, "userpass", &vault.AuthBackendArgs{
			Type: pulumi.String("userpass"),
		})
		if err != nil {
			return err
		}
		u1, err := generic.NewEndpoint(ctx, "u1", &generic.EndpointArgs{
			Path:               pulumi.String("auth/userpass/users/u1"),
			IgnoreAbsentFields: pulumi.Bool(true),
			DataJson:           pulumi.String(fmt.Sprintf("%v%v%v%v", "{\n", "  \"policies\": [\"p1\"],\n", "  \"password\": \"changeme\"\n", "}\n")),
		}, pulumi.DependsOn([]pulumi.Resource{
			userpass,
		}))
		if err != nil {
			return err
		}
		u1Token, err := generic.NewEndpoint(ctx, "u1Token", &generic.EndpointArgs{
			Path:          pulumi.String("auth/userpass/login/u1"),
			DisableRead:   pulumi.Bool(true),
			DisableDelete: pulumi.Bool(true),
			DataJson:      pulumi.String(fmt.Sprintf("%v%v%v", "{\n", "  \"password\": \"changeme\"\n", "}\n")),
		}, pulumi.DependsOn([]pulumi.Resource{
			u1,
		}))
		if err != nil {
			return err
		}
		u1Entity, err := generic.NewEndpoint(ctx, "u1Entity", &generic.EndpointArgs{
			DisableRead:        pulumi.Bool(true),
			DisableDelete:      pulumi.Bool(true),
			Path:               pulumi.String("identity/lookup/entity"),
			IgnoreAbsentFields: pulumi.Bool(true),
			WriteFields: pulumi.StringArray{
				pulumi.String("id"),
			},
			DataJson: pulumi.String(fmt.Sprintf("%v%v%v%v", "{\n", "  \"alias_name\": \"u1\",\n", "  \"alias_mount_accessor\": vault_auth_backend.userpass.accessor\n", "}\n")),
		}, pulumi.DependsOn([]pulumi.Resource{
			u1Token,
		}))
		if err != nil {
			return err
		}
		ctx.Export("u1Id", u1Entity.WriteData.ApplyT(func(writeData map[string]string) (string, error) {
			return writeData.Id, nil
		}).(pulumi.StringOutput))
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_vault as vault

userpass = vault.AuthBackend("userpass", type="userpass")
u1 = vault.generic.Endpoint("u1",
    path="auth/userpass/users/u1",
    ignore_absent_fields=True,
    data_json="""{
  "policies": ["p1"],
  "password": "changeme"
}
""",
    opts=pulumi.ResourceOptions(depends_on=[userpass]))
u1_token = vault.generic.Endpoint("u1Token",
    path="auth/userpass/login/u1",
    disable_read=True,
    disable_delete=True,
    data_json="""{
  "password": "changeme"
}
""",
    opts=pulumi.ResourceOptions(depends_on=[u1]))
u1_entity = vault.generic.Endpoint("u1Entity",
    disable_read=True,
    disable_delete=True,
    path="identity/lookup/entity",
    ignore_absent_fields=True,
    write_fields=["id"],
    data_json="""{
  "alias_name": "u1",
  "alias_mount_accessor": vault_auth_backend.userpass.accessor
}
""",
    opts=pulumi.ResourceOptions(depends_on=[u1_token]))
pulumi.export("u1Id", u1_entity.write_data["id"])
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";

const userpass = new vault.AuthBackend("userpass", {type: "userpass"});
const u1 = new vault.generic.Endpoint("u1", {
    path: "auth/userpass/users/u1",
    ignoreAbsentFields: true,
    dataJson: `{
  "policies": ["p1"],
  "password": "changeme"
}
`,
}, {
    dependsOn: [userpass],
});
const u1Token = new vault.generic.Endpoint("u1Token", {
    path: "auth/userpass/login/u1",
    disableRead: true,
    disableDelete: true,
    dataJson: `{
  "password": "changeme"
}
`,
}, {
    dependsOn: [u1],
});
const u1Entity = new vault.generic.Endpoint("u1Entity", {
    disableRead: true,
    disableDelete: true,
    path: "identity/lookup/entity",
    ignoreAbsentFields: true,
    writeFields: ["id"],
    dataJson: `{
  "alias_name": "u1",
  "alias_mount_accessor": vault_auth_backend.userpass.accessor
}
`,
}, {
    dependsOn: [u1Token],
});
export const u1Id = u1Entity.writeData.id;

Coming soon!

Create a Endpoint Resource

new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);
@overload
def Endpoint(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             data_json: Optional[str] = None,
             disable_delete: Optional[bool] = None,
             disable_read: Optional[bool] = None,
             ignore_absent_fields: Optional[bool] = None,
             path: Optional[str] = None,
             write_fields: Optional[Sequence[str]] = None)
@overload
def Endpoint(resource_name: str,
             args: EndpointArgs,
             opts: Optional[ResourceOptions] = None)
func NewEndpoint(ctx *Context, name string, args EndpointArgs, opts ...ResourceOption) (*Endpoint, error)
public Endpoint(string name, EndpointArgs args, CustomResourceOptions? opts = null)
public Endpoint(String name, EndpointArgs args)
public Endpoint(String name, EndpointArgs args, CustomResourceOptions options)
type: vault:generic:Endpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

Endpoint 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 Endpoint resource accepts the following input properties:

DataJson string

String containing a JSON-encoded object that will be written to the given path as the secret data.

Path string

The full logical path at which to write the given data. Consult each backend's documentation to see which endpoints support the PUT methods and to determine whether they also support DELETE and GET.

DisableDelete bool

Don't attempt to delete the path from Vault if true

DisableRead bool

True/false. Set this to true if your vault authentication is not able to read the data or if the endpoint does not support the GET method. Setting this to true will break drift detection. You should set this to true for endpoints that are write-only. Defaults to false.

IgnoreAbsentFields bool

When reading, disregard fields not present in data_json

WriteFields List<string>

Top-level fields returned by write to persist in state

DataJson string

String containing a JSON-encoded object that will be written to the given path as the secret data.

Path string

The full logical path at which to write the given data. Consult each backend's documentation to see which endpoints support the PUT methods and to determine whether they also support DELETE and GET.

DisableDelete bool

Don't attempt to delete the path from Vault if true

DisableRead bool

True/false. Set this to true if your vault authentication is not able to read the data or if the endpoint does not support the GET method. Setting this to true will break drift detection. You should set this to true for endpoints that are write-only. Defaults to false.

IgnoreAbsentFields bool

When reading, disregard fields not present in data_json

WriteFields []string

Top-level fields returned by write to persist in state

dataJson String

String containing a JSON-encoded object that will be written to the given path as the secret data.

path String

The full logical path at which to write the given data. Consult each backend's documentation to see which endpoints support the PUT methods and to determine whether they also support DELETE and GET.

disableDelete Boolean

Don't attempt to delete the path from Vault if true

disableRead Boolean

True/false. Set this to true if your vault authentication is not able to read the data or if the endpoint does not support the GET method. Setting this to true will break drift detection. You should set this to true for endpoints that are write-only. Defaults to false.

ignoreAbsentFields Boolean

When reading, disregard fields not present in data_json

writeFields List<String>

Top-level fields returned by write to persist in state

dataJson string

String containing a JSON-encoded object that will be written to the given path as the secret data.

path string

The full logical path at which to write the given data. Consult each backend's documentation to see which endpoints support the PUT methods and to determine whether they also support DELETE and GET.

disableDelete boolean

Don't attempt to delete the path from Vault if true

disableRead boolean

True/false. Set this to true if your vault authentication is not able to read the data or if the endpoint does not support the GET method. Setting this to true will break drift detection. You should set this to true for endpoints that are write-only. Defaults to false.

ignoreAbsentFields boolean

When reading, disregard fields not present in data_json

writeFields string[]

Top-level fields returned by write to persist in state

data_json str

String containing a JSON-encoded object that will be written to the given path as the secret data.

path str

The full logical path at which to write the given data. Consult each backend's documentation to see which endpoints support the PUT methods and to determine whether they also support DELETE and GET.

disable_delete bool

Don't attempt to delete the path from Vault if true

disable_read bool

True/false. Set this to true if your vault authentication is not able to read the data or if the endpoint does not support the GET method. Setting this to true will break drift detection. You should set this to true for endpoints that are write-only. Defaults to false.

ignore_absent_fields bool

When reading, disregard fields not present in data_json

write_fields Sequence[str]

Top-level fields returned by write to persist in state

dataJson String

String containing a JSON-encoded object that will be written to the given path as the secret data.

path String

The full logical path at which to write the given data. Consult each backend's documentation to see which endpoints support the PUT methods and to determine whether they also support DELETE and GET.

disableDelete Boolean

Don't attempt to delete the path from Vault if true

disableRead Boolean

True/false. Set this to true if your vault authentication is not able to read the data or if the endpoint does not support the GET method. Setting this to true will break drift detection. You should set this to true for endpoints that are write-only. Defaults to false.

ignoreAbsentFields Boolean

When reading, disregard fields not present in data_json

writeFields List<String>

Top-level fields returned by write to persist in state

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

WriteData Dictionary<string, string>

Map of strings returned by write operation

WriteDataJson string

JSON data returned by write operation

Id string

The provider-assigned unique ID for this managed resource.

WriteData map[string]string

Map of strings returned by write operation

WriteDataJson string

JSON data returned by write operation

id String

The provider-assigned unique ID for this managed resource.

writeData Map<String,String>

Map of strings returned by write operation

writeDataJson String

JSON data returned by write operation

id string

The provider-assigned unique ID for this managed resource.

writeData {[key: string]: string}

Map of strings returned by write operation

writeDataJson string

JSON data returned by write operation

id str

The provider-assigned unique ID for this managed resource.

write_data Mapping[str, str]

Map of strings returned by write operation

write_data_json str

JSON data returned by write operation

id String

The provider-assigned unique ID for this managed resource.

writeData Map<String>

Map of strings returned by write operation

writeDataJson String

JSON data returned by write operation

Look up an Existing Endpoint Resource

Get an existing Endpoint 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?: EndpointState, opts?: CustomResourceOptions): Endpoint
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_json: Optional[str] = None,
        disable_delete: Optional[bool] = None,
        disable_read: Optional[bool] = None,
        ignore_absent_fields: Optional[bool] = None,
        path: Optional[str] = None,
        write_data: Optional[Mapping[str, str]] = None,
        write_data_json: Optional[str] = None,
        write_fields: Optional[Sequence[str]] = None) -> Endpoint
func GetEndpoint(ctx *Context, name string, id IDInput, state *EndpointState, opts ...ResourceOption) (*Endpoint, error)
public static Endpoint Get(string name, Input<string> id, EndpointState? state, CustomResourceOptions? opts = null)
public static Endpoint get(String name, Output<String> id, EndpointState 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:
DataJson string

String containing a JSON-encoded object that will be written to the given path as the secret data.

DisableDelete bool

Don't attempt to delete the path from Vault if true

DisableRead bool

True/false. Set this to true if your vault authentication is not able to read the data or if the endpoint does not support the GET method. Setting this to true will break drift detection. You should set this to true for endpoints that are write-only. Defaults to false.

IgnoreAbsentFields bool

When reading, disregard fields not present in data_json

Path string

The full logical path at which to write the given data. Consult each backend's documentation to see which endpoints support the PUT methods and to determine whether they also support DELETE and GET.

WriteData Dictionary<string, string>

Map of strings returned by write operation

WriteDataJson string

JSON data returned by write operation

WriteFields List<string>

Top-level fields returned by write to persist in state

DataJson string

String containing a JSON-encoded object that will be written to the given path as the secret data.

DisableDelete bool

Don't attempt to delete the path from Vault if true

DisableRead bool

True/false. Set this to true if your vault authentication is not able to read the data or if the endpoint does not support the GET method. Setting this to true will break drift detection. You should set this to true for endpoints that are write-only. Defaults to false.

IgnoreAbsentFields bool

When reading, disregard fields not present in data_json

Path string

The full logical path at which to write the given data. Consult each backend's documentation to see which endpoints support the PUT methods and to determine whether they also support DELETE and GET.

WriteData map[string]string

Map of strings returned by write operation

WriteDataJson string

JSON data returned by write operation

WriteFields []string

Top-level fields returned by write to persist in state

dataJson String

String containing a JSON-encoded object that will be written to the given path as the secret data.

disableDelete Boolean

Don't attempt to delete the path from Vault if true

disableRead Boolean

True/false. Set this to true if your vault authentication is not able to read the data or if the endpoint does not support the GET method. Setting this to true will break drift detection. You should set this to true for endpoints that are write-only. Defaults to false.

ignoreAbsentFields Boolean

When reading, disregard fields not present in data_json

path String

The full logical path at which to write the given data. Consult each backend's documentation to see which endpoints support the PUT methods and to determine whether they also support DELETE and GET.

writeData Map<String,String>

Map of strings returned by write operation

writeDataJson String

JSON data returned by write operation

writeFields List<String>

Top-level fields returned by write to persist in state

dataJson string

String containing a JSON-encoded object that will be written to the given path as the secret data.

disableDelete boolean

Don't attempt to delete the path from Vault if true

disableRead boolean

True/false. Set this to true if your vault authentication is not able to read the data or if the endpoint does not support the GET method. Setting this to true will break drift detection. You should set this to true for endpoints that are write-only. Defaults to false.

ignoreAbsentFields boolean

When reading, disregard fields not present in data_json

path string

The full logical path at which to write the given data. Consult each backend's documentation to see which endpoints support the PUT methods and to determine whether they also support DELETE and GET.

writeData {[key: string]: string}

Map of strings returned by write operation

writeDataJson string

JSON data returned by write operation

writeFields string[]

Top-level fields returned by write to persist in state

data_json str

String containing a JSON-encoded object that will be written to the given path as the secret data.

disable_delete bool

Don't attempt to delete the path from Vault if true

disable_read bool

True/false. Set this to true if your vault authentication is not able to read the data or if the endpoint does not support the GET method. Setting this to true will break drift detection. You should set this to true for endpoints that are write-only. Defaults to false.

ignore_absent_fields bool

When reading, disregard fields not present in data_json

path str

The full logical path at which to write the given data. Consult each backend's documentation to see which endpoints support the PUT methods and to determine whether they also support DELETE and GET.

write_data Mapping[str, str]

Map of strings returned by write operation

write_data_json str

JSON data returned by write operation

write_fields Sequence[str]

Top-level fields returned by write to persist in state

dataJson String

String containing a JSON-encoded object that will be written to the given path as the secret data.

disableDelete Boolean

Don't attempt to delete the path from Vault if true

disableRead Boolean

True/false. Set this to true if your vault authentication is not able to read the data or if the endpoint does not support the GET method. Setting this to true will break drift detection. You should set this to true for endpoints that are write-only. Defaults to false.

ignoreAbsentFields Boolean

When reading, disregard fields not present in data_json

path String

The full logical path at which to write the given data. Consult each backend's documentation to see which endpoints support the PUT methods and to determine whether they also support DELETE and GET.

writeData Map<String>

Map of strings returned by write operation

writeDataJson String

JSON data returned by write operation

writeFields List<String>

Top-level fields returned by write to persist in state

Import

Import is not supported for this resource.

Package Details

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

This Pulumi package is based on the vault Terraform Provider.