Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Pulumi Vault Provider
  3. API Docs
  4. generic
  5. Endpoint
HashiCorp Vault v6.4.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-vault

vault.generic.Endpoint

Explore with Pulumi AI

vault logo
HashiCorp Vault v6.4.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-vault

    Example Usage

    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("u1_token", {
    path: "auth/userpass/login/u1",
    disableRead: true,
    disableDelete: true,
    dataJson: `{
  "password": "changeme"
}
`,
}, {
    dependsOn: [u1],
});
const u1Entity = new vault.generic.Endpoint("u1_entity", {
    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;

    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("u1_token",
    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("u1_entity",
    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"])

    package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault"
	"github.com/pulumi/pulumi-vault/sdk/v6/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("{\n  \"policies\": [\"p1\"],\n  \"password\": \"changeme\"\n}\n"),
		}, pulumi.DependsOn([]pulumi.Resource{
			userpass,
		}))
		if err != nil {
			return err
		}
		u1Token, err := generic.NewEndpoint(ctx, "u1_token", &generic.EndpointArgs{
			Path:          pulumi.String("auth/userpass/login/u1"),
			DisableRead:   pulumi.Bool(true),
			DisableDelete: pulumi.Bool(true),
			DataJson:      pulumi.String("{\n  \"password\": \"changeme\"\n}\n"),
		}, pulumi.DependsOn([]pulumi.Resource{
			u1,
		}))
		if err != nil {
			return err
		}
		u1Entity, err := generic.NewEndpoint(ctx, "u1_entity", &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("{\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
	})
}

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

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

    var u1 = new Vault.Generic.Endpoint("u1", new()
    {
        Path = "auth/userpass/users/u1",
        IgnoreAbsentFields = true,
        DataJson = @"{
  ""policies"": [""p1""],
  ""password"": ""changeme""
}
",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            userpass,
        },
    });

    var u1Token = new Vault.Generic.Endpoint("u1_token", new()
    {
        Path = "auth/userpass/login/u1",
        DisableRead = true,
        DisableDelete = true,
        DataJson = @"{
  ""password"": ""changeme""
}
",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            u1,
        },
    });

    var u1Entity = new Vault.Generic.Endpoint("u1_entity", new()
    {
        DisableRead = true,
        DisableDelete = true,
        Path = "identity/lookup/entity",
        IgnoreAbsentFields = true,
        WriteFields = new[]
        {
            "id",
        },
        DataJson = @"{
  ""alias_name"": ""u1"",
  ""alias_mount_accessor"": vault_auth_backend.userpass.accessor
}
",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            u1Token,
        },
    });

    return new Dictionary<string, object?>
    {
        ["u1Id"] = u1Entity.WriteData.Apply(writeData => writeData.Id),
    };
});

    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.generic.Endpoint;
import com.pulumi.vault.generic.EndpointArgs;
import com.pulumi.resources.CustomResourceOptions;
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 userpass = new AuthBackend("userpass", AuthBackendArgs.builder()
            .type("userpass")
            .build());

        var u1 = new Endpoint("u1", EndpointArgs.builder()
            .path("auth/userpass/users/u1")
            .ignoreAbsentFields(true)
            .dataJson("""
{
  "policies": ["p1"],
  "password": "changeme"
}
            """)
            .build(), CustomResourceOptions.builder()
                .dependsOn(userpass)
                .build());

        var u1Token = new Endpoint("u1Token", EndpointArgs.builder()
            .path("auth/userpass/login/u1")
            .disableRead(true)
            .disableDelete(true)
            .dataJson("""
{
  "password": "changeme"
}
            """)
            .build(), CustomResourceOptions.builder()
                .dependsOn(u1)
                .build());

        var u1Entity = new Endpoint("u1Entity", EndpointArgs.builder()
            .disableRead(true)
            .disableDelete(true)
            .path("identity/lookup/entity")
            .ignoreAbsentFields(true)
            .writeFields("id")
            .dataJson("""
{
  "alias_name": "u1",
  "alias_mount_accessor": vault_auth_backend.userpass.accessor
}
            """)
            .build(), CustomResourceOptions.builder()
                .dependsOn(u1Token)
                .build());

        ctx.export("u1Id", u1Entity.writeData().applyValue(writeData -> writeData.id()));
    }
}

    resources:
  userpass:
    type: vault:AuthBackend
    properties:
      type: userpass
  u1:
    type: vault:generic:Endpoint
    properties:
      path: auth/userpass/users/u1
      ignoreAbsentFields: true
      dataJson: |
        {
          "policies": ["p1"],
          "password": "changeme"
        }        
    options:
      dependson:
        - ${userpass}
  u1Token:
    type: vault:generic:Endpoint
    name: u1_token
    properties:
      path: auth/userpass/login/u1
      disableRead: true
      disableDelete: true
      dataJson: |
        {
          "password": "changeme"
        }        
    options:
      dependson:
        - ${u1}
  u1Entity:
    type: vault:generic:Endpoint
    name: u1_entity
    properties:
      disableRead: true
      disableDelete: true
      path: identity/lookup/entity
      ignoreAbsentFields: true
      writeFields:
        - id
      dataJson: |
        {
          "alias_name": "u1",
          "alias_mount_accessor": vault_auth_backend.userpass.accessor
        }        
    options:
      dependson:
        - ${u1Token}
