Class Endpoint

Inheritance

System.Object

Resource

CustomResource

Endpoint

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Vault.Generic

Assembly: Pulumi.Vault.dll

Syntax

public class Endpoint : CustomResource

Constructors

Endpoint(String, EndpointArgs, CustomResourceOptions)

Create a Endpoint resource with the given unique name, arguments, and options.

Declaration

public Endpoint(string name, EndpointArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
EndpointArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

DataJson

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

Declaration

public Output<string> DataJson { get; }

Property Value

Type	Description
Output<System.String>

DisableDelete

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

Declaration

public Output<bool?> DisableDelete { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

DisableRead

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.

Declaration

public Output<bool?> DisableRead { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

IgnoreAbsentFields

When reading, disregard fields not present in data_json

Declaration

public Output<bool?> IgnoreAbsentFields { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Path

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.

Declaration

public Output<string> Path { get; }

Property Value

Type	Description
Output<System.String>

WriteData

Map of strings returned by write operation

Declaration

public Output<ImmutableDictionary<string, string>> WriteData { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

WriteDataJson

JSON data returned by write operation

Declaration

public Output<string> WriteDataJson { get; }

Property Value

Type	Description
Output<System.String>

WriteFields

Top-level fields returned by write to persist in state

Declaration

public Output<ImmutableArray<string>> WriteFields { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Methods

Get(String, Input<String>, EndpointState, CustomResourceOptions)

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

Declaration

public static Endpoint Get(string name, Input<string> id, EndpointState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
EndpointState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Endpoint