TargetHashivault

akeyless 2.0.1, Apr 27 26

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Create TargetHashivault Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new TargetHashivault(name: string, args?: TargetHashivaultArgs, opts?: CustomResourceOptions);

@overload
def TargetHashivault(resource_name: str,
                     args: Optional[TargetHashivaultArgs] = None,
                     opts: Optional[ResourceOptions] = None)

@overload
def TargetHashivault(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     description: Optional[str] = None,
                     hashi_url: Optional[str] = None,
                     keep_prev_version: Optional[str] = None,
                     key: Optional[str] = None,
                     max_versions: Optional[str] = None,
                     name: Optional[str] = None,
                     namespaces: Optional[Sequence[str]] = None,
                     target_hashivault_id: Optional[str] = None,
                     vault_token: Optional[str] = None)

func NewTargetHashivault(ctx *Context, name string, args *TargetHashivaultArgs, opts ...ResourceOption) (*TargetHashivault, error)

public TargetHashivault(string name, TargetHashivaultArgs? args = null, CustomResourceOptions? opts = null)

public TargetHashivault(String name, TargetHashivaultArgs args)
public TargetHashivault(String name, TargetHashivaultArgs args, CustomResourceOptions options)

type: akeyless:TargetHashivault
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "akeyless_targethashivault" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args TargetHashivaultArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args TargetHashivaultArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args TargetHashivaultArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TargetHashivaultArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args TargetHashivaultArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var targetHashivaultResource = new Akeyless.TargetHashivault("targetHashivaultResource", new()
{
    Description = "string",
    HashiUrl = "string",
    KeepPrevVersion = "string",
    Key = "string",
    MaxVersions = "string",
    Name = "string",
    Namespaces = new[]
    {
        "string",
    },
    TargetHashivaultId = "string",
    VaultToken = "string",
});

example, err := akeyless.NewTargetHashivault(ctx, "targetHashivaultResource", &akeyless.TargetHashivaultArgs{
	Description:     pulumi.String("string"),
	HashiUrl:        pulumi.String("string"),
	KeepPrevVersion: pulumi.String("string"),
	Key:             pulumi.String("string"),
	MaxVersions:     pulumi.String("string"),
	Name:            pulumi.String("string"),
	Namespaces: pulumi.StringArray{
		pulumi.String("string"),
	},
	TargetHashivaultId: pulumi.String("string"),
	VaultToken:         pulumi.String("string"),
})

resource "akeyless_targethashivault" "targetHashivaultResource" {
  description          = "string"
  hashi_url            = "string"
  keep_prev_version    = "string"
  key                  = "string"
  max_versions         = "string"
  name                 = "string"
  namespaces           = ["string"]
  target_hashivault_id = "string"
  vault_token          = "string"
}

var targetHashivaultResource = new TargetHashivault("targetHashivaultResource", TargetHashivaultArgs.builder()
    .description("string")
    .hashiUrl("string")
    .keepPrevVersion("string")
    .key("string")
    .maxVersions("string")
    .name("string")
    .namespaces("string")
    .targetHashivaultId("string")
    .vaultToken("string")
    .build());

target_hashivault_resource = akeyless.TargetHashivault("targetHashivaultResource",
    description="string",
    hashi_url="string",
    keep_prev_version="string",
    key="string",
    max_versions="string",
    name="string",
    namespaces=["string"],
    target_hashivault_id="string",
    vault_token="string")

const targetHashivaultResource = new akeyless.TargetHashivault("targetHashivaultResource", {
    description: "string",
    hashiUrl: "string",
    keepPrevVersion: "string",
    key: "string",
    maxVersions: "string",
    name: "string",
    namespaces: ["string"],
    targetHashivaultId: "string",
    vaultToken: "string",
});

type: akeyless:TargetHashivault
properties:
    description: string
    hashiUrl: string
    keepPrevVersion: string
    key: string
    maxVersions: string
    name: string
    namespaces:
        - string
    targetHashivaultId: string
    vaultToken: string

TargetHashivault Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The TargetHashivault resource accepts the following input properties:

Description string: Description of the object
HashiUrl string: HashiCorp Vault API URL, e.g. https://vault-mgr01:8200
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults
Name string: Target name
Namespaces List<string>: Comma-separated list of vault namespaces
TargetHashivaultId string: The ID of this resource.
VaultToken string: Vault access token with sufficient permissions

Description string: Description of the object
HashiUrl string: HashiCorp Vault API URL, e.g. https://vault-mgr01:8200
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults
Name string: Target name
Namespaces []string: Comma-separated list of vault namespaces
TargetHashivaultId string: The ID of this resource.
VaultToken string: Vault access token with sufficient permissions

description string: Description of the object
hashi_url string: HashiCorp Vault API URL, e.g. https://vault-mgr01:8200
keep_prev_version string: Whether to keep previous version [true/false]. If not set, use default according to account settings
key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
max_versions string: Set the maximum number of versions, limited by the account settings defaults
name string: Target name
namespaces list(string): Comma-separated list of vault namespaces
target_hashivault_id string: The ID of this resource.
vault_token string: Vault access token with sufficient permissions

