Class KeyPrefix

Inheritance

System.Object

Resource

CustomResource

KeyPrefix

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.Consul

Assembly: Pulumi.Consul.dll

Syntax

public class KeyPrefix : CustomResource

Constructors

KeyPrefix(String, KeyPrefixArgs, CustomResourceOptions)

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

Declaration

public KeyPrefix(string name, KeyPrefixArgs args, CustomResourceOptions options = null)

Parameters

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

Properties

Datacenter

The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.

Declaration

public Output<string> Datacenter { get; }

Property Value

Type	Description
Output<System.String>

Namespace

The namespace to create the keys within.

Declaration

public Output<string> Namespace { get; }

Property Value

Type	Description
Output<System.String>

PathPrefix

Specifies the common prefix shared by all keys that will be managed by this resource instance. In most cases this will end with a slash, to manage a "folder" of keys.

Declaration

public Output<string> PathPrefix { get; }

Property Value

Type	Description
Output<System.String>

SubkeyCollection

A subkey to add. Supported values documented below. Multiple blocks supported.

Declaration

public Output<ImmutableArray<KeyPrefixSubkeyCollection>> SubkeyCollection { get; }

Property Value

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

Subkeys

A mapping from subkey name (which will be appended to the given path_prefix) to the value that should be stored at that key. Use slashes, as shown in the above example, to create "sub-folders" under the given path prefix.

Declaration

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

Property Value

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

Token

The ACL token to use. This overrides the token that the agent provides by default.

Declaration

public Output<string> Token { get; }

Property Value

Type	Description
Output<System.String>

Methods

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

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

Declaration

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

Returns

Type	Description
KeyPrefix