HashiCorp Vault

v5.1.0 published on Thursday, Dec 30, 2021 by Pulumi

Provider

The provider type for the vault package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Create a Provider Resource

new Provider(name: string, args: ProviderArgs, opts?: CustomResourceOptions);
@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             add_address_to_env: Optional[str] = None,
             address: Optional[str] = None,
             auth_logins: Optional[Sequence[ProviderAuthLoginArgs]] = None,
             ca_cert_dir: Optional[str] = None,
             ca_cert_file: Optional[str] = None,
             client_auths: Optional[Sequence[ProviderClientAuthArgs]] = None,
             headers: Optional[Sequence[ProviderHeaderArgs]] = None,
             max_lease_ttl_seconds: Optional[int] = None,
             max_retries: Optional[int] = None,
             max_retries_ccc: Optional[int] = None,
             namespace: Optional[str] = None,
             skip_child_token: Optional[bool] = None,
             skip_tls_verify: Optional[bool] = None,
             token: Optional[str] = None,
             token_name: Optional[str] = None)
@overload
def Provider(resource_name: str,
             args: ProviderArgs,
             opts: Optional[ResourceOptions] = None)
func NewProvider(ctx *Context, name string, args ProviderArgs, opts ...ResourceOption) (*Provider, error)
public Provider(string name, ProviderArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ProviderArgs
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 ProviderArgs
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 ProviderArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Provider Resource Properties

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

Inputs

The Provider resource accepts the following input properties:

Address string
URL of the root of the target Vault server.
Token string
Token to use to authenticate to Vault.
AddAddressToEnv string
If true, adds the value of the address argument to the Terraform process environment.
AuthLogins List<ProviderAuthLoginArgs>
Login to vault with an existing auth method using auth//login
CaCertDir string
Path to directory containing CA certificate files to validate the server’s certificate.
CaCertFile string
Path to a CA certificate file to validate the server’s certificate.
ClientAuths List<ProviderClientAuthArgs>
Client authentication credentials.
Headers List<ProviderHeaderArgs>
The headers to send with each Vault request.
MaxLeaseTtlSeconds int
Maximum TTL for secret leases requested by this provider. It can also be sourced from the following environment variable: TERRAFORM_VAULT_MAX_TTL
MaxRetries int
Maximum number of retries when a 5xx error code is encountered. It can also be sourced from the following environment variable: VAULT_MAX_RETRIES
MaxRetriesCcc int
Maximum number of retries for Client Controlled Consistency related operations
Namespace string
The namespace to use. Available only for Vault Enterprise.
SkipChildToken bool
Set this to true to prevent the creation of ephemeral child token used by this provider.
SkipTlsVerify bool
Set this to true only if the target Vault server is an insecure development instance. It can also be sourced from the following environment variable: VAULT_SKIP_VERIFY
TokenName string
Token name to use for creating the Vault child token.
Address string
URL of the root of the target Vault server.
Token string
Token to use to authenticate to Vault.
AddAddressToEnv string
If true, adds the value of the address argument to the Terraform process environment.
AuthLogins []ProviderAuthLoginArgs
Login to vault with an existing auth method using auth//login
CaCertDir string
Path to directory containing CA certificate files to validate the server’s certificate.
CaCertFile string
Path to a CA certificate file to validate the server’s certificate.
ClientAuths []ProviderClientAuthArgs
Client authentication credentials.
Headers []ProviderHeaderArgs
The headers to send with each Vault request.
MaxLeaseTtlSeconds int
Maximum TTL for secret leases requested by this provider. It can also be sourced from the following environment variable: TERRAFORM_VAULT_MAX_TTL
MaxRetries int
Maximum number of retries when a 5xx error code is encountered. It can also be sourced from the following environment variable: VAULT_MAX_RETRIES
MaxRetriesCcc int
Maximum number of retries for Client Controlled Consistency related operations
Namespace string
The namespace to use. Available only for Vault Enterprise.
SkipChildToken bool
Set this to true to prevent the creation of ephemeral child token used by this provider.
SkipTlsVerify bool
Set this to true only if the target Vault server is an insecure development instance. It can also be sourced from the following environment variable: VAULT_SKIP_VERIFY
TokenName string
Token name to use for creating the Vault child token.
address string
URL of the root of the target Vault server.
token string
Token to use to authenticate to Vault.
addAddressToEnv string
If true, adds the value of the address argument to the Terraform process environment.
authLogins ProviderAuthLoginArgs[]
Login to vault with an existing auth method using auth//login
caCertDir string
Path to directory containing CA certificate files to validate the server’s certificate.
caCertFile string
Path to a CA certificate file to validate the server’s certificate.
clientAuths ProviderClientAuthArgs[]
Client authentication credentials.
headers ProviderHeaderArgs[]
The headers to send with each Vault request.
maxLeaseTtlSeconds number
Maximum TTL for secret leases requested by this provider. It can also be sourced from the following environment variable: TERRAFORM_VAULT_MAX_TTL
maxRetries number
Maximum number of retries when a 5xx error code is encountered. It can also be sourced from the following environment variable: VAULT_MAX_RETRIES
maxRetriesCcc number
Maximum number of retries for Client Controlled Consistency related operations
namespace string
The namespace to use. Available only for Vault Enterprise.
skipChildToken boolean
Set this to true to prevent the creation of ephemeral child token used by this provider.
skipTlsVerify boolean
Set this to true only if the target Vault server is an insecure development instance. It can also be sourced from the following environment variable: VAULT_SKIP_VERIFY
tokenName string
Token name to use for creating the Vault child token.
address str
URL of the root of the target Vault server.
token str
Token to use to authenticate to Vault.
add_address_to_env str
If true, adds the value of the address argument to the Terraform process environment.
auth_logins Sequence[ProviderAuthLoginArgs]
Login to vault with an existing auth method using auth//login
ca_cert_dir str
Path to directory containing CA certificate files to validate the server’s certificate.
ca_cert_file str
Path to a CA certificate file to validate the server’s certificate.
client_auths Sequence[ProviderClientAuthArgs]
Client authentication credentials.
headers Sequence[ProviderHeaderArgs]
The headers to send with each Vault request.
max_lease_ttl_seconds int
Maximum TTL for secret leases requested by this provider. It can also be sourced from the following environment variable: TERRAFORM_VAULT_MAX_TTL
max_retries int
Maximum number of retries when a 5xx error code is encountered. It can also be sourced from the following environment variable: VAULT_MAX_RETRIES
max_retries_ccc int
Maximum number of retries for Client Controlled Consistency related operations
namespace str
The namespace to use. Available only for Vault Enterprise.
skip_child_token bool
Set this to true to prevent the creation of ephemeral child token used by this provider.
skip_tls_verify bool
Set this to true only if the target Vault server is an insecure development instance. It can also be sourced from the following environment variable: VAULT_SKIP_VERIFY
token_name str
Token name to use for creating the Vault child token.

Outputs

All input properties are implicitly available as output properties. Additionally, the Provider 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 str
The provider-assigned unique ID for this managed resource.

Supporting Types

ProviderAuthLogin

Path string
Method string
Namespace string
Parameters Dictionary<string, string>
Path string
Method string
Namespace string
Parameters map[string]string
path string
method string
namespace string
parameters {[key: string]: string}
path str
method str
namespace str
parameters Mapping[str, str]

ProviderClientAuth

CertFile string
KeyFile string
CertFile string
KeyFile string
certFile string
keyFile string

ProviderHeader

Name string
Value string
Name string
Value string
name string
value string
name str
value str

Package Details

Repository
https://github.com/pulumi/pulumi-vault
License
Apache-2.0
Notes
This Pulumi package is based on the vault Terraform Provider.