1. Pulumi Registry
  2. HashiCorp Vault
  3. API Docs
  4. aws
  5. AuthBackendClient
vault logo
HashiCorp Vault v5.10.0, Mar 21 23

vault.aws.AuthBackendClient

Import

AWS auth backend clients can be imported using auth/, the backend path, and /config/client e.g.

 $ pulumi import vault:aws/authBackendClient:AuthBackendClient example auth/aws/config/client

Example Usage

using System.Collections.Generic;
using Pulumi;
using Vault = Pulumi.Vault;

return await Deployment.RunAsync(() => 
{
    var exampleAuthBackend = new Vault.AuthBackend("exampleAuthBackend", new()
    {
        Type = "aws",
    });

    var exampleAuthBackendClient = new Vault.Aws.AuthBackendClient("exampleAuthBackendClient", new()
    {
        Backend = exampleAuthBackend.Path,
        AccessKey = "INSERT_AWS_ACCESS_KEY",
        SecretKey = "INSERT_AWS_SECRET_KEY",
    });

});

package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v5/go/vault"
	"github.com/pulumi/pulumi-vault/sdk/v5/go/vault/aws"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleAuthBackend, err := vault.NewAuthBackend(ctx, "exampleAuthBackend", &vault.AuthBackendArgs{
			Type: pulumi.String("aws"),
		})
		if err != nil {
			return err
		}
		_, err = aws.NewAuthBackendClient(ctx, "exampleAuthBackendClient", &aws.AuthBackendClientArgs{
			Backend:   exampleAuthBackend.Path,
			AccessKey: pulumi.String("INSERT_AWS_ACCESS_KEY"),
			SecretKey: pulumi.String("INSERT_AWS_SECRET_KEY"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.AuthBackend;
import com.pulumi.vault.AuthBackendArgs;
import com.pulumi.vault.aws.AuthBackendClient;
import com.pulumi.vault.aws.AuthBackendClientArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleAuthBackend = new AuthBackend("exampleAuthBackend", AuthBackendArgs.builder()        
            .type("aws")
            .build());

        var exampleAuthBackendClient = new AuthBackendClient("exampleAuthBackendClient", AuthBackendClientArgs.builder()        
            .backend(exampleAuthBackend.path())
            .accessKey("INSERT_AWS_ACCESS_KEY")
            .secretKey("INSERT_AWS_SECRET_KEY")
            .build());

    }
}

import pulumi
import pulumi_vault as vault

example_auth_backend = vault.AuthBackend("exampleAuthBackend", type="aws")
example_auth_backend_client = vault.aws.AuthBackendClient("exampleAuthBackendClient",
    backend=example_auth_backend.path,
    access_key="INSERT_AWS_ACCESS_KEY",
    secret_key="INSERT_AWS_SECRET_KEY")

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

const exampleAuthBackend = new vault.AuthBackend("exampleAuthBackend", {type: "aws"});
const exampleAuthBackendClient = new vault.aws.AuthBackendClient("exampleAuthBackendClient", {
    backend: exampleAuthBackend.path,
    accessKey: "INSERT_AWS_ACCESS_KEY",
    secretKey: "INSERT_AWS_SECRET_KEY",
});

resources:
  exampleAuthBackend:
    type: vault:AuthBackend
    properties:
      type: aws
  exampleAuthBackendClient:
    type: vault:aws:AuthBackendClient
    properties:
      backend: ${exampleAuthBackend.path}
      accessKey: INSERT_AWS_ACCESS_KEY
      secretKey: INSERT_AWS_SECRET_KEY

Create AuthBackendClient Resource

new AuthBackendClient(name: string, args?: AuthBackendClientArgs, opts?: CustomResourceOptions);
@overload
def AuthBackendClient(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      access_key: Optional[str] = None,
                      backend: Optional[str] = None,
                      ec2_endpoint: Optional[str] = None,
                      iam_endpoint: Optional[str] = None,
                      iam_server_id_header_value: Optional[str] = None,
                      namespace: Optional[str] = None,
                      secret_key: Optional[str] = None,
                      sts_endpoint: Optional[str] = None,
                      sts_region: Optional[str] = None)
@overload
def AuthBackendClient(resource_name: str,
                      args: Optional[AuthBackendClientArgs] = None,
                      opts: Optional[ResourceOptions] = None)
func NewAuthBackendClient(ctx *Context, name string, args *AuthBackendClientArgs, opts ...ResourceOption) (*AuthBackendClient, error)
public AuthBackendClient(string name, AuthBackendClientArgs? args = null, CustomResourceOptions? opts = null)
public AuthBackendClient(String name, AuthBackendClientArgs args)
public AuthBackendClient(String name, AuthBackendClientArgs args, CustomResourceOptions options)

type: vault:aws:AuthBackendClient
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AuthBackendClientArgs
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 AuthBackendClientArgs
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 AuthBackendClientArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AuthBackendClientArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AuthBackendClientArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

AccessKey string

The AWS access key that Vault should use for the auth backend.

Backend string

The path the AWS auth backend being configured was mounted at. Defaults to aws.

Ec2Endpoint string

Override the URL Vault uses when making EC2 API calls.

IamEndpoint string

Override the URL Vault uses when making IAM API calls.

IamServerIdHeaderValue string

The value to require in the X-Vault-AWS-IAM-Server-ID header as part of GetCallerIdentity requests that are used in the IAM auth method.

Namespace string

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

SecretKey string

The AWS secret key that Vault should use for the auth backend.

StsEndpoint string

Override the URL Vault uses when making STS API calls.

StsRegion string

Override the default region when making STS API calls. The sts_endpoint argument must be set when using sts_region.

AccessKey string

The AWS access key that Vault should use for the auth backend.

Backend string

The path the AWS auth backend being configured was mounted at. Defaults to aws.

Ec2Endpoint string

Override the URL Vault uses when making EC2 API calls.

IamEndpoint string

Override the URL Vault uses when making IAM API calls.

IamServerIdHeaderValue string

The value to require in the X-Vault-AWS-IAM-Server-ID header as part of GetCallerIdentity requests that are used in the IAM auth method.

Namespace string

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

SecretKey string

The AWS secret key that Vault should use for the auth backend.

StsEndpoint string

Override the URL Vault uses when making STS API calls.

StsRegion string

Override the default region when making STS API calls. The sts_endpoint argument must be set when using sts_region.

accessKey String

The AWS access key that Vault should use for the auth backend.

backend String

The path the AWS auth backend being configured was mounted at. Defaults to aws.

ec2Endpoint String

Override the URL Vault uses when making EC2 API calls.

iamEndpoint String

Override the URL Vault uses when making IAM API calls.

iamServerIdHeaderValue String

The value to require in the X-Vault-AWS-IAM-Server-ID header as part of GetCallerIdentity requests that are used in the IAM auth method.

namespace String

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

secretKey String

The AWS secret key that Vault should use for the auth backend.

stsEndpoint String

Override the URL Vault uses when making STS API calls.

stsRegion String

Override the default region when making STS API calls. The sts_endpoint argument must be set when using sts_region.

accessKey string

The AWS access key that Vault should use for the auth backend.

backend string

The path the AWS auth backend being configured was mounted at. Defaults to aws.

ec2Endpoint string

Override the URL Vault uses when making EC2 API calls.

iamEndpoint string

Override the URL Vault uses when making IAM API calls.

iamServerIdHeaderValue string

The value to require in the X-Vault-AWS-IAM-Server-ID header as part of GetCallerIdentity requests that are used in the IAM auth method.

namespace string

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

secretKey string

The AWS secret key that Vault should use for the auth backend.

stsEndpoint string

Override the URL Vault uses when making STS API calls.

stsRegion string

Override the default region when making STS API calls. The sts_endpoint argument must be set when using sts_region.

access_key str

The AWS access key that Vault should use for the auth backend.

backend str

The path the AWS auth backend being configured was mounted at. Defaults to aws.

ec2_endpoint str

Override the URL Vault uses when making EC2 API calls.

iam_endpoint str

Override the URL Vault uses when making IAM API calls.

iam_server_id_header_value str

The value to require in the X-Vault-AWS-IAM-Server-ID header as part of GetCallerIdentity requests that are used in the IAM auth method.

namespace str

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

secret_key str

The AWS secret key that Vault should use for the auth backend.

sts_endpoint str

Override the URL Vault uses when making STS API calls.

sts_region str

Override the default region when making STS API calls. The sts_endpoint argument must be set when using sts_region.

accessKey String

The AWS access key that Vault should use for the auth backend.

backend String

The path the AWS auth backend being configured was mounted at. Defaults to aws.

ec2Endpoint String

Override the URL Vault uses when making EC2 API calls.

iamEndpoint String

Override the URL Vault uses when making IAM API calls.

iamServerIdHeaderValue String

The value to require in the X-Vault-AWS-IAM-Server-ID header as part of GetCallerIdentity requests that are used in the IAM auth method.

namespace String

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

secretKey String

The AWS secret key that Vault should use for the auth backend.

stsEndpoint String

Override the URL Vault uses when making STS API calls.

stsRegion String

Override the default region when making STS API calls. The sts_endpoint argument must be set when using sts_region.

Outputs

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

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing AuthBackendClient Resource

Get an existing AuthBackendClient 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?: AuthBackendClientState, opts?: CustomResourceOptions): AuthBackendClient
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_key: Optional[str] = None,
        backend: Optional[str] = None,
        ec2_endpoint: Optional[str] = None,
        iam_endpoint: Optional[str] = None,
        iam_server_id_header_value: Optional[str] = None,
        namespace: Optional[str] = None,
        secret_key: Optional[str] = None,
        sts_endpoint: Optional[str] = None,
        sts_region: Optional[str] = None) -> AuthBackendClient
