AuthBackendConfig

Manages an Kubernetes auth backend config in a Vault server. See the Vault documentation for more information.

Example Usage

using Pulumi;
using Vault = Pulumi.Vault;

class MyStack : Stack
{
    public MyStack()
    {
        var kubernetes = new Vault.AuthBackend("kubernetes", new Vault.AuthBackendArgs
        {
            Type = "kubernetes",
        });
        var example = new Vault.Kubernetes.AuthBackendConfig("example", new Vault.Kubernetes.AuthBackendConfigArgs
        {
            Backend = kubernetes.Path,
            Issuer = "api",
            KubernetesCaCert = @"-----BEGIN CERTIFICATE-----
example
-----END CERTIFICATE-----
",
            KubernetesHost = "http://example.com:443",
            TokenReviewerJwt = "ZXhhbXBsZQo=",
        });
    }

}

Coming soon!

import pulumi
import pulumi_vault as vault

kubernetes = vault.AuthBackend("kubernetes", type="kubernetes")
example = vault.kubernetes.AuthBackendConfig("example",
    backend=kubernetes.path,
    issuer="api",
    kubernetes_ca_cert="""-----BEGIN CERTIFICATE-----
example
-----END CERTIFICATE-----
""",
    kubernetes_host="http://example.com:443",
    token_reviewer_jwt="ZXhhbXBsZQo=")

import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";

const kubernetes = new vault.AuthBackend("kubernetes", {
    type: "kubernetes",
});
const example = new vault.kubernetes.AuthBackendConfig("example", {
    backend: kubernetes.path,
    issuer: "api",
    kubernetesCaCert: `-----BEGIN CERTIFICATE-----
example
-----END CERTIFICATE-----`,
    kubernetesHost: "http://example.com:443",
    tokenReviewerJwt: "ZXhhbXBsZQo=",
});

Create a AuthBackendConfig Resource

new AuthBackendConfig(name: string, args: AuthBackendConfigArgs, opts?: CustomResourceOptions);

def AuthBackendConfig(resource_name, opts=None, backend=None, issuer=None, kubernetes_ca_cert=None, kubernetes_host=None, pem_keys=None, token_reviewer_jwt=None, __props__=None);

func NewAuthBackendConfig(ctx *Context, name string, args AuthBackendConfigArgs, opts ...ResourceOption) (*AuthBackendConfig, error)

public AuthBackendConfig(string name, AuthBackendConfigArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args AuthBackendConfigArgs: 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 AuthBackendConfigArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

AuthBackendConfig Resource Properties

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

Inputs

The AuthBackendConfig resource accepts the following input properties:

KubernetesHost string: Host must be a host string, a host:port pair, or a URL to the base of the Kubernetes API server.
Backend string: Unique name of the kubernetes backend to configure.
Issuer string: Optional JWT issuer. If no issuer is specified, kubernetes.io/serviceaccount will be used as the default issuer.
KubernetesCaCert string: PEM encoded CA cert for use by the TLS client used to talk with the Kubernetes API.
PemKeys List<string>: List of PEM-formatted public keys or certificates used to verify the signatures of Kubernetes service account JWTs. If a certificate is given, its public key will be extracted. Not every installation of Kubernetes exposes these keys.
TokenReviewerJwt string: A service account JWT used to access the TokenReview API to validate other JWTs during login. If not set the JWT used for login will be used to access the API.

KubernetesHost string: Host must be a host string, a host:port pair, or a URL to the base of the Kubernetes API server.
Backend string: Unique name of the kubernetes backend to configure.
Issuer string: Optional JWT issuer. If no issuer is specified, kubernetes.io/serviceaccount will be used as the default issuer.
KubernetesCaCert string: PEM encoded CA cert for use by the TLS client used to talk with the Kubernetes API.
PemKeys []string: List of PEM-formatted public keys or certificates used to verify the signatures of Kubernetes service account JWTs. If a certificate is given, its public key will be extracted. Not every installation of Kubernetes exposes these keys.
TokenReviewerJwt string: A service account JWT used to access the TokenReview API to validate other JWTs during login. If not set the JWT used for login will be used to access the API.

kubernetesHost string: Host must be a host string, a host:port pair, or a URL to the base of the Kubernetes API server.
backend string: Unique name of the kubernetes backend to configure.
issuer string: Optional JWT issuer. If no issuer is specified, kubernetes.io/serviceaccount will be used as the default issuer.
kubernetesCaCert string: PEM encoded CA cert for use by the TLS client used to talk with the Kubernetes API.
pemKeys string[]: List of PEM-formatted public keys or certificates used to verify the signatures of Kubernetes service account JWTs. If a certificate is given, its public key will be extracted. Not every installation of Kubernetes exposes these keys.
tokenReviewerJwt string: A service account JWT used to access the TokenReview API to validate other JWTs during login. If not set the JWT used for login will be used to access the API.

kubernetes_host str: Host must be a host string, a host:port pair, or a URL to the base of the Kubernetes API server.
backend str: Unique name of the kubernetes backend to configure.
issuer str: Optional JWT issuer. If no issuer is specified, kubernetes.io/serviceaccount will be used as the default issuer.
kubernetes_ca_cert str: PEM encoded CA cert for use by the TLS client used to talk with the Kubernetes API.
pem_keys List[str]: List of PEM-formatted public keys or certificates used to verify the signatures of Kubernetes service account JWTs. If a certificate is given, its public key will be extracted. Not every installation of Kubernetes exposes these keys.
token_reviewer_jwt str: A service account JWT used to access the TokenReview API to validate other JWTs during login. If not set the JWT used for login will be used to access the API.

Outputs

All input properties are implicitly available as output properties. Additionally, the AuthBackendConfig 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.

Look up an Existing AuthBackendConfig Resource

Get an existing AuthBackendConfig 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?: AuthBackendConfigState, opts?: CustomResourceOptions): AuthBackendConfig