outputs:
  u1Id: ${u1Entity.writeData.id}

    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 capability is also required. If disable_read is false, the read capability is required.

    Create Endpoint Resource

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

    Constructor syntax

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

@overload
def Endpoint(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             data_json: Optional[str] = None,
             path: Optional[str] = None,
             disable_delete: Optional[bool] = None,
             disable_read: Optional[bool] = None,
             ignore_absent_fields: Optional[bool] = None,
             namespace: Optional[str] = None,
             write_fields: Optional[Sequence[str]] = 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.

    Parameters

    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.

    Constructor example

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

    var endpointResource = new Vault.Generic.Endpoint("endpointResource", new()
{
    DataJson = "string",
    Path = "string",
    DisableDelete = false,
    DisableRead = false,
    IgnoreAbsentFields = false,
    Namespace = "string",
    WriteFields = new[]
    {
        "string",
    },
});

    example, err := generic.NewEndpoint(ctx, "endpointResource", &generic.EndpointArgs{
	DataJson:           pulumi.String("string"),
	Path:               pulumi.String("string"),
	DisableDelete:      pulumi.Bool(false),
	DisableRead:        pulumi.Bool(false),
	IgnoreAbsentFields: pulumi.Bool(false),
	Namespace:          pulumi.String("string"),
	WriteFields: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var endpointResource = new Endpoint("endpointResource", EndpointArgs.builder()
    .dataJson("string")
    .path("string")
    .disableDelete(false)
    .disableRead(false)
    .ignoreAbsentFields(false)
    .namespace("string")
    .writeFields("string")
    .build());

    endpoint_resource = vault.generic.Endpoint("endpointResource",
    data_json="string",
    path="string",
    disable_delete=False,
    disable_read=False,
    ignore_absent_fields=False,
    namespace="string",
    write_fields=["string"])

    const endpointResource = new vault.generic.Endpoint("endpointResource", {
    dataJson: "string",
    path: "string",
    disableDelete: false,
    disableRead: false,
    ignoreAbsentFields: false,
    namespace: "string",
    writeFields: ["string"],
});

    type: vault:generic:Endpoint
properties:
    dataJson: string
    disableDelete: false
    disableRead: false
    ignoreAbsentFields: false
    namespace: string
    path: string
    writeFields:
        - string

    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

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

    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
    • (Optional) True/false. Set this to true if your vault authentication is not able to delete the data or if the endpoint does not support the DELETE method. Defaults to false.
    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
    • (Optional) True/false. If set to true, ignore any fields present when the endpoint is read but that were not in data_json. Also, if a field that was written is not returned when the endpoint is read, treat that field as being up to date. You should set this to true when writing to endpoint that, when read, returns a different set of fields from the ones you wrote, as is common with many configuration endpoints. Defaults to false.
    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.
    WriteFields List<string>
    • (Optional). A list of fields that should be returned in write_data_json and write_data. If omitted, data returned by the write operation is not available to the resource or included in state. This helps to avoid accidental storage of sensitive values in state. Some endpoints, such as many dynamic secrets endpoints, return data from writing to an endpoint rather than reading it. You should use write_fields if you need information returned in this way.
    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
    • (Optional) True/false. Set this to true if your vault authentication is not able to delete the data or if the endpoint does not support the DELETE method. Defaults to false.
    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
    • (Optional) True/false. If set to true, ignore any fields present when the endpoint is read but that were not in data_json. Also, if a field that was written is not returned when the endpoint is read, treat that field as being up to date. You should set this to true when writing to endpoint that, when read, returns a different set of fields from the ones you wrote, as is common with many configuration endpoints. Defaults to false.
    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.
    WriteFields []string
    • (Optional). A list of fields that should be returned in write_data_json and write_data. If omitted, data returned by the write operation is not available to the resource or included in state. This helps to avoid accidental storage of sensitive values in state. Some endpoints, such as many dynamic secrets endpoints, return data from writing to an endpoint rather than reading it. You should use write_fields if you need information returned in this way.
    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
    • (Optional) True/false. Set this to true if your vault authentication is not able to delete the data or if the endpoint does not support the DELETE method. Defaults to false.
    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
    • (Optional) True/false. If set to true, ignore any fields present when the endpoint is read but that were not in data_json. Also, if a field that was written is not returned when the endpoint is read, treat that field as being up to date. You should set this to true when writing to endpoint that, when read, returns a different set of fields from the ones you wrote, as is common with many configuration endpoints. Defaults to false.
    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.
    writeFields List<String>
    • (Optional). A list of fields that should be returned in write_data_json and write_data. If omitted, data returned by the write operation is not available to the resource or included in state. This helps to avoid accidental storage of sensitive values in state. Some endpoints, such as many dynamic secrets endpoints, return data from writing to an endpoint rather than reading it. You should use write_fields if you need information returned in this way.
    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
    • (Optional) True/false. Set this to true if your vault authentication is not able to delete the data or if the endpoint does not support the DELETE method. Defaults to false.
    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
    • (Optional) True/false. If set to true, ignore any fields present when the endpoint is read but that were not in data_json. Also, if a field that was written is not returned when the endpoint is read, treat that field as being up to date. You should set this to true when writing to endpoint that, when read, returns a different set of fields from the ones you wrote, as is common with many configuration endpoints. Defaults to false.
    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.
    writeFields string[]
    • (Optional). A list of fields that should be returned in write_data_json and write_data. If omitted, data returned by the write operation is not available to the resource or included in state. This helps to avoid accidental storage of sensitive values in state. Some endpoints, such as many dynamic secrets endpoints, return data from writing to an endpoint rather than reading it. You should use write_fields if you need information returned in this way.
    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
    • (Optional) True/false. Set this to true if your vault authentication is not able to delete the data or if the endpoint does not support the DELETE method. Defaults to false.
    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
    • (Optional) True/false. If set to true, ignore any fields present when the endpoint is read but that were not in data_json. Also, if a field that was written is not returned when the endpoint is read, treat that field as being up to date. You should set this to true when writing to endpoint that, when read, returns a different set of fields from the ones you wrote, as is common with many configuration endpoints. Defaults to false.
    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.
    write_fields Sequence[str]
    • (Optional). A list of fields that should be returned in write_data_json and write_data. If omitted, data returned by the write operation is not available to the resource or included in state. This helps to avoid accidental storage of sensitive values in state. Some endpoints, such as many dynamic secrets endpoints, return data from writing to an endpoint rather than reading it. You should use write_fields if you need information returned in this way.
    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
    • (Optional) True/false. Set this to true if your vault authentication is not able to delete the data or if the endpoint does not support the DELETE method. Defaults to false.
    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
    • (Optional) True/false. If set to true, ignore any fields present when the endpoint is read but that were not in data_json. Also, if a field that was written is not returned when the endpoint is read, treat that field as being up to date. You should set this to true when writing to endpoint that, when read, returns a different set of fields from the ones you wrote, as is common with many configuration endpoints. Defaults to false.
    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.
    writeFields List<String>
    • (Optional). A list of fields that should be returned in write_data_json and write_data. If omitted, data returned by the write operation is not available to the resource or included in state. This helps to avoid accidental storage of sensitive values in state. Some endpoints, such as many dynamic secrets endpoints, return data from writing to an endpoint rather than reading it. You should use write_fields if you need information returned in this way.

    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>
    • A map whose keys are the top-level data keys returned from Vault by the write operation and whose values are the corresponding values. This map can only represent string data, so any non-string values returned from Vault are serialized as JSON. Only fields set in write_fields are present in the JSON data.
    WriteDataJson string
    • The JSON data returned by the write operation. Only fields set in write_fields are present in the JSON data.
    Id string
    The provider-assigned unique ID for this managed resource.
    WriteData map[string]string
    • A map whose keys are the top-level data keys returned from Vault by the write operation and whose values are the corresponding values. This map can only represent string data, so any non-string values returned from Vault are serialized as JSON. Only fields set in write_fields are present in the JSON data.
    WriteDataJson string
    • The JSON data returned by the write operation. Only fields set in write_fields are present in the JSON data.
    id String
    The provider-assigned unique ID for this managed resource.
    writeData Map<String,String>
    • A map whose keys are the top-level data keys returned from Vault by the write operation and whose values are the corresponding values. This map can only represent string data, so any non-string values returned from Vault are serialized as JSON. Only fields set in write_fields are present in the JSON data.
    writeDataJson String
    • The JSON data returned by the write operation. Only fields set in write_fields are present in the JSON data.
    id string
    The provider-assigned unique ID for this managed resource.
    writeData {[key: string]: string}
    • A map whose keys are the top-level data keys returned from Vault by the write operation and whose values are the corresponding values. This map can only represent string data, so any non-string values returned from Vault are serialized as JSON. Only fields set in write_fields are present in the JSON data.
    writeDataJson string
    • The JSON data returned by the write operation. Only fields set in write_fields are present in the JSON data.
    id str
    The provider-assigned unique ID for this managed resource.
    write_data Mapping[str, str]
    • A map whose keys are the top-level data keys returned from Vault by the write operation and whose values are the corresponding values. This map can only represent string data, so any non-string values returned from Vault are serialized as JSON. Only fields set in write_fields are present in the JSON data.
    write_data_json str
    • The JSON data returned by the write operation. Only fields set in write_fields are present in the JSON data.
    id String
    The provider-assigned unique ID for this managed resource.
    writeData Map<String>
    • A map whose keys are the top-level data keys returned from Vault by the write operation and whose values are the corresponding values. This map can only represent string data, so any non-string values returned from Vault are serialized as JSON. Only fields set in write_fields are present in the JSON data.
    writeDataJson String
    • The JSON data returned by the write operation. Only fields set in write_fields are present in the JSON data.

    Look up 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,
        namespace: Optional[str] = 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
    • (Optional) True/false. Set this to true if your vault authentication is not able to delete the data or if the endpoint does not support the DELETE method. Defaults to false.
    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
    • (Optional) True/false. If set to true, ignore any fields present when the endpoint is read but that were not in data_json. Also, if a field that was written is not returned when the endpoint is read, treat that field as being up to date. You should set this to true when writing to endpoint that, when read, returns a different set of fields from the ones you wrote, as is common with many configuration endpoints. Defaults to false.
    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.
    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>
    • A map whose keys are the top-level data keys returned from Vault by the write operation and whose values are the corresponding values. This map can only represent string data, so any non-string values returned from Vault are serialized as JSON. Only fields set in write_fields are present in the JSON data.
    WriteDataJson string
    • The JSON data returned by the write operation. Only fields set in write_fields are present in the JSON data.
    WriteFields List<string>
    • (Optional). A list of fields that should be returned in write_data_json and write_data. If omitted, data returned by the write operation is not available to the resource or included in state. This helps to avoid accidental storage of sensitive values in state. Some endpoints, such as many dynamic secrets endpoints, return data from writing to an endpoint rather than reading it. You should use write_fields if you need information returned in this way.
    DataJson string
    String containing a JSON-encoded object that will be written to the given path as the secret data.
    DisableDelete bool
    • (Optional) True/false. Set this to true if your vault authentication is not able to delete the data or if the endpoint does not support the DELETE method. Defaults to false.
    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
    • (Optional) True/false. If set to true, ignore any fields present when the endpoint is read but that were not in data_json. Also, if a field that was written is not returned when the endpoint is read, treat that field as being up to date. You should set this to true when writing to endpoint that, when read, returns a different set of fields from the ones you wrote, as is common with many configuration endpoints. Defaults to false.
    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.
    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
    • A map whose keys are the top-level data keys returned from Vault by the write operation and whose values are the corresponding values. This map can only represent string data, so any non-string values returned from Vault are serialized as JSON. Only fields set in write_fields are present in the JSON data.
    WriteDataJson string
    • The JSON data returned by the write operation. Only fields set in write_fields are present in the JSON data.
    WriteFields []string
    • (Optional). A list of fields that should be returned in write_data_json and write_data. If omitted, data returned by the write operation is not available to the resource or included in state. This helps to avoid accidental storage of sensitive values in state. Some endpoints, such as many dynamic secrets endpoints, return data from writing to an endpoint rather than reading it. You should use write_fields if you need information returned in this way.
    dataJson String
    String containing a JSON-encoded object that will be written to the given path as the secret data.
    disableDelete Boolean
    • (Optional) True/false. Set this to true if your vault authentication is not able to delete the data or if the endpoint does not support the DELETE method. Defaults to false.
    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
    • (Optional) True/false. If set to true, ignore any fields present when the endpoint is read but that were not in data_json. Also, if a field that was written is not returned when the endpoint is read, treat that field as being up to date. You should set this to true when writing to endpoint that, when read, returns a different set of fields from the ones you wrote, as is common with many configuration endpoints. Defaults to false.
    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.
    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>
    • A map whose keys are the top-level data keys returned from Vault by the write operation and whose values are the corresponding values. This map can only represent string data, so any non-string values returned from Vault are serialized as JSON. Only fields set in write_fields are present in the JSON data.
    writeDataJson String
    • The JSON data returned by the write operation. Only fields set in write_fields are present in the JSON data.
    writeFields List<String>
    • (Optional). A list of fields that should be returned in write_data_json and write_data. If omitted, data returned by the write operation is not available to the resource or included in state. This helps to avoid accidental storage of sensitive values in state. Some endpoints, such as many dynamic secrets endpoints, return data from writing to an endpoint rather than reading it. You should use write_fields if you need information returned in this way.
    dataJson string
    String containing a JSON-encoded object that will be written to the given path as the secret data.
    disableDelete boolean
    • (Optional) True/false. Set this to true if your vault authentication is not able to delete the data or if the endpoint does not support the DELETE method. Defaults to false.
    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
    • (Optional) True/false. If set to true, ignore any fields present when the endpoint is read but that were not in data_json. Also, if a field that was written is not returned when the endpoint is read, treat that field as being up to date. You should set this to true when writing to endpoint that, when read, returns a different set of fields from the ones you wrote, as is common with many configuration endpoints. Defaults to false.
    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.
    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}
    • A map whose keys are the top-level data keys returned from Vault by the write operation and whose values are the corresponding values. This map can only represent string data, so any non-string values returned from Vault are serialized as JSON. Only fields set in write_fields are present in the JSON data.
    writeDataJson string
    • The JSON data returned by the write operation. Only fields set in write_fields are present in the JSON data.
    writeFields string[]
    • (Optional). A list of fields that should be returned in write_data_json and write_data. If omitted, data returned by the write operation is not available to the resource or included in state. This helps to avoid accidental storage of sensitive values in state. Some endpoints, such as many dynamic secrets endpoints, return data from writing to an endpoint rather than reading it. You should use write_fields if you need information returned in this way.
    data_json str
    String containing a JSON-encoded object that will be written to the given path as the secret data.
    disable_delete bool
    • (Optional) True/false. Set this to true if your vault authentication is not able to delete the data or if the endpoint does not support the DELETE method. Defaults to false.
    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
    • (Optional) True/false. If set to true, ignore any fields present when the endpoint is read but that were not in data_json. Also, if a field that was written is not returned when the endpoint is read, treat that field as being up to date. You should set this to true when writing to endpoint that, when read, returns a different set of fields from the ones you wrote, as is common with many configuration endpoints. Defaults to false.
    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.
    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]
    • A map whose keys are the top-level data keys returned from Vault by the write operation and whose values are the corresponding values. This map can only represent string data, so any non-string values returned from Vault are serialized as JSON. Only fields set in write_fields are present in the JSON data.
    write_data_json str
    • The JSON data returned by the write operation. Only fields set in write_fields are present in the JSON data.
    write_fields Sequence[str]
    • (Optional). A list of fields that should be returned in write_data_json and write_data. If omitted, data returned by the write operation is not available to the resource or included in state. This helps to avoid accidental storage of sensitive values in state. Some endpoints, such as many dynamic secrets endpoints, return data from writing to an endpoint rather than reading it. You should use write_fields if you need information returned in this way.
    dataJson String
    String containing a JSON-encoded object that will be written to the given path as the secret data.
    disableDelete Boolean
    • (Optional) True/false. Set this to true if your vault authentication is not able to delete the data or if the endpoint does not support the DELETE method. Defaults to false.
    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
    • (Optional) True/false. If set to true, ignore any fields present when the endpoint is read but that were not in data_json. Also, if a field that was written is not returned when the endpoint is read, treat that field as being up to date. You should set this to true when writing to endpoint that, when read, returns a different set of fields from the ones you wrote, as is common with many configuration endpoints. Defaults to false.
    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.
    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>
    • A map whose keys are the top-level data keys returned from Vault by the write operation and whose values are the corresponding values. This map can only represent string data, so any non-string values returned from Vault are serialized as JSON. Only fields set in write_fields are present in the JSON data.
    writeDataJson String
    • The JSON data returned by the write operation. Only fields set in write_fields are present in the JSON data.
    writeFields List<String>
    • (Optional). A list of fields that should be returned in write_data_json and write_data. If omitted, data returned by the write operation is not available to the resource or included in state. This helps to avoid accidental storage of sensitive values in state. Some endpoints, such as many dynamic secrets endpoints, return data from writing to an endpoint rather than reading it. You should use write_fields if you need information returned in this way.

    Import

    Import is not supported for this resource.

    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.
    vault logo
    HashiCorp Vault v6.4.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-vault