Class CertAuthBackendRole

Provides a resource to create a role in an Cert auth backend within Vault.

Example Usage

using System.IO;
using Pulumi;
using Vault = Pulumi.Vault;

class MyStack : Stack
{
public MyStack()
{
    var certAuthBackend = new Vault.AuthBackend("certAuthBackend", new Vault.AuthBackendArgs
    {
        Path = "cert",
        Type = "cert",
    });
    var certCertAuthBackendRole = new Vault.CertAuthBackendRole("certCertAuthBackendRole", new Vault.CertAuthBackendRoleArgs
    {
        Certificate = File.ReadAllText("/path/to/certs/ca-cert.pem"),
        Backend = certAuthBackend.Path,
        AllowedNames = 
        {
            "foo.example.org",
            "baz.example.org",
        },
        TokenTtl = 300,
        TokenMaxTtl = 600,
        TokenPolicies = 
        {
            "foo",
        },
    });
}

}
Inheritance
System.Object
Resource
CustomResource
CertAuthBackendRole
Inherited Members
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
Assembly: Pulumi.Vault.dll
Syntax
public class CertAuthBackendRole : CustomResource

Constructors

View Source

CertAuthBackendRole(String, CertAuthBackendRoleArgs, CustomResourceOptions)

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

Declaration
public CertAuthBackendRole(string name, CertAuthBackendRoleArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource
CertAuthBackendRoleArgs args

The arguments used to populate this resource's properties
CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

AllowedCommonNames

Allowed the common names for authenticated client certificates

Declaration
public Output<ImmutableArray<string>> AllowedCommonNames { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

AllowedDnsSans

Allowed alternative dns names for authenticated client certificates

Declaration
public Output<ImmutableArray<string>> AllowedDnsSans { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

AllowedEmailSans

Allowed emails for authenticated client certificates

Declaration
public Output<ImmutableArray<string>> AllowedEmailSans { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

AllowedNames

Allowed subject names for authenticated client certificates

Declaration
public Output<ImmutableArray<string>> AllowedNames { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

AllowedOrganizationUnits

Allowed organization units for authenticated client certificates

Declaration
public Output<ImmutableArray<string>> AllowedOrganizationUnits { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

AllowedUriSans

Allowed URIs for authenticated client certificates

Declaration
public Output<ImmutableArray<string>> AllowedUriSans { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

Backend

Path to the mounted Cert auth backend

Declaration
public Output<string> Backend { get; }
Property Value
Type Description
Output<System.String>
View Source

BoundCidrs

Restriction usage of the certificates to client IPs falling within the range of the specified CIDRs

Declaration
public Output<ImmutableArray<string>> BoundCidrs { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

Certificate

CA certificate used to validate client certificates

Declaration
public Output<string> Certificate { get; }
Property Value
Type Description
Output<System.String>
View Source

DisplayName

The name to display on tokens issued under this role.

Declaration
public Output<string> DisplayName { get; }
Property Value
Type Description
Output<System.String>
View Source

MaxTtl

The maximum allowed lifetime of tokens issued using this role, provided as a number of seconds.

Declaration
public Output<string> MaxTtl { get; }
Property Value
Type Description
Output<System.String>
View Source

Name

Name of the role

Declaration
public Output<string> Name { get; }
Property Value
Type Description
Output<System.String>
View Source

Period

If set, indicates that the token generated using this role should never expire. The token should be renewed within the duration specified by this value. At each renewal, the token's TTL will be set to the value of this field. Specified in seconds.

Declaration
public Output<string> Period { get; }
Property Value
Type Description
Output<System.String>
View Source

Policies

An array of strings specifying the policies to be set on tokens issued using this role.

Declaration
public Output<ImmutableArray<string>> Policies { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

RequiredExtensions

TLS extensions required on client certificates

Declaration
public Output<ImmutableArray<string>> RequiredExtensions { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

TokenBoundCidrs

List of CIDR blocks; if set, specifies blocks of IP addresses which can authenticate successfully, and ties the resulting token to these blocks as well.

Declaration
public Output<ImmutableArray<string>> TokenBoundCidrs { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

TokenExplicitMaxTtl

If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if token_ttl and token_max_ttl would otherwise allow a renewal.

Declaration
public Output<int?> TokenExplicitMaxTtl { get; }
Property Value
Type Description
Output<System.Nullable<System.Int32>>
View Source

TokenMaxTtl

The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

Declaration
public Output<int?> TokenMaxTtl { get; }
Property Value
Type Description
Output<System.Nullable<System.Int32>>
View Source

TokenNoDefaultPolicy

If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.

Declaration
public Output<bool?> TokenNoDefaultPolicy { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

TokenNumUses

The period, if any, in number of seconds to set on the token.

Declaration
public Output<int?> TokenNumUses { get; }
Property Value
Type Description
Output<System.Nullable<System.Int32>>
View Source

TokenPeriod

If set, indicates that the token generated using this role should never expire. The token should be renewed within the duration specified by this value. At each renewal, the token's TTL will be set to the value of this field. Specified in seconds.

Declaration
public Output<int?> TokenPeriod { get; }
Property Value
Type Description
Output<System.Nullable<System.Int32>>
View Source

TokenPolicies

List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.

Declaration
public Output<ImmutableArray<string>> TokenPolicies { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

TokenTtl

The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

Declaration
public Output<int?> TokenTtl { get; }
Property Value
Type Description
Output<System.Nullable<System.Int32>>
View Source

TokenType

The type of token that should be generated. Can be service, batch, or default to use the mount's tuned default (which unless changed will be service tokens). For token store roles, there are two additional possibilities: default-service and default-batch which specify the type to return unless the client requests a different type at generation time.

Declaration
public Output<string> TokenType { get; }
Property Value
Type Description
Output<System.String>
View Source

Ttl

The TTL period of tokens issued using this role, provided as a number of seconds.

Declaration
public Output<string> Ttl { get; }
Property Value
Type Description
Output<System.String>

Methods

View Source

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

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

Declaration
public static CertAuthBackendRole Get(string name, Input<string> id, CertAuthBackendRoleState 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.
CertAuthBackendRoleState state

Any extra arguments used during the lookup.
CustomResourceOptions options

A bag of options that control this resource's behavior
Returns
Type Description
CertAuthBackendRole