Class Token
Inherited Members
Namespace: Pulumi.Vault
Assembly: Pulumi.Vault.dll
Syntax
public class Token : CustomResource
Constructors
View SourceToken(String, TokenArgs, CustomResourceOptions)
Create a Token resource with the given unique name, arguments, and options.
Declaration
public Token(string name, TokenArgs args = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| TokenArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceClientToken
String containing the client token if stored in present file
Declaration
public Output<string> ClientToken { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
DisplayName
String containing the token display name
Declaration
public Output<string> DisplayName { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
EncryptedClientToken
String containing the client token encrypted with the given pgp_key if stored in present file
Declaration
public Output<string> EncryptedClientToken { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
ExplicitMaxTtl
The explicit max TTL of this token
Declaration
public Output<string> ExplicitMaxTtl { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
LeaseDuration
String containing the token lease duration if present in state file
Declaration
public Output<int> LeaseDuration { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Int32> |
LeaseStarted
String containing the token lease started time if present in state file
Declaration
public Output<string> LeaseStarted { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
NoDefaultPolicy
Flag to not attach the default policy to this token
Declaration
public Output<bool?> NoDefaultPolicy { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Boolean>> |
NoParent
Flag to create a token without parent
Declaration
public Output<bool> NoParent { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Boolean> |
NumUses
The number of allowed uses of this token
Declaration
public Output<int> NumUses { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Int32> |
Period
The period of this token
Declaration
public Output<string> Period { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
PgpKey
The PGP key (base64 encoded) to encrypt the token.
Declaration
public Output<string> PgpKey { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Policies
List of policies to attach to this token
Declaration
public Output<ImmutableArray<string>> Policies { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableArray<System.String>> |
Renewable
Flag to allow to renew this token
Declaration
public Output<bool> Renewable { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Boolean> |
RenewIncrement
The renew increment
Declaration
public Output<int?> RenewIncrement { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Int32>> |
RenewMinLease
The minimal lease to renew this token
Declaration
public Output<int?> RenewMinLease { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Int32>> |
RoleName
The token role name
Declaration
public Output<string> RoleName { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Ttl
The TTL period of this token
Declaration
public Output<string> Ttl { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
WrappedToken
The client wrapped token.
Declaration
public Output<string> WrappedToken { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
WrappingAccessor
The client wrapping accessor.
Declaration
public Output<string> WrappingAccessor { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
WrappingTtl
The TTL period of the wrapped token.
Declaration
public Output<string> WrappingTtl { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Methods
View SourceGet(String, Input<String>, TokenState, CustomResourceOptions)
Get an existing Token resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static Token Get(string name, Input<string> id, TokenState 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. |
| TokenState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| Token |