permalink |
---|
/provider/ |
provider
represents the vault
Terraform provider config.
This package contains functions and utilities for setting up the provider using Jsonnet code.
fn new()
fn newAttrs()
obj auth_login
obj auth_login_aws
obj auth_login_azure
obj auth_login_cert
obj auth_login_gcp
obj auth_login_jwt
obj auth_login_kerberos
obj auth_login_oci
obj auth_login_oidc
obj auth_login_radius
obj auth_login_token_file
obj auth_login_userpass
obj client_auth
obj headers
new()
vault.provider.new
injects a new vault
Terraform provider
block into the root module document.
Optionally, this inserts the provider into the
required_providers terraform
sub block if
the src
and/or version
parameters are set.
Args:
add_address_to_env
(string
): If true, adds the value of theaddress
argument to the Terraform process environment. Whennull
, theadd_address_to_env
field will be omitted from the resulting object.address
(string
): URL of the root of the target Vault server.ca_cert_dir
(string
): Path to directory containing CA certificate files to validate the server's certificate. Whennull
, theca_cert_dir
field will be omitted from the resulting object.ca_cert_file
(string
): Path to a CA certificate file to validate the server's certificate. Whennull
, theca_cert_file
field will be omitted from the resulting object.max_lease_ttl_seconds
(number
): Maximum TTL for secret leases requested by this provider. Whennull
, themax_lease_ttl_seconds
field will be omitted from the resulting object.max_retries
(number
): Maximum number of retries when a 5xx error code is encountered. Whennull
, themax_retries
field will be omitted from the resulting object.max_retries_ccc
(number
): Maximum number of retries for Client Controlled Consistency related operations Whennull
, themax_retries_ccc
field will be omitted from the resulting object.namespace
(string
): The namespace to use. Available only for Vault Enterprise. Whennull
, thenamespace
field will be omitted from the resulting object.set_namespace_from_token
(bool
): In the case where the Vault token is for a specific namespace and the provider namespace is not configured, use the token namespace as the root namespace for all resources. Whennull
, theset_namespace_from_token
field will be omitted from the resulting object.skip_child_token
(bool
): Set this to true to prevent the creation of ephemeral child token used by this provider. Whennull
, theskip_child_token
field will be omitted from the resulting object.skip_get_vault_version
(bool
): Skip the dynamic fetching of the Vault server version. Whennull
, theskip_get_vault_version
field will be omitted from the resulting object.skip_tls_verify
(bool
): Set this to true only if the target Vault server is an insecure development instance. Whennull
, theskip_tls_verify
field will be omitted from the resulting object.tls_server_name
(string
): Name to use as the SNI host when connecting via TLS. Whennull
, thetls_server_name
field will be omitted from the resulting object.token
(string
): Token to use to authenticate to Vault. Whennull
, thetoken
field will be omitted from the resulting object.token_name
(string
): Token name to use for creating the Vault child token. Whennull
, thetoken_name
field will be omitted from the resulting object.vault_version_override
(string
): Override the Vault server version, which is normally determined dynamically from the target Vault server Whennull
, thevault_version_override
field will be omitted from the resulting object.auth_login
(list[obj]
): Login to vault with an existing auth method using auth/<mount>/login Whennull
, theauth_login
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login.new constructor.auth_login_aws
(list[obj]
): Login to vault using the AWS method Whennull
, theauth_login_aws
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_aws.new constructor.auth_login_azure
(list[obj]
): Login to vault using the azure method Whennull
, theauth_login_azure
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_azure.new constructor.auth_login_cert
(list[obj]
): Login to vault using the cert method Whennull
, theauth_login_cert
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_cert.new constructor.auth_login_gcp
(list[obj]
): Login to vault using the gcp method Whennull
, theauth_login_gcp
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_gcp.new constructor.auth_login_jwt
(list[obj]
): Login to vault using the jwt method Whennull
, theauth_login_jwt
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_jwt.new constructor.auth_login_kerberos
(list[obj]
): Login to vault using the kerberos method Whennull
, theauth_login_kerberos
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_kerberos.new constructor.auth_login_oci
(list[obj]
): Login to vault using the OCI method Whennull
, theauth_login_oci
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_oci.new constructor.auth_login_oidc
(list[obj]
): Login to vault using the oidc method Whennull
, theauth_login_oidc
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_oidc.new constructor.auth_login_radius
(list[obj]
): Login to vault using the radius method Whennull
, theauth_login_radius
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_radius.new constructor.auth_login_token_file
(list[obj]
): Login to vault using Whennull
, theauth_login_token_file
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_token_file.new constructor.auth_login_userpass
(list[obj]
): Login to vault using the userpass method Whennull
, theauth_login_userpass
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_userpass.new constructor.client_auth
(list[obj]
): Client authentication credentials. Whennull
, theclient_auth
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.client_auth.new constructor.headers
(list[obj]
): The headers to send with each Vault request. Whennull
, theheaders
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.headers.new constructor.alias
(string
): The provideralias
to set for this instance of the provider block. Whennull
, thealias
field will be omitted from the resulting provider block.src
(string
): The providersource
to set on the resultingrequired_providers
block. Ifsrc
orversion
is set and is notnull
, arequired_providers
block and entry for the provider will be injected into the document.version
(string
): The providerversion
to set on the resultingrequired_providers
block. Ifsrc
orversion
is set and is notnull
, arequired_providers
block and entry for the provider will be injected into the document.
Returns:
- A mixin object that injects the new provider (and optionally,
required_providers
block) into the root Terraform configuration.
newAttrs()
vault.provider.
constructs a new object with attributes and blocks configured for the vault
Terraform provider
.
Unlike vault.provider.new, this function will not inject the provider
block into the root Terraform document. Instead, this must be passed in as the attrs
argument for the
tf.withProvider function to build a complete block.
This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to injecting into a complete block.
Args:
add_address_to_env
(string
): If true, adds the value of theaddress
argument to the Terraform process environment. Whennull
, theadd_address_to_env
field will be omitted from the resulting object.address
(string
): URL of the root of the target Vault server.ca_cert_dir
(string
): Path to directory containing CA certificate files to validate the server's certificate. Whennull
, theca_cert_dir
field will be omitted from the resulting object.ca_cert_file
(string
): Path to a CA certificate file to validate the server's certificate. Whennull
, theca_cert_file
field will be omitted from the resulting object.max_lease_ttl_seconds
(number
): Maximum TTL for secret leases requested by this provider. Whennull
, themax_lease_ttl_seconds
field will be omitted from the resulting object.max_retries
(number
): Maximum number of retries when a 5xx error code is encountered. Whennull
, themax_retries
field will be omitted from the resulting object.max_retries_ccc
(number
): Maximum number of retries for Client Controlled Consistency related operations Whennull
, themax_retries_ccc
field will be omitted from the resulting object.namespace
(string
): The namespace to use. Available only for Vault Enterprise. Whennull
, thenamespace
field will be omitted from the resulting object.set_namespace_from_token
(bool
): In the case where the Vault token is for a specific namespace and the provider namespace is not configured, use the token namespace as the root namespace for all resources. Whennull
, theset_namespace_from_token
field will be omitted from the resulting object.skip_child_token
(bool
): Set this to true to prevent the creation of ephemeral child token used by this provider. Whennull
, theskip_child_token
field will be omitted from the resulting object.skip_get_vault_version
(bool
): Skip the dynamic fetching of the Vault server version. Whennull
, theskip_get_vault_version
field will be omitted from the resulting object.skip_tls_verify
(bool
): Set this to true only if the target Vault server is an insecure development instance. Whennull
, theskip_tls_verify
field will be omitted from the resulting object.tls_server_name
(string
): Name to use as the SNI host when connecting via TLS. Whennull
, thetls_server_name
field will be omitted from the resulting object.token
(string
): Token to use to authenticate to Vault. Whennull
, thetoken
field will be omitted from the resulting object.token_name
(string
): Token name to use for creating the Vault child token. Whennull
, thetoken_name
field will be omitted from the resulting object.vault_version_override
(string
): Override the Vault server version, which is normally determined dynamically from the target Vault server Whennull
, thevault_version_override
field will be omitted from the resulting object.auth_login
(list[obj]
): Login to vault with an existing auth method using auth/<mount>/login Whennull
, theauth_login
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login.new constructor.auth_login_aws
(list[obj]
): Login to vault using the AWS method Whennull
, theauth_login_aws
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_aws.new constructor.auth_login_azure
(list[obj]
): Login to vault using the azure method Whennull
, theauth_login_azure
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_azure.new constructor.auth_login_cert
(list[obj]
): Login to vault using the cert method Whennull
, theauth_login_cert
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_cert.new constructor.auth_login_gcp
(list[obj]
): Login to vault using the gcp method Whennull
, theauth_login_gcp
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_gcp.new constructor.auth_login_jwt
(list[obj]
): Login to vault using the jwt method Whennull
, theauth_login_jwt
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_jwt.new constructor.auth_login_kerberos
(list[obj]
): Login to vault using the kerberos method Whennull
, theauth_login_kerberos
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_kerberos.new constructor.auth_login_oci
(list[obj]
): Login to vault using the OCI method Whennull
, theauth_login_oci
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_oci.new constructor.auth_login_oidc
(list[obj]
): Login to vault using the oidc method Whennull
, theauth_login_oidc
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_oidc.new constructor.auth_login_radius
(list[obj]
): Login to vault using the radius method Whennull
, theauth_login_radius
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_radius.new constructor.auth_login_token_file
(list[obj]
): Login to vault using Whennull
, theauth_login_token_file
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_token_file.new constructor.auth_login_userpass
(list[obj]
): Login to vault using the userpass method Whennull
, theauth_login_userpass
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.auth_login_userpass.new constructor.client_auth
(list[obj]
): Client authentication credentials. Whennull
, theclient_auth
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.client_auth.new constructor.headers
(list[obj]
): The headers to send with each Vault request. Whennull
, theheaders
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the vault.provider.headers.new constructor.
Returns:
- An attribute object that can be used with tf.withProvider to construct a new
vault
provider configuration into the root Terraform configuration.
new()
vault.auth_login.new
constructs a new object with attributes and blocks configured for the auth_login
Terraform sub block.
Args:
method
(string
): Set themethod
field on the resulting object. Whennull
, themethod
field will be omitted from the resulting object.namespace
(string
): The authentication engine's namespace. Conflicts with use_root_namespace Whennull
, thenamespace
field will be omitted from the resulting object.parameters
(obj
): Set theparameters
field on the resulting object. Whennull
, theparameters
field will be omitted from the resulting object.path
(string
): Set thepath
field on the resulting object.use_root_namespace
(bool
): Authenticate to the root Vault namespace. Conflicts with namespace Whennull
, theuse_root_namespace
field will be omitted from the resulting object.
Returns:
- An attribute object that represents the
auth_login
sub block.
new()
vault.auth_login_aws.new
constructs a new object with attributes and blocks configured for the auth_login_aws
Terraform sub block.
Args:
aws_access_key_id
(string
): The AWS access key ID. Whennull
, theaws_access_key_id
field will be omitted from the resulting object.aws_iam_endpoint
(string
): The IAM endpoint URL. Whennull
, theaws_iam_endpoint
field will be omitted from the resulting object.aws_profile
(string
): The name of the AWS profile. Whennull
, theaws_profile
field will be omitted from the resulting object.aws_region
(string
): The AWS region. Whennull
, theaws_region
field will be omitted from the resulting object.aws_role_arn
(string
): The ARN of the AWS Role to assume.Used during STS AssumeRole Whennull
, theaws_role_arn
field will be omitted from the resulting object.aws_role_session_name
(string
): Specifies the name to attach to the AWS role session. Used during STS AssumeRole Whennull
, theaws_role_session_name
field will be omitted from the resulting object.aws_secret_access_key
(string
): The AWS secret access key. Whennull
, theaws_secret_access_key
field will be omitted from the resulting object.aws_session_token
(string
): The AWS session token. Whennull
, theaws_session_token
field will be omitted from the resulting object.aws_shared_credentials_file
(string
): Path to the AWS shared credentials file. Whennull
, theaws_shared_credentials_file
field will be omitted from the resulting object.aws_sts_endpoint
(string
): The STS endpoint URL. Whennull
, theaws_sts_endpoint
field will be omitted from the resulting object.aws_web_identity_token_file
(string
): Path to the file containing an OAuth 2.0 access token or OpenID Connect ID token. Whennull
, theaws_web_identity_token_file
field will be omitted from the resulting object.header_value
(string
): The Vault header value to include in the STS signing request. Whennull
, theheader_value
field will be omitted from the resulting object.mount
(string
): The path where the authentication engine is mounted. Whennull
, themount
field will be omitted from the resulting object.namespace
(string
): The authentication engine's namespace. Conflicts with use_root_namespace Whennull
, thenamespace
field will be omitted from the resulting object.role
(string
): The Vault role to use when logging into Vault.use_root_namespace
(bool
): Authenticate to the root Vault namespace. Conflicts with namespace Whennull
, theuse_root_namespace
field will be omitted from the resulting object.
Returns:
- An attribute object that represents the
auth_login_aws
sub block.
new()
vault.auth_login_azure.new
constructs a new object with attributes and blocks configured for the auth_login_azure
Terraform sub block.
Args:
client_id
(string
): The identity's client ID. Whennull
, theclient_id
field will be omitted from the resulting object.jwt
(string
): A signed JSON Web Token. If not specified on will be created automatically Whennull
, thejwt
field will be omitted from the resulting object.mount
(string
): The path where the authentication engine is mounted. Whennull
, themount
field will be omitted from the resulting object.namespace
(string
): The authentication engine's namespace. Conflicts with use_root_namespace Whennull
, thenamespace
field will be omitted from the resulting object.resource_group_name
(string
): The resource group for the machine that generated the MSI token. This information can be obtained through instance metadata.role
(string
): Name of the login role.scope
(string
): The scopes to include in the token request. Whennull
, thescope
field will be omitted from the resulting object.subscription_id
(string
): The subscription ID for the machine that generated the MSI token. This information can be obtained through instance metadata.tenant_id
(string
): Provides the tenant ID to use in a multi-tenant authentication scenario. Whennull
, thetenant_id
field will be omitted from the resulting object.use_root_namespace
(bool
): Authenticate to the root Vault namespace. Conflicts with namespace Whennull
, theuse_root_namespace
field will be omitted from the resulting object.vm_name
(string
): The virtual machine name for the machine that generated the MSI token. This information can be obtained through instance metadata. Whennull
, thevm_name
field will be omitted from the resulting object.vmss_name
(string
): The virtual machine scale set name for the machine that generated the MSI token. This information can be obtained through instance metadata. Whennull
, thevmss_name
field will be omitted from the resulting object.
Returns:
- An attribute object that represents the
auth_login_azure
sub block.
new()
vault.auth_login_cert.new
constructs a new object with attributes and blocks configured for the auth_login_cert
Terraform sub block.
Args:
cert_file
(string
): Path to a file containing the client certificate.key_file
(string
): Path to a file containing the private key that the certificate was issued for.mount
(string
): The path where the authentication engine is mounted. Whennull
, themount
field will be omitted from the resulting object.name
(string
): Name of the certificate's role Whennull
, thename
field will be omitted from the resulting object.namespace
(string
): The authentication engine's namespace. Conflicts with use_root_namespace Whennull
, thenamespace
field will be omitted from the resulting object.use_root_namespace
(bool
): Authenticate to the root Vault namespace. Conflicts with namespace Whennull
, theuse_root_namespace
field will be omitted from the resulting object.
Returns:
- An attribute object that represents the
auth_login_cert
sub block.
new()
vault.auth_login_gcp.new
constructs a new object with attributes and blocks configured for the auth_login_gcp
Terraform sub block.
Args:
credentials
(string
): Path to the Google Cloud credentials file. Whennull
, thecredentials
field will be omitted from the resulting object.jwt
(string
): A signed JSON Web Token. Whennull
, thejwt
field will be omitted from the resulting object.mount
(string
): The path where the authentication engine is mounted. Whennull
, themount
field will be omitted from the resulting object.namespace
(string
): The authentication engine's namespace. Conflicts with use_root_namespace Whennull
, thenamespace
field will be omitted from the resulting object.role
(string
): Name of the login role.service_account
(string
): IAM service account. Whennull
, theservice_account
field will be omitted from the resulting object.use_root_namespace
(bool
): Authenticate to the root Vault namespace. Conflicts with namespace Whennull
, theuse_root_namespace
field will be omitted from the resulting object.
Returns:
- An attribute object that represents the
auth_login_gcp
sub block.
new()
vault.auth_login_jwt.new
constructs a new object with attributes and blocks configured for the auth_login_jwt
Terraform sub block.
Args:
jwt
(string
): A signed JSON Web Token.mount
(string
): The path where the authentication engine is mounted. Whennull
, themount
field will be omitted from the resulting object.namespace
(string
): The authentication engine's namespace. Conflicts with use_root_namespace Whennull
, thenamespace
field will be omitted from the resulting object.role
(string
): Name of the login role.use_root_namespace
(bool
): Authenticate to the root Vault namespace. Conflicts with namespace Whennull
, theuse_root_namespace
field will be omitted from the resulting object.
Returns:
- An attribute object that represents the
auth_login_jwt
sub block.
new()
vault.auth_login_kerberos.new
constructs a new object with attributes and blocks configured for the auth_login_kerberos
Terraform sub block.
Args:
disable_fast_negotiation
(bool
): Disable the Kerberos FAST negotiation. Whennull
, thedisable_fast_negotiation
field will be omitted from the resulting object.keytab_path
(string
): The Kerberos keytab file containing the entry of the login entity. Whennull
, thekeytab_path
field will be omitted from the resulting object.krb5conf_path
(string
): A valid Kerberos configuration file e.g. /etc/krb5.conf. Whennull
, thekrb5conf_path
field will be omitted from the resulting object.mount
(string
): The path where the authentication engine is mounted. Whennull
, themount
field will be omitted from the resulting object.namespace
(string
): The authentication engine's namespace. Conflicts with use_root_namespace Whennull
, thenamespace
field will be omitted from the resulting object.realm
(string
): The Kerberos server's authoritative authentication domain Whennull
, therealm
field will be omitted from the resulting object.remove_instance_name
(bool
): Strip the host from the username found in the keytab. Whennull
, theremove_instance_name
field will be omitted from the resulting object.service
(string
): The service principle name. Whennull
, theservice
field will be omitted from the resulting object.token
(string
): Simple and Protected GSSAPI Negotiation Mechanism (SPNEGO) token Whennull
, thetoken
field will be omitted from the resulting object.use_root_namespace
(bool
): Authenticate to the root Vault namespace. Conflicts with namespace Whennull
, theuse_root_namespace
field will be omitted from the resulting object.username
(string
): The username to login into Kerberos with. Whennull
, theusername
field will be omitted from the resulting object.
Returns:
- An attribute object that represents the
auth_login_kerberos
sub block.
new()
vault.auth_login_oci.new
constructs a new object with attributes and blocks configured for the auth_login_oci
Terraform sub block.
Args:
auth_type
(string
): Authentication type to use when getting OCI credentials.mount
(string
): The path where the authentication engine is mounted. Whennull
, themount
field will be omitted from the resulting object.namespace
(string
): The authentication engine's namespace. Conflicts with use_root_namespace Whennull
, thenamespace
field will be omitted from the resulting object.role
(string
): Name of the login role.use_root_namespace
(bool
): Authenticate to the root Vault namespace. Conflicts with namespace Whennull
, theuse_root_namespace
field will be omitted from the resulting object.
Returns:
- An attribute object that represents the
auth_login_oci
sub block.
new()
vault.auth_login_oidc.new
constructs a new object with attributes and blocks configured for the auth_login_oidc
Terraform sub block.
Args:
callback_address
(string
): The callback address. Must be a valid URI without the path. Whennull
, thecallback_address
field will be omitted from the resulting object.callback_listener_address
(string
): The callback listener's address. Must be a valid URI without the path. Whennull
, thecallback_listener_address
field will be omitted from the resulting object.mount
(string
): The path where the authentication engine is mounted. Whennull
, themount
field will be omitted from the resulting object.namespace
(string
): The authentication engine's namespace. Conflicts with use_root_namespace Whennull
, thenamespace
field will be omitted from the resulting object.role
(string
): Name of the login role.use_root_namespace
(bool
): Authenticate to the root Vault namespace. Conflicts with namespace Whennull
, theuse_root_namespace
field will be omitted from the resulting object.
Returns:
- An attribute object that represents the
auth_login_oidc
sub block.
new()
vault.auth_login_radius.new
constructs a new object with attributes and blocks configured for the auth_login_radius
Terraform sub block.
Args:
mount
(string
): The path where the authentication engine is mounted. Whennull
, themount
field will be omitted from the resulting object.namespace
(string
): The authentication engine's namespace. Conflicts with use_root_namespace Whennull
, thenamespace
field will be omitted from the resulting object.password
(string
): The Radius password for username.use_root_namespace
(bool
): Authenticate to the root Vault namespace. Conflicts with namespace Whennull
, theuse_root_namespace
field will be omitted from the resulting object.username
(string
): The Radius username.
Returns:
- An attribute object that represents the
auth_login_radius
sub block.
new()
vault.auth_login_token_file.new
constructs a new object with attributes and blocks configured for the auth_login_token_file
Terraform sub block.
Args:
filename
(string
): The name of a file containing a single line that is a valid Vault tokennamespace
(string
): The authentication engine's namespace. Conflicts with use_root_namespace Whennull
, thenamespace
field will be omitted from the resulting object.use_root_namespace
(bool
): Authenticate to the root Vault namespace. Conflicts with namespace Whennull
, theuse_root_namespace
field will be omitted from the resulting object.
Returns:
- An attribute object that represents the
auth_login_token_file
sub block.
new()
vault.auth_login_userpass.new
constructs a new object with attributes and blocks configured for the auth_login_userpass
Terraform sub block.
Args:
mount
(string
): The path where the authentication engine is mounted. Whennull
, themount
field will be omitted from the resulting object.namespace
(string
): The authentication engine's namespace. Conflicts with use_root_namespace Whennull
, thenamespace
field will be omitted from the resulting object.password
(string
): Login with password Whennull
, thepassword
field will be omitted from the resulting object.password_file
(string
): Login with password from a file Whennull
, thepassword_file
field will be omitted from the resulting object.use_root_namespace
(bool
): Authenticate to the root Vault namespace. Conflicts with namespace Whennull
, theuse_root_namespace
field will be omitted from the resulting object.username
(string
): Login with username
Returns:
- An attribute object that represents the
auth_login_userpass
sub block.
new()
vault.client_auth.new
constructs a new object with attributes and blocks configured for the client_auth
Terraform sub block.
Args:
cert_file
(string
): Path to a file containing the client certificate. Whennull
, thecert_file
field will be omitted from the resulting object.key_file
(string
): Path to a file containing the private key that the certificate was issued for. Whennull
, thekey_file
field will be omitted from the resulting object.
Returns:
- An attribute object that represents the
client_auth
sub block.
new()
vault.headers.new
constructs a new object with attributes and blocks configured for the headers
Terraform sub block.
Args:
name
(string
): The header namevalue
(string
): The header value
Returns:
- An attribute object that represents the
headers
sub block.