跳到主要内容

常用应用属性

DeepSeek V3 中英对照 Common application properties

你可以在 application.properties 文件、application.yml 文件或作为命令行开关来指定各种属性。本附录提供了常见的 Spring Cloud Vault 属性列表,并引用了使用这些属性的底层类。

备注

属性贡献可以来自类路径上的额外 jar 文件,因此你不应将其视为一个详尽的列表。此外,你也可以定义自己的属性。

名称默认描述
spring.cloud.vault.app-id.app-id-pathapp-idAppId 认证后端的挂载路径。
spring.cloud.vault.app-id.network-interface"MAC_ADDRESS" 用户标识机制的网络接口提示。
spring.cloud.vault.app-id.user-idMAC_ADDRESSUserId 机制。可以是 "MAC_ADDRESS"、"IP_ADDRESS"、字符串或类名。
spring.cloud.vault.app-role.app-role-pathapproleAppRole 认证后端的挂载路径。
spring.cloud.vault.app-role.role角色名称,可选,用于拉取模式。
spring.cloud.vault.app-role.role-idRoleId。
spring.cloud.vault.app-role.secret-idSecretId。
spring.cloud.vault.application-nameapplicationAppId 认证的应用名称。
spring.cloud.vault.authenticationtoken
spring.cloud.vault.aws-ec2.aws-ec2-pathaws-ec2AWS-EC2 认证后端的挂载路径。
spring.cloud.vault.aws-ec2.identity-documenthttp://169.254.169.254/latest/dynamic/instance-identity/pkcs7AWS-EC2 PKCS7 身份文档的 URL。
spring.cloud.vault.aws-ec2.nonce用于 AWS-EC2 身份验证的 Nonce。空 nonce 默认为生成 nonce。
spring.cloud.vault.aws-ec2.role角色名称,可选。
spring.cloud.vault.aws-iam.aws-pathawsAWS 认证后端的挂载路径。
spring.cloud.vault.aws-iam.endpoint-uriSTS 服务器 URI。@since 2.2
spring.cloud.vault.aws-iam.region区域名称,可选。如果未设置,将由 AWS 默认值推断。@since 4.0.1
spring.cloud.vault.aws-iam.role角色名称,可选。如果未设置,则默认为友好的IAM名称。
spring.cloud.vault.aws-iam.server-name用于在登录请求的头部设置 {@code X-Vault-AWS-IAM-Server-ID} 头的服务器名称。
spring.cloud.vault.aws.access-key-propertycloud.aws.credentials.accessKey获取到的访问密钥的目标属性。
spring.cloud.vault.aws.backendawsaws 后端路径。
spring.cloud.vault.aws.credential-typeiam-useraws 凭证类型
spring.cloud.vault.aws.enabledfalse启用 aws 后端使用。
spring.cloud.vault.aws.role凭据的角色名称。
spring.cloud.vault.aws.role-arn当保管库角色关联多个角色时,用于 assumed_role 的角色 ARN。@since 3.0.2
spring.cloud.vault.aws.secret-key-propertycloud.aws.credentials.secretKey获取到的密钥的目标属性。
spring.cloud.vault.aws.session-token-key-propertycloud.aws.credentials.sessionToken获取到的密钥的目标属性。
spring.cloud.vault.aws.ttl0STS 令牌的 TTL。默认为 Vault 角色可能设置的 Max 值。同时受限于 AWS 支持的 STS 最大 TTL。@since 3.0.2
spring.cloud.vault.azure-msi.azure-pathazureAzure MSI 认证后端的挂载路径。
spring.cloud.vault.azure-msi.identity-token-service身份令牌服务 URI。@since 3.0
spring.cloud.vault.azure-msi.metadata-service实例元数据服务 URI。@since 3.0
spring.cloud.vault.azure-msi.role角色的名称。
spring.cloud.vault.cassandra.backendcassandraCassandra 后端路径。
spring.cloud.vault.cassandra.enabledfalse启用 Cassandra 后端使用。
spring.cloud.vault.cassandra.password-propertyspring.data.cassandra.password获取密码的目标属性。
spring.cloud.vault.cassandra.role凭据的角色名称。
spring.cloud.vault.cassandra.static-rolefalse启用静态角色使用。@since 2.2
spring.cloud.vault.cassandra.username-propertyspring.data.cassandra.username获取到的用户名的目标属性。
spring.cloud.vault.config.lifecycle.enabledtrue启用生命周期管理。
spring.cloud.vault.config.lifecycle.expiry-threshold过期阈值。在 {@link Lease} 过期前给定的 {@link Duration} 内进行续期。@since 2.2
spring.cloud.vault.config.lifecycle.lease-endpoints设置 {@link LeaseEndpoints} 以委托续租/撤销调用。{@link LeaseEndpoints} 封装了影响续租/撤销端点位置的 Vault 版本差异。对于 Vault 0.8 或更高版本,可以设置为 {@link LeaseEndpoints#SysLeases};对于旧版本(默认),可以设置为 {@link LeaseEndpoints#Legacy}。@since 2.2
spring.cloud.vault.config.lifecycle.lease-strategy设置与 {@link org.springframework.vault.core.lease.SecretLeaseContainer#setLeaseStrategy(LeaseStrategy)} 一起使用的 {@link LeaseStrategy},以在续订错误时保留或丢弃令牌。@since 4.1
spring.cloud.vault.config.lifecycle.min-renewal在续租之前至少需要的时间段。@since 2.2
spring.cloud.vault.config.order0用于设置 {@link org.springframework.core.env.PropertySource} 的优先级。这对于将 Vault 用作其他属性源的覆盖非常有用。@see org.springframework.core.PriorityOrdered
spring.cloud.vault.connection-timeout5000连接超时。
spring.cloud.vault.consul.backendconsulConsul 后端路径。
spring.cloud.vault.consul.enabledfalse启用 consul 后端使用。
spring.cloud.vault.consul.role凭据的角色名称。
spring.cloud.vault.consul.token-propertyspring.cloud.consul.token获取到的令牌的目标属性。
spring.cloud.vault.couchbase.backenddatabaseCouchbase 后端路径。
spring.cloud.vault.couchbase.enabledfalse启用 Couchbase 后端使用。
spring.cloud.vault.couchbase.password-propertyspring.couchbase.password获取密码的目标属性。
spring.cloud.vault.couchbase.role凭据的角色名称。
spring.cloud.vault.couchbase.static-rolefalse启用静态角色使用。
spring.cloud.vault.couchbase.username-propertyspring.couchbase.username获取到的用户名的目标属性。
spring.cloud.vault.database.backenddatabase数据库后端路径。
spring.cloud.vault.database.enabledfalse启用数据库后端使用。
spring.cloud.vault.database.password-propertyspring.datasource.password获取密码的目标属性。
spring.cloud.vault.database.role凭据的角色名称。
spring.cloud.vault.database.static-rolefalse启用静态角色使用。
spring.cloud.vault.database.username-propertyspring.datasource.username获取到的用户名的目标属性。
spring.cloud.vault.databases
spring.cloud.vault.discovery.enabledfalse指示 Vault 服务器发现功能已启用的标志(将通过发现功能查找 Vault 服务器 URL)。
spring.cloud.vault.discovery.service-idvault用于定位 Vault 的服务 ID。
spring.cloud.vault.elasticsearch.backenddatabase数据库后端路径。
spring.cloud.vault.elasticsearch.enabledfalse启用 Elasticsearch 后端使用。
spring.cloud.vault.elasticsearch.password-propertyspring.elasticsearch.rest.password获取密码的目标属性。
spring.cloud.vault.elasticsearch.role凭据的角色名称。
spring.cloud.vault.elasticsearch.static-rolefalse启用静态角色使用。
spring.cloud.vault.elasticsearch.username-propertyspring.elasticsearch.rest.username获取到的用户名的目标属性。
spring.cloud.vault.enabledtrue启用 Vault 配置服务器。
spring.cloud.vault.fail-fastfalse如果无法从 Vault 获取数据,则快速失败。
spring.cloud.vault.gcp-gce.gcp-pathgcpKubernetes 认证后端的挂载路径。
spring.cloud.vault.gcp-gce.role正在尝试登录的角色名称。
spring.cloud.vault.gcp-gce.service-account可选的服务账户 ID。如果未配置,则使用默认 ID。
spring.cloud.vault.gcp-iam.credentials.encoded-keyOAuth2 账户私钥的 JSON 格式内容的 base64 编码。
spring.cloud.vault.gcp-iam.credentials.locationOAuth2 凭据私钥的位置。

由于这是一个资源,私钥可以位于多种位置,例如本地文件系统、类路径、URL 等。

spring.cloud.vault.gcp-iam.gcp-pathgcpKubernetes 认证后端的挂载路径。
spring.cloud.vault.gcp-iam.jwt-validity15mJWT 令牌的有效性。
spring.cloud.vault.gcp-iam.project-id覆盖 GCP 项目 ID。
spring.cloud.vault.gcp-iam.role正在尝试登录的角色名称。
spring.cloud.vault.gcp-iam.service-account-id覆盖 GCP 服务账户 ID。
spring.cloud.vault.github.github-pathgithubGitHub 认证后端的挂载路径。
spring.cloud.vault.github.tokenGitHub 个人访问令牌。
spring.cloud.vault.hostlocalhostVault 服务器主机。
spring.cloud.vault.kubernetes.kubernetes-pathkubernetesKubernetes 认证后端的挂载路径。
spring.cloud.vault.kubernetes.role正在尝试登录的角色名称。
spring.cloud.vault.kubernetes.service-account-token-file/var/run/secrets/kubernetes.io/serviceaccount/token服务账户令牌文件的路径。
spring.cloud.vault.kv.application-nameapplication用于上下文的应用程序名称。
spring.cloud.vault.kv.backendsecret默认后端名称。
spring.cloud.vault.kv.backend-version2键值存储后端版本。目前支持的版本有:
  • 版本 1(无版本控制的键值存储后端)。
  • 版本 2(带版本控制的键值存储后端)。
spring.cloud.vault.kv.default-contextapplication默认上下文的名称。
spring.cloud.vault.kv.enabledtrue启用键值后端。
spring.cloud.vault.kv.profile-separator/配置文件分隔符,用于组合应用程序名称和配置文件。
spring.cloud.vault.kv.profiles活动配置文件列表。@since 3.0
spring.cloud.vault.mongodb.backendmongodbMongoDB 后端路径。
spring.cloud.vault.mongodb.enabledfalse启用 MongoDB 后端使用。
spring.cloud.vault.mongodb.password-propertyspring.data.mongodb.password获取密码的目标属性。
spring.cloud.vault.mongodb.role凭据的角色名称。
spring.cloud.vault.mongodb.static-rolefalse启用静态角色使用。@since 2.2
spring.cloud.vault.mongodb.username-propertyspring.data.mongodb.username获取到的用户名的目标属性。
spring.cloud.vault.mysql.backendmysqlmysql 后端路径。
spring.cloud.vault.mysql.enabledfalse启用 MySQL 后端使用。
spring.cloud.vault.mysql.password-propertyspring.datasource.password获取到的用户名的目标属性。
spring.cloud.vault.mysql.role凭据的角色名称。
spring.cloud.vault.mysql.username-propertyspring.datasource.username获取到的用户名的目标属性。
spring.cloud.vault.namespaceVault 命名空间(需要 Vault Enterprise)。
spring.cloud.vault.pcf.instance-certificate实例证书的路径(PEM格式)。默认为 {@code CF_INSTANCE_CERT} 环境变量。
spring.cloud.vault.pcf.instance-key实例密钥(PEM)的路径。默认为 {@code CF_INSTANCE_KEY} 环境变量。
spring.cloud.vault.pcf.pcf-pathpcfKubernetes 认证后端的挂载路径。
spring.cloud.vault.pcf.role正在尝试登录的角色名称。
spring.cloud.vault.port8200Vault 服务器端口。
spring.cloud.vault.postgresql.backendpostgresqlpostgresql 后端路径。
spring.cloud.vault.postgresql.enabledfalse启用 PostgreSQL 后端使用。
spring.cloud.vault.postgresql.password-propertyspring.datasource.password获取到的用户名的目标属性。
spring.cloud.vault.postgresql.role凭据的角色名称。
spring.cloud.vault.postgresql.username-propertyspring.datasource.username获取到的用户名的目标属性。
spring.cloud.vault.rabbitmq.backendrabbitmqrabbitmq 后端路径。
spring.cloud.vault.rabbitmq.enabledfalse启用 RabbitMQ 后端使用。
spring.cloud.vault.rabbitmq.password-propertyspring.rabbitmq.password获取密码的目标属性。
spring.cloud.vault.rabbitmq.role凭据的角色名称。
spring.cloud.vault.rabbitmq.username-propertyspring.rabbitmq.username获取到的用户名的目标属性。
spring.cloud.vault.reactive.enabledtrue启用反应式发现的标志。
spring.cloud.vault.read-timeout15000读取超时。
spring.cloud.vault.schemehttps协议方案。可以是 "http" 或 "https"。
spring.cloud.vault.session.lifecycle.enabledtrue启用会话生命周期管理。
spring.cloud.vault.session.lifecycle.expiry-threshold7s{@link LoginToken} 的过期阈值。该阈值表示将登录令牌视为有效的最小 TTL 持续时间。TTL 较短的令牌被视为已过期,不再使用。应大于 {@code refreshBeforeExpiry} 以防止令牌过期。
spring.cloud.vault.session.lifecycle.refresh-before-expiry5s在续期 {@link LoginToken} 之前至少需要的时间段。
spring.cloud.vault.ssl.cert-auth-pathcertTLS 证书认证后端的挂载路径。
spring.cloud.vault.ssl.enabled-cipher-suites已启用的 SSL/TLS 密码套件列表。@since 3.0.2
spring.cloud.vault.ssl.enabled-protocols已启用的 SSL/TLS 协议列表。@since 3.0.2
spring.cloud.vault.ssl.key-store存储证书和私钥的信任库。
spring.cloud.vault.ssl.key-store-password用于访问密钥库的密码。
spring.cloud.vault.ssl.key-store-type密钥存储的类型。@since 3.0
spring.cloud.vault.ssl.role正在尝试登录的角色名称。@since 5.0
spring.cloud.vault.ssl.trust-store存储 SSL 证书的信任库。
spring.cloud.vault.ssl.trust-store-password用于访问信任存储的密码。
spring.cloud.vault.ssl.trust-store-type信任存储的类型。@since 3.0
spring.cloud.vault.token静态保险库令牌。如果 {@link #authentication} 为 {@code TOKEN},则必须提供。
spring.cloud.vault.uriVault URI。可以设置协议、主机和端口。