Class SecretBackendKeyState

Inheritance
System.Object
InputArgs
ResourceArgs
SecretBackendKeyState
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.Transit
Assembly: Pulumi.Vault.dll
Syntax
public sealed class SecretBackendKeyState : ResourceArgs

Constructors

View Source

SecretBackendKeyState()

Declaration
public SecretBackendKeyState()

Properties

View Source

AllowPlaintextBackup

Enables taking backup of entire keyring in the plaintext format. Once set, this cannot be disabled.

  • Refer to Vault API documentation on key backups for more information: Backup Key
Declaration
public Input<bool> AllowPlaintextBackup { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

Backend

The path the transit secret backend is mounted at, with no leading or trailing /s.

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

ConvergentEncryption

Whether or not to support convergent encryption, where the same plaintext creates the same ciphertext. This requires derived to be set to true.

Declaration
public Input<bool> ConvergentEncryption { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

DeletionAllowed

Specifies if the key is allowed to be deleted.

Declaration
public Input<bool> DeletionAllowed { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

Derived

Specifies if key derivation is to be used. If enabled, all encrypt/decrypt requests to this key must provide a context which is used for key derivation.

Declaration
public Input<bool> Derived { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

Exportable

Enables keys to be exportable. This allows for all valid private keys in the keyring to be exported. Once set, this cannot be disabled.

Declaration
public Input<bool> Exportable { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

Keys

List of key versions in the keyring. This attribute is zero-indexed and will contain a map of values depending on the type of the encryption key.

  • for key types aes256-gcm96 and chacha20-poly1305, each key version will be a map of a single value id which is just a hash of the key's metadata.
  • for key types ed25519, ecdsa-p256, rsa-2048 and rsa-4096, each key version will be a map of the following:
Declaration
public InputList<ImmutableDictionary<string, object>> Keys { get; set; }
Property Value
Type Description
InputList<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>
View Source

LatestVersion

Latest key version available. This value is 1-indexed, so if latest_version is 1, then the key's information can be referenced from keys by selecting element 0

Declaration
public Input<int> LatestVersion { get; set; }
Property Value
Type Description
Input<System.Int32>
View Source

MinAvailableVersion

Minimum key version available for use. If keys have been archived by increasing min_decryption_version, this attribute will reflect that change.

Declaration
public Input<int> MinAvailableVersion { get; set; }
Property Value
Type Description
Input<System.Int32>
View Source

MinDecryptionVersion

Minimum key version to use for decryption.

Declaration
public Input<int> MinDecryptionVersion { get; set; }
Property Value
Type Description
Input<System.Int32>
View Source

MinEncryptionVersion

Minimum key version to use for encryption

Declaration
public Input<int> MinEncryptionVersion { get; set; }
Property Value
Type Description
Input<System.Int32>
View Source

Name

The name to identify this key within the backend. Must be unique within the backend.

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

SupportsDecryption

Whether or not the key supports decryption, based on key type.

Declaration
public Input<bool> SupportsDecryption { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

SupportsDerivation

Whether or not the key supports derivation, based on key type.

Declaration
public Input<bool> SupportsDerivation { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

SupportsEncryption

Whether or not the key supports encryption, based on key type.

Declaration
public Input<bool> SupportsEncryption { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

SupportsSigning

Whether or not the key supports signing, based on key type.

Declaration
public Input<bool> SupportsSigning { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

Type

Specifies the type of key to create. The currently-supported types are: aes256-gcm96 (default), chacha20-poly1305, ed25519, ecdsa-p256, rsa-2048 and rsa-4096.

  • Refer to the Vault documentation on transit key types for more information: Key Types
Declaration
public Input<string> Type { get; set; }
Property Value
Type Description
Input<System.String>