description String: Description of the object
hashiUrl String: HashiCorp Vault API URL, e.g. https://vault-mgr01:8200
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults
name String: Target name
namespaces List<String>: Comma-separated list of vault namespaces
targetHashivaultId String: The ID of this resource.
vaultToken String: Vault access token with sufficient permissions

description string: Description of the object
hashiUrl string: HashiCorp Vault API URL, e.g. https://vault-mgr01:8200
keepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions string: Set the maximum number of versions, limited by the account settings defaults
name string: Target name
namespaces string[]: Comma-separated list of vault namespaces
targetHashivaultId string: The ID of this resource.
vaultToken string: Vault access token with sufficient permissions

description str: Description of the object
hashi_url str: HashiCorp Vault API URL, e.g. https://vault-mgr01:8200
keep_prev_version str: Whether to keep previous version [true/false]. If not set, use default according to account settings
key str: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
max_versions str: Set the maximum number of versions, limited by the account settings defaults
name str: Target name
namespaces Sequence[str]: Comma-separated list of vault namespaces
target_hashivault_id str: The ID of this resource.
vault_token str: Vault access token with sufficient permissions

description String: Description of the object
hashiUrl String: HashiCorp Vault API URL, e.g. https://vault-mgr01:8200
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults
name String: Target name
namespaces List<String>: Comma-separated list of vault namespaces
targetHashivaultId String: The ID of this resource.
vaultToken String: Vault access token with sufficient permissions

Outputs

All input properties are implicitly available as output properties. Additionally, the TargetHashivault resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing TargetHashivault Resource

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

public static get(name: string, id: Input<ID>, state?: TargetHashivaultState, opts?: CustomResourceOptions): TargetHashivault

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        hashi_url: Optional[str] = None,
        keep_prev_version: Optional[str] = None,
        key: Optional[str] = None,
        max_versions: Optional[str] = None,
        name: Optional[str] = None,
        namespaces: Optional[Sequence[str]] = None,
        target_hashivault_id: Optional[str] = None,
        vault_token: Optional[str] = None) -> TargetHashivault

func GetTargetHashivault(ctx *Context, name string, id IDInput, state *TargetHashivaultState, opts ...ResourceOption) (*TargetHashivault, error)

public static TargetHashivault Get(string name, Input<string> id, TargetHashivaultState? state, CustomResourceOptions? opts = null)

public static TargetHashivault get(String name, Output<String> id, TargetHashivaultState state, CustomResourceOptions options)

resources:  _:    type: akeyless:TargetHashivault    get:      id: ${id}

import {
  to = akeyless_targethashivault.example
  id = "${id}"
}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Description string: Description of the object
HashiUrl string: HashiCorp Vault API URL, e.g. https://vault-mgr01:8200
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults
Name string: Target name
Namespaces List<string>: Comma-separated list of vault namespaces
TargetHashivaultId string: The ID of this resource.
VaultToken string: Vault access token with sufficient permissions

Description string: Description of the object
HashiUrl string: HashiCorp Vault API URL, e.g. https://vault-mgr01:8200
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults
Name string: Target name
Namespaces []string: Comma-separated list of vault namespaces
TargetHashivaultId string: The ID of this resource.
VaultToken string: Vault access token with sufficient permissions

description string: Description of the object
hashi_url string: HashiCorp Vault API URL, e.g. https://vault-mgr01:8200
keep_prev_version string: Whether to keep previous version [true/false]. If not set, use default according to account settings
key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
max_versions string: Set the maximum number of versions, limited by the account settings defaults
name string: Target name
namespaces list(string): Comma-separated list of vault namespaces
target_hashivault_id string: The ID of this resource.
vault_token string: Vault access token with sufficient permissions

description String: Description of the object
hashiUrl String: HashiCorp Vault API URL, e.g. https://vault-mgr01:8200
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults
name String: Target name
namespaces List<String>: Comma-separated list of vault namespaces
targetHashivaultId String: The ID of this resource.
vaultToken String: Vault access token with sufficient permissions

description string: Description of the object
hashiUrl string: HashiCorp Vault API URL, e.g. https://vault-mgr01:8200
keepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions string: Set the maximum number of versions, limited by the account settings defaults
name string: Target name
namespaces string[]: Comma-separated list of vault namespaces
targetHashivaultId string: The ID of this resource.
vaultToken string: Vault access token with sufficient permissions

description str: Description of the object
hashi_url str: HashiCorp Vault API URL, e.g. https://vault-mgr01:8200
keep_prev_version str: Whether to keep previous version [true/false]. If not set, use default according to account settings
key str: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
max_versions str: Set the maximum number of versions, limited by the account settings defaults
name str: Target name
namespaces Sequence[str]: Comma-separated list of vault namespaces
target_hashivault_id str: The ID of this resource.
vault_token str: Vault access token with sufficient permissions

description String: Description of the object
hashiUrl String: HashiCorp Vault API URL, e.g. https://vault-mgr01:8200
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults
name String: Target name
namespaces List<String>: Comma-separated list of vault namespaces
targetHashivaultId String: The ID of this resource.
vaultToken String: Vault access token with sufficient permissions