AuthBackend

Provides a resource to configure the GCP auth backend within Vault.

Example Usage

using System.IO;
using Pulumi;
using Vault = Pulumi.Vault;

class MyStack : Stack
{
    public MyStack()
    {
        var gcp = new Vault.Gcp.AuthBackend("gcp", new Vault.Gcp.AuthBackendArgs
        {
            Credentials = File.ReadAllText("vault-gcp-credentials.json"),
        });
    }

}

Coming soon!

import pulumi
import pulumi_vault as vault

gcp = vault.gcp.AuthBackend("gcp", credentials=(lambda path: open(path).read())("vault-gcp-credentials.json"))
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";
import * from "fs";

const gcp = new vault.gcp.AuthBackend("gcp", {credentials: fs.readFileSync("vault-gcp-credentials.json")});

Create a AuthBackend Resource

new AuthBackend(name: string, args?: AuthBackendArgs, opts?: CustomResourceOptions);
@overload
def AuthBackend(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                client_email: Optional[str] = None,
                client_id: Optional[str] = None,
                credentials: Optional[str] = None,
                description: Optional[str] = None,
                local: Optional[bool] = None,
                path: Optional[str] = None,
                private_key_id: Optional[str] = None,
                project_id: Optional[str] = None)
@overload
def AuthBackend(resource_name: str,
                args: Optional[AuthBackendArgs] = None,
                opts: Optional[ResourceOptions] = None)
func NewAuthBackend(ctx *Context, name string, args *AuthBackendArgs, opts ...ResourceOption) (*AuthBackend, error)
public AuthBackend(string name, AuthBackendArgs? args = null, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args AuthBackendArgs
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 AuthBackendArgs
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 AuthBackendArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AuthBackendArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

AuthBackend 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 AuthBackend resource accepts the following input properties:

ClientEmail string
The clients email associated with the credentials
ClientId string
The Client ID of the credentials
Credentials string
A JSON string containing the contents of a GCP credentials file. If this value is empty, Vault will try to use Application Default Credentials from the machine on which the Vault server is running.
Description string
A description of the auth method.
Local bool
Specifies if the auth method is local only.
Path string
The path to mount the auth method — this defaults to ‘gcp’.
PrivateKeyId string
The ID of the private key from the credentials
ProjectId string
The GCP Project ID
ClientEmail string
The clients email associated with the credentials
ClientId string
The Client ID of the credentials
Credentials string
A JSON string containing the contents of a GCP credentials file. If this value is empty, Vault will try to use Application Default Credentials from the machine on which the Vault server is running.
Description string
A description of the auth method.
Local bool
Specifies if the auth method is local only.
Path string
The path to mount the auth method — this defaults to ‘gcp’.
PrivateKeyId string
The ID of the private key from the credentials
ProjectId string
The GCP Project ID
clientEmail string
The clients email associated with the credentials
clientId string
The Client ID of the credentials
credentials string
A JSON string containing the contents of a GCP credentials file. If this value is empty, Vault will try to use Application Default Credentials from the machine on which the Vault server is running.
description string
A description of the auth method.
local boolean
Specifies if the auth method is local only.
path string
The path to mount the auth method — this defaults to ‘gcp’.
privateKeyId string
The ID of the private key from the credentials
projectId string
The GCP Project ID
client_email str
The clients email associated with the credentials
client_id str
The Client ID of the credentials
credentials str
A JSON string containing the contents of a GCP credentials file. If this value is empty, Vault will try to use Application Default Credentials from the machine on which the Vault server is running.
description str
A description of the auth method.
local bool
Specifies if the auth method is local only.
path str
The path to mount the auth method — this defaults to ‘gcp’.
private_key_id str
The ID of the private key from the credentials
project_id str
The GCP Project ID

Outputs

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

Get an existing AuthBackend 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?: AuthBackendState, opts?: CustomResourceOptions): AuthBackend
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_email: Optional[str] = None,
        client_id: Optional[str] = None,
        credentials: Optional[str] = None,
        description: Optional[str] = None,
        local: Optional[bool] = None,
        path: Optional[str] = None,
        private_key_id: Optional[str] = None,
        project_id: Optional[str] = None) -> AuthBackend
func GetAuthBackend(ctx *Context, name string, id IDInput, state *AuthBackendState, opts ...ResourceOption) (*AuthBackend, error)
public static AuthBackend Get(string name, Input<string> id, AuthBackendState? 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:

ClientEmail string
The clients email associated with the credentials
ClientId string
The Client ID of the credentials
Credentials string
A JSON string containing the contents of a GCP credentials file. If this value is empty, Vault will try to use Application Default Credentials from the machine on which the Vault server is running.
Description string
A description of the auth method.
Local bool
Specifies if the auth method is local only.
Path string
The path to mount the auth method — this defaults to ‘gcp’.
PrivateKeyId string
The ID of the private key from the credentials
ProjectId string
The GCP Project ID
ClientEmail string
The clients email associated with the credentials
ClientId string
The Client ID of the credentials
Credentials string
A JSON string containing the contents of a GCP credentials file. If this value is empty, Vault will try to use Application Default Credentials from the machine on which the Vault server is running.
Description string
A description of the auth method.
Local bool
Specifies if the auth method is local only.
Path string
The path to mount the auth method — this defaults to ‘gcp’.
PrivateKeyId string
The ID of the private key from the credentials
ProjectId string
The GCP Project ID
clientEmail string
The clients email associated with the credentials
clientId string
The Client ID of the credentials
credentials string
A JSON string containing the contents of a GCP credentials file. If this value is empty, Vault will try to use Application Default Credentials from the machine on which the Vault server is running.
description string
A description of the auth method.
local boolean
Specifies if the auth method is local only.
path string
The path to mount the auth method — this defaults to ‘gcp’.
privateKeyId string
The ID of the private key from the credentials
projectId string
The GCP Project ID
client_email str
The clients email associated with the credentials
client_id str
The Client ID of the credentials
credentials str
A JSON string containing the contents of a GCP credentials file. If this value is empty, Vault will try to use Application Default Credentials from the machine on which the Vault server is running.
description str
A description of the auth method.
local bool
Specifies if the auth method is local only.
path str
The path to mount the auth method — this defaults to ‘gcp’.
private_key_id str
The ID of the private key from the credentials
project_id str
The GCP Project ID

Import

GCP authentication backends can be imported using the backend name, e.g.

 $ pulumi import vault:gcp/authBackend:AuthBackend gcp gcp

Package Details

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