Class SecretBackendRole

Manages a Consul secrets role for a Consul secrets engine in Vault. Consul secret backends can then issue Consul tokens.

Example Usage

using Pulumi;
using Vault = Pulumi.Vault;

class MyStack : Stack
{
public MyStack()
{
    var test = new Vault.Consul.SecretBackend("test", new Vault.Consul.SecretBackendArgs
    {
        Path = "consul",
        Description = "Manages the Consul backend",
        Address = "127.0.0.1:8500",
        Token = "4240861b-ce3d-8530-115a-521ff070dd29",
    });
    var example = new Vault.Consul.SecretBackendRole("example", new Vault.Consul.SecretBackendRoleArgs
    {
        Backend = test.Path,
        Policies = 
        {
            "example-policy",
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

SecretBackendRole

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

Assembly: Pulumi.Vault.dll

Syntax

public class SecretBackendRole : CustomResource

Constructors

SecretBackendRole(String, SecretBackendRoleArgs, CustomResourceOptions)

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

Declaration

public SecretBackendRole(string name, SecretBackendRoleArgs args, CustomResourceOptions options = null)

Parameters

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

Properties

Backend

The unique name of an existing Consul secrets backend mount. Must not begin or end with a /. One of path or backend is required.

Declaration

public Output<string> Backend { get; }

Property Value

Type	Description
Output<System.String>

Local

Indicates that the token should not be replicated globally and instead be local to the current datacenter.

Declaration

public Output<bool?> Local { get; }

Property Value

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

MaxTtl

Maximum TTL for leases associated with this role, in seconds.

Declaration

public Output<int?> MaxTtl { get; }

Property Value

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

Name

The name of the Consul secrets engine role to create.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Path

The unique name of an existing Consul secrets backend mount. Must not begin or end with a /. Deprecated

Declaration

public Output<string> Path { get; }

Property Value

Type	Description
Output<System.String>

Policies

The list of Consul ACL policies to associate with these roles.

Declaration

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

Property Value

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

TokenType

Specifies the type of token to create when using this role. Valid values are "client" or "management".

Declaration

public Output<string> TokenType { get; }

Property Value

Type	Description
Output<System.String>

Ttl

Specifies the TTL for this role.

Declaration

public Output<int?> Ttl { get; }

Property Value

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

Methods

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

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

Declaration

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

Returns

Type	Description
SecretBackendRole