func GetAuthBackendClient(ctx *Context, name string, id IDInput, state *AuthBackendClientState, opts ...ResourceOption) (*AuthBackendClient, error)
public static AuthBackendClient Get(string name, Input<string> id, AuthBackendClientState? state, CustomResourceOptions? opts = null)
public static AuthBackendClient get(String name, Output<String> id, AuthBackendClientState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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.
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:
AccessKey string

The AWS access key that Vault should use for the auth backend.

Backend string

The path the AWS auth backend being configured was mounted at. Defaults to aws.

Ec2Endpoint string

Override the URL Vault uses when making EC2 API calls.

IamEndpoint string

Override the URL Vault uses when making IAM API calls.

IamServerIdHeaderValue string

The value to require in the X-Vault-AWS-IAM-Server-ID header as part of GetCallerIdentity requests that are used in the IAM auth method.

Namespace string

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

SecretKey string

The AWS secret key that Vault should use for the auth backend.

StsEndpoint string

Override the URL Vault uses when making STS API calls.

StsRegion string

Override the default region when making STS API calls. The sts_endpoint argument must be set when using sts_region.

AccessKey string

The AWS access key that Vault should use for the auth backend.

Backend string

The path the AWS auth backend being configured was mounted at. Defaults to aws.

Ec2Endpoint string

Override the URL Vault uses when making EC2 API calls.

IamEndpoint string

Override the URL Vault uses when making IAM API calls.

IamServerIdHeaderValue string

The value to require in the X-Vault-AWS-IAM-Server-ID header as part of GetCallerIdentity requests that are used in the IAM auth method.

Namespace string

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

SecretKey string

The AWS secret key that Vault should use for the auth backend.

StsEndpoint string

Override the URL Vault uses when making STS API calls.

StsRegion string

Override the default region when making STS API calls. The sts_endpoint argument must be set when using sts_region.

accessKey String

The AWS access key that Vault should use for the auth backend.

backend String

The path the AWS auth backend being configured was mounted at. Defaults to aws.

ec2Endpoint String

Override the URL Vault uses when making EC2 API calls.

iamEndpoint String

Override the URL Vault uses when making IAM API calls.

iamServerIdHeaderValue String

The value to require in the X-Vault-AWS-IAM-Server-ID header as part of GetCallerIdentity requests that are used in the IAM auth method.

namespace String

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

secretKey String

The AWS secret key that Vault should use for the auth backend.

stsEndpoint String

Override the URL Vault uses when making STS API calls.

stsRegion String

Override the default region when making STS API calls. The sts_endpoint argument must be set when using sts_region.

accessKey string

The AWS access key that Vault should use for the auth backend.

backend string

The path the AWS auth backend being configured was mounted at. Defaults to aws.

ec2Endpoint string

Override the URL Vault uses when making EC2 API calls.

iamEndpoint string

Override the URL Vault uses when making IAM API calls.

iamServerIdHeaderValue string

The value to require in the X-Vault-AWS-IAM-Server-ID header as part of GetCallerIdentity requests that are used in the IAM auth method.

namespace string

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

secretKey string

The AWS secret key that Vault should use for the auth backend.

stsEndpoint string

Override the URL Vault uses when making STS API calls.

stsRegion string

Override the default region when making STS API calls. The sts_endpoint argument must be set when using sts_region.

access_key str

The AWS access key that Vault should use for the auth backend.

backend str

The path the AWS auth backend being configured was mounted at. Defaults to aws.

ec2_endpoint str

Override the URL Vault uses when making EC2 API calls.

iam_endpoint str

Override the URL Vault uses when making IAM API calls.

iam_server_id_header_value str

The value to require in the X-Vault-AWS-IAM-Server-ID header as part of GetCallerIdentity requests that are used in the IAM auth method.

namespace str

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

secret_key str

The AWS secret key that Vault should use for the auth backend.

sts_endpoint str

Override the URL Vault uses when making STS API calls.

sts_region str

Override the default region when making STS API calls. The sts_endpoint argument must be set when using sts_region.

accessKey String

The AWS access key that Vault should use for the auth backend.

backend String

The path the AWS auth backend being configured was mounted at. Defaults to aws.

ec2Endpoint String

Override the URL Vault uses when making EC2 API calls.

iamEndpoint String

Override the URL Vault uses when making IAM API calls.

iamServerIdHeaderValue String

The value to require in the X-Vault-AWS-IAM-Server-ID header as part of GetCallerIdentity requests that are used in the IAM auth method.

namespace String

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

secretKey String

The AWS secret key that Vault should use for the auth backend.

stsEndpoint String

Override the URL Vault uses when making STS API calls.

stsRegion String

Override the default region when making STS API calls. The sts_endpoint argument must be set when using sts_region.

Package Details

Repository
Vault pulumi/pulumi-vault
License
Apache-2.0
Notes

This Pulumi package is based on the vault Terraform Provider.