Class Secret

Inheritance

System.Object

Resource

CustomResource

Secret

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 Secret : CustomResource

Constructors

Secret(String, SecretArgs, CustomResourceOptions)

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

Declaration

public Secret(string name, SecretArgs args, CustomResourceOptions options = null)

Parameters

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

Properties

Data

A mapping whose keys are the top-level data keys returned from Vault 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.

Declaration

public Output<ImmutableDictionary<string, object>> Data { get; }

Property Value

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

DataJson

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

Declaration

public Output<string> DataJson { get; }

Property Value

Type	Description
Output<System.String>

DisableRead

True/false. Set this to true if your vault authentication is not able to read the data. Setting this to true will break drift detection. Defaults to false.

Declaration

public Output<bool?> DisableRead { get; }

Property Value

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

Path

The full logical path at which to write the given data. To write data into the "generic" secret backend mounted in Vault by default, this should be prefixed with secret/. Writing to other backends with this resource is possible; consult each backend's documentation to see which endpoints support the PUT and DELETE methods.

Declaration

public Output<string> Path { get; }

Property Value

Type	Description
Output<System.String>

Methods

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

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

Declaration

public static Secret Get(string name, Input<string> id, SecretState 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.
SecretState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Secret