static get(resource_name, id, opts=None, backend=None, issuer=None, kubernetes_ca_cert=None, kubernetes_host=None, pem_keys=None, token_reviewer_jwt=None, __props__=None);

func GetAuthBackendConfig(ctx *Context, name string, id IDInput, state *AuthBackendConfigState, opts ...ResourceOption) (*AuthBackendConfig, error)

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

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.

The following state arguments are supported:

Backend string: Unique name of the kubernetes backend to configure.
Issuer string: Optional JWT issuer. If no issuer is specified, kubernetes.io/serviceaccount will be used as the default issuer.
KubernetesCaCert string: PEM encoded CA cert for use by the TLS client used to talk with the Kubernetes API.
KubernetesHost string: Host must be a host string, a host:port pair, or a URL to the base of the Kubernetes API server.
PemKeys List<string>: List of PEM-formatted public keys or certificates used to verify the signatures of Kubernetes service account JWTs. If a certificate is given, its public key will be extracted. Not every installation of Kubernetes exposes these keys.
TokenReviewerJwt string: A service account JWT used to access the TokenReview API to validate other JWTs during login. If not set the JWT used for login will be used to access the API.

Backend string: Unique name of the kubernetes backend to configure.
Issuer string: Optional JWT issuer. If no issuer is specified, kubernetes.io/serviceaccount will be used as the default issuer.
KubernetesCaCert string: PEM encoded CA cert for use by the TLS client used to talk with the Kubernetes API.
KubernetesHost string: Host must be a host string, a host:port pair, or a URL to the base of the Kubernetes API server.
PemKeys []string: List of PEM-formatted public keys or certificates used to verify the signatures of Kubernetes service account JWTs. If a certificate is given, its public key will be extracted. Not every installation of Kubernetes exposes these keys.
TokenReviewerJwt string: A service account JWT used to access the TokenReview API to validate other JWTs during login. If not set the JWT used for login will be used to access the API.

backend string: Unique name of the kubernetes backend to configure.
issuer string: Optional JWT issuer. If no issuer is specified, kubernetes.io/serviceaccount will be used as the default issuer.
kubernetesCaCert string: PEM encoded CA cert for use by the TLS client used to talk with the Kubernetes API.
kubernetesHost string: Host must be a host string, a host:port pair, or a URL to the base of the Kubernetes API server.
pemKeys string[]: List of PEM-formatted public keys or certificates used to verify the signatures of Kubernetes service account JWTs. If a certificate is given, its public key will be extracted. Not every installation of Kubernetes exposes these keys.
tokenReviewerJwt string: A service account JWT used to access the TokenReview API to validate other JWTs during login. If not set the JWT used for login will be used to access the API.

backend str: Unique name of the kubernetes backend to configure.
issuer str: Optional JWT issuer. If no issuer is specified, kubernetes.io/serviceaccount will be used as the default issuer.
kubernetes_ca_cert str: PEM encoded CA cert for use by the TLS client used to talk with the Kubernetes API.
kubernetes_host str: Host must be a host string, a host:port pair, or a URL to the base of the Kubernetes API server.
pem_keys List[str]: List of PEM-formatted public keys or certificates used to verify the signatures of Kubernetes service account JWTs. If a certificate is given, its public key will be extracted. Not every installation of Kubernetes exposes these keys.
token_reviewer_jwt str: A service account JWT used to access the TokenReview API to validate other JWTs during login. If not set the JWT used for login will be used to access the API.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud