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);def Provider(resource_name, opts=None, add_address_to_env=None, address=None, auth_logins=None, ca_cert_dir=None, ca_cert_file=None, client_auths=None, headers=None, max_lease_ttl_seconds=None, max_retries=None, namespace=None, skip_tls_verify=None, token=None, token_name=None, __props__=None);func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)public Provider(string name, ProviderArgs? args = null, 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.
- opts ResourceOptions
- A bag of options that control this 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 Programming Model docs.
Inputs
The Provider resource accepts the following input properties:
- Add
Address stringTo Env If true, adds the value of the
addressargument to the Terraform process environment.- Address string
URL of the root of the target Vault server.
- Auth
Logins List<ProviderAuth Login Args> Login to vault with an existing auth method using auth/
/login - Ca
Cert stringDir Path to directory containing CA certificate files to validate the server’s certificate.
- Ca
Cert stringFile Path to a CA certificate file to validate the server’s certificate.
- Client
Auths List<ProviderClient Auth Args> Client authentication credentials.
- Headers
List<Provider
Header Args> The headers to send with each Vault request.
- Max
Lease intTtl Seconds Maximum TTL for secret leases requested by this provider
- Max
Retries int Maximum number of retries when a 5xx error code is encountered.
- Namespace string
The namespace to use. Available only for Vault Enterprise
- Skip
Tls boolVerify Set this to true only if the target Vault server is an insecure development instance.
- Token string
Token to use to authenticate to Vault.
- Token
Name string Token name to use for creating the Vault child token.
- Add
Address stringTo Env If true, adds the value of the
addressargument to the Terraform process environment.- Address string
URL of the root of the target Vault server.
- Auth
Logins []ProviderAuth Login Login to vault with an existing auth method using auth/
/login - Ca
Cert stringDir Path to directory containing CA certificate files to validate the server’s certificate.
- Ca
Cert stringFile Path to a CA certificate file to validate the server’s certificate.
- Client
Auths []ProviderClient Auth Client authentication credentials.
- Headers
[]Provider
Header The headers to send with each Vault request.
- Max
Lease intTtl Seconds Maximum TTL for secret leases requested by this provider
- Max
Retries int Maximum number of retries when a 5xx error code is encountered.
- Namespace string
The namespace to use. Available only for Vault Enterprise
- Skip
Tls boolVerify Set this to true only if the target Vault server is an insecure development instance.
- Token string
Token to use to authenticate to Vault.
- Token
Name string Token name to use for creating the Vault child token.
- add
Address stringTo Env If true, adds the value of the
addressargument to the Terraform process environment.- address string
URL of the root of the target Vault server.
- auth
Logins ProviderAuth Login[] Login to vault with an existing auth method using auth/
/login - ca
Cert stringDir Path to directory containing CA certificate files to validate the server’s certificate.
- ca
Cert stringFile Path to a CA certificate file to validate the server’s certificate.
- client
Auths ProviderClient Auth[] Client authentication credentials.
- headers
Provider
Header[] The headers to send with each Vault request.
- max
Lease numberTtl Seconds Maximum TTL for secret leases requested by this provider
- max
Retries number Maximum number of retries when a 5xx error code is encountered.
- namespace string
The namespace to use. Available only for Vault Enterprise
- skip
Tls booleanVerify Set this to true only if the target Vault server is an insecure development instance.
- token string
Token to use to authenticate to Vault.
- token
Name string Token name to use for creating the Vault child token.
- add_
address_ strto_ env If true, adds the value of the
addressargument to the Terraform process environment.- address str
URL of the root of the target Vault server.
- auth_
logins List[ProviderAuth Login] Login to vault with an existing auth method using auth/
/login - ca_
cert_ strdir Path to directory containing CA certificate files to validate the server’s certificate.
- ca_
cert_ strfile Path to a CA certificate file to validate the server’s certificate.
- client_
auths List[ProviderClient Auth] Client authentication credentials.
- headers
List[Provider
Header] The headers to send with each Vault request.
- max_
lease_ floatttl_ seconds Maximum TTL for secret leases requested by this provider
- max_
retries float Maximum number of retries when a 5xx error code is encountered.
- namespace str
The namespace to use. Available only for Vault Enterprise
- skip_
tls_ boolverify Set this to true only if the target Vault server is an insecure development instance.
- token str
Token to use to authenticate to Vault.
- 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:
Supporting Types
ProviderAuthLogin
See the input API doc for this type.
See the input API doc for this type.
See the input API doc for this type.
- Path string
- Namespace string
- Parameters Dictionary<string, string>
- Path string
- Namespace string
- Parameters map[string]string
- path string
- namespace string
- parameters {[key: string]: string}
- path str
- namespace str
- parameters Dict[str, str]
ProviderClientAuth
See the input API doc for this type.
See the input API doc for this type.
See the input API doc for this type.
ProviderHeader
See the input API doc for this type.
See the input API doc for this type.
See the input API doc for this type.
Package Details
- Repository
- https://github.com/pulumi/pulumi-vault
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
vaultTerraform Provider.