Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Pulumi Vault Provider
  3. API Docs
  4. gcp
  5. AuthBackendRole
HashiCorp Vault v6.4.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-vault

vault.gcp.AuthBackendRole

Explore with Pulumi AI

vault logo
HashiCorp Vault v6.4.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-vault

    Provides a resource to create a role in an GCP auth backend within Vault.

    Example Usage

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

const gcp = new vault.AuthBackend("gcp", {
    path: "gcp",
    type: "gcp",
});
const test = new vault.gcp.AuthBackendRole("test", {
    backend: gcp.path,
    role: "test",
    type: "iam",
    boundServiceAccounts: ["test"],
    boundProjects: ["test"],
    tokenTtl: 300,
    tokenMaxTtl: 600,
    tokenPolicies: [
        "policy_a",
        "policy_b",
    ],
    addGroupAliases: true,
});

    import pulumi
import pulumi_vault as vault

gcp = vault.AuthBackend("gcp",
    path="gcp",
    type="gcp")
test = vault.gcp.AuthBackendRole("test",
    backend=gcp.path,
    role="test",
    type="iam",
    bound_service_accounts=["test"],
    bound_projects=["test"],
    token_ttl=300,
    token_max_ttl=600,
    token_policies=[
        "policy_a",
        "policy_b",
    ],
    add_group_aliases=True)

    package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault"
	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/gcp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		gcp, err := vault.NewAuthBackend(ctx, "gcp", &vault.AuthBackendArgs{
			Path: pulumi.String("gcp"),
			Type: pulumi.String("gcp"),
		})
		if err != nil {
			return err
		}
		_, err = gcp.NewAuthBackendRole(ctx, "test", &gcp.AuthBackendRoleArgs{
			Backend: gcp.Path,
			Role:    pulumi.String("test"),
			Type:    pulumi.String("iam"),
			BoundServiceAccounts: pulumi.StringArray{
				pulumi.String("test"),
			},
			BoundProjects: pulumi.StringArray{
				pulumi.String("test"),
			},
			TokenTtl:    pulumi.Int(300),
			TokenMaxTtl: pulumi.Int(600),
			TokenPolicies: pulumi.StringArray{
				pulumi.String("policy_a"),
				pulumi.String("policy_b"),
			},
			AddGroupAliases: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

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

    var test = new Vault.Gcp.AuthBackendRole("test", new()
    {
        Backend = gcp.Path,
        Role = "test",
        Type = "iam",
        BoundServiceAccounts = new[]
        {
            "test",
        },
        BoundProjects = new[]
        {
            "test",
        },
        TokenTtl = 300,
        TokenMaxTtl = 600,
        TokenPolicies = new[]
        {
            "policy_a",
            "policy_b",
        },
        AddGroupAliases = true,
    });

});

    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.gcp.AuthBackendRole;
import com.pulumi.vault.gcp.AuthBackendRoleArgs;
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 gcp = new AuthBackend("gcp", AuthBackendArgs.builder()
            .path("gcp")
            .type("gcp")
            .build());

        var test = new AuthBackendRole("test", AuthBackendRoleArgs.builder()
            .backend(gcp.path())
            .role("test")
            .type("iam")
            .boundServiceAccounts("test")
            .boundProjects("test")
            .tokenTtl(300)
            .tokenMaxTtl(600)
            .tokenPolicies(            
                "policy_a",
                "policy_b")
            .addGroupAliases(true)
            .build());

    }
}

    resources:
  gcp:
    type: vault:AuthBackend
    properties:
      path: gcp
      type: gcp
  test:
    type: vault:gcp:AuthBackendRole
    properties:
      backend: ${gcp.path}
      role: test
      type: iam
      boundServiceAccounts:
        - test
      boundProjects:
        - test
      tokenTtl: 300
      tokenMaxTtl: 600
      tokenPolicies:
        - policy_a
        - policy_b
      addGroupAliases: true

    Create AuthBackendRole Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AuthBackendRole(name: string, args: AuthBackendRoleArgs, opts?: CustomResourceOptions);
    @overload
def AuthBackendRole(resource_name: str,
                    args: AuthBackendRoleArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def AuthBackendRole(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    role: Optional[str] = None,
                    type: Optional[str] = None,
                    namespace: Optional[str] = None,
                    backend: Optional[str] = None,
                    bound_labels: Optional[Sequence[str]] = None,
                    bound_projects: Optional[Sequence[str]] = None,
                    bound_regions: Optional[Sequence[str]] = None,
                    bound_service_accounts: Optional[Sequence[str]] = None,
                    bound_zones: Optional[Sequence[str]] = None,
                    max_jwt_exp: Optional[str] = None,
                    add_group_aliases: Optional[bool] = None,
                    bound_instance_groups: Optional[Sequence[str]] = None,
                    token_bound_cidrs: Optional[Sequence[str]] = None,
                    token_explicit_max_ttl: Optional[int] = None,
                    token_max_ttl: Optional[int] = None,
                    token_no_default_policy: Optional[bool] = None,
                    token_num_uses: Optional[int] = None,
                    token_period: Optional[int] = None,
                    token_policies: Optional[Sequence[str]] = None,
                    token_ttl: Optional[int] = None,
                    token_type: Optional[str] = None,
                    allow_gce_inference: Optional[bool] = None)
    func NewAuthBackendRole(ctx *Context, name string, args AuthBackendRoleArgs, opts ...ResourceOption) (*AuthBackendRole, error)
    public AuthBackendRole(string name, AuthBackendRoleArgs args, CustomResourceOptions? opts = null)
    public AuthBackendRole(String name, AuthBackendRoleArgs args)
public AuthBackendRole(String name, AuthBackendRoleArgs args, CustomResourceOptions options)

    type: vault:gcp:AuthBackendRole
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleauthBackendRoleResourceResourceFromGcpauthBackendRole = new Vault.Gcp.AuthBackendRole("exampleauthBackendRoleResourceResourceFromGcpauthBackendRole", new()
{
    Role = "string",
    Type = "string",
    Namespace = "string",
    Backend = "string",
    BoundLabels = new[]
    {
        "string",
    },
    BoundProjects = new[]
    {
        "string",
    },
    BoundRegions = new[]
    {
        "string",
    },
    BoundServiceAccounts = new[]
    {
        "string",
    },
    BoundZones = new[]
    {
        "string",
    },
    MaxJwtExp = "string",
    AddGroupAliases = false,
    BoundInstanceGroups = new[]
    {
        "string",
    },
    TokenBoundCidrs = new[]
    {
        "string",
    },
    TokenExplicitMaxTtl = 0,
    TokenMaxTtl = 0,
    TokenNoDefaultPolicy = false,
    TokenNumUses = 0,
    TokenPeriod = 0,
    TokenPolicies = new[]
    {
        "string",
    },
    TokenTtl = 0,
    TokenType = "string",
    AllowGceInference = false,
});

    example, err := gcp.NewAuthBackendRole(ctx, "exampleauthBackendRoleResourceResourceFromGcpauthBackendRole", &gcp.AuthBackendRoleArgs{
	Role:      pulumi.String("string"),
	Type:      pulumi.String("string"),
	Namespace: pulumi.String("string"),
	Backend:   pulumi.String("string"),
	BoundLabels: pulumi.StringArray{
		pulumi.String("string"),
	},
	BoundProjects: pulumi.StringArray{
		pulumi.String("string"),
	},
	BoundRegions: pulumi.StringArray{
		pulumi.String("string"),
	},
	BoundServiceAccounts: pulumi.StringArray{
		pulumi.String("string"),
	},
	BoundZones: pulumi.StringArray{
		pulumi.String("string"),
	},
	MaxJwtExp:       pulumi.String("string"),
	AddGroupAliases: pulumi.Bool(false),
	BoundInstanceGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	TokenBoundCidrs: pulumi.StringArray{
		pulumi.String("string"),
	},
	TokenExplicitMaxTtl:  pulumi.Int(0),
	TokenMaxTtl:          pulumi.Int(0),
	TokenNoDefaultPolicy: pulumi.Bool(false),
	TokenNumUses:         pulumi.Int(0),
	TokenPeriod:          pulumi.Int(0),
	TokenPolicies: pulumi.StringArray{
		pulumi.String("string"),
	},
	TokenTtl:          pulumi.Int(0),
	TokenType:         pulumi.String("string"),
	AllowGceInference: pulumi.Bool(false),
})

    var exampleauthBackendRoleResourceResourceFromGcpauthBackendRole = new AuthBackendRole("exampleauthBackendRoleResourceResourceFromGcpauthBackendRole", AuthBackendRoleArgs.builder()
    .role("string")
    .type("string")
    .namespace("string")
    .backend("string")
    .boundLabels("string")
    .boundProjects("string")
    .boundRegions("string")
    .boundServiceAccounts("string")
    .boundZones("string")
    .maxJwtExp("string")
    .addGroupAliases(false)
    .boundInstanceGroups("string")
    .tokenBoundCidrs("string")
    .tokenExplicitMaxTtl(0)
    .tokenMaxTtl(0)
    .tokenNoDefaultPolicy(false)
    .tokenNumUses(0)
    .tokenPeriod(0)
    .tokenPolicies("string")
    .tokenTtl(0)
    .tokenType("string")
    .allowGceInference(false)
    .build());

    exampleauth_backend_role_resource_resource_from_gcpauth_backend_role = vault.gcp.AuthBackendRole("exampleauthBackendRoleResourceResourceFromGcpauthBackendRole",
    role="string",
    type="string",
    namespace="string",
    backend="string",
    bound_labels=["string"],
    bound_projects=["string"],
    bound_regions=["string"],
    bound_service_accounts=["string"],
    bound_zones=["string"],
    max_jwt_exp="string",
    add_group_aliases=False,
    bound_instance_groups=["string"],
    token_bound_cidrs=["string"],
    token_explicit_max_ttl=0,
    token_max_ttl=0,
    token_no_default_policy=False,
    token_num_uses=0,
    token_period=0,
    token_policies=["string"],
    token_ttl=0,
    token_type="string",
    allow_gce_inference=False)

    const exampleauthBackendRoleResourceResourceFromGcpauthBackendRole = new vault.gcp.AuthBackendRole("exampleauthBackendRoleResourceResourceFromGcpauthBackendRole", {
    role: "string",
    type: "string",
    namespace: "string",
    backend: "string",
    boundLabels: ["string"],
    boundProjects: ["string"],
    boundRegions: ["string"],
    boundServiceAccounts: ["string"],
    boundZones: ["string"],
    maxJwtExp: "string",
    addGroupAliases: false,
    boundInstanceGroups: ["string"],
    tokenBoundCidrs: ["string"],
    tokenExplicitMaxTtl: 0,
    tokenMaxTtl: 0,
    tokenNoDefaultPolicy: false,
    tokenNumUses: 0,
    tokenPeriod: 0,
    tokenPolicies: ["string"],
    tokenTtl: 0,
    tokenType: "string",
    allowGceInference: false,
});

    type: vault:gcp:AuthBackendRole
properties:
    addGroupAliases: false
    allowGceInference: false
    backend: string
    boundInstanceGroups:
        - string
    boundLabels:
        - string
    boundProjects:
        - string
    boundRegions:
        - string
    boundServiceAccounts:
        - string
    boundZones:
        - string
    maxJwtExp: string
    namespace: string
    role: string
    tokenBoundCidrs:
        - string
    tokenExplicitMaxTtl: 0
    tokenMaxTtl: 0
    tokenNoDefaultPolicy: false
    tokenNumUses: 0
    tokenPeriod: 0
    tokenPolicies:
        - string
    tokenTtl: 0
    tokenType: string
    type: string

    AuthBackendRole Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AuthBackendRole resource accepts the following input properties:

    Role string
    Name of the GCP role
    Type string
    Type of GCP authentication role (either gce or iam)
    AddGroupAliases bool
    AllowGceInference bool
    Backend string
    Path to the mounted GCP auth backend
    BoundInstanceGroups List<string>
    BoundLabels List<string>
    BoundProjects List<string>
    An array of GCP project IDs. Only entities belonging to this project can authenticate under the role.
    BoundRegions List<string>
    BoundServiceAccounts List<string>
    GCP Service Accounts allowed to issue tokens under this role. (Note: Required if role is iam)
    BoundZones List<string>
    MaxJwtExp string
    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.
    TokenBoundCidrs List<string>
    Specifies the blocks of IP addresses which are allowed to use the generated token
    TokenExplicitMaxTtl int
    Generated Token's Explicit Maximum TTL in seconds
    TokenMaxTtl int
    The maximum lifetime of the generated token
    TokenNoDefaultPolicy bool
    If true, the 'default' policy will not automatically be added to generated tokens
    TokenNumUses int
    The maximum number of times a token may be used, a value of zero means unlimited
    TokenPeriod int
    Generated Token's Period
    TokenPolicies List<string>
    Generated Token's Policies
    TokenTtl int
    The initial ttl of the token to generate in seconds
    TokenType string
    The type of token to generate, service or batch
    Role string
    Name of the GCP role
    Type string
    Type of GCP authentication role (either gce or iam)
    AddGroupAliases bool
    AllowGceInference bool
    Backend string
    Path to the mounted GCP auth backend
    BoundInstanceGroups []string
    BoundLabels []string
    BoundProjects []string
    An array of GCP project IDs. Only entities belonging to this project can authenticate under the role.
    BoundRegions []string
    BoundServiceAccounts []string
    GCP Service Accounts allowed to issue tokens under this role. (Note: Required if role is iam)
    BoundZones []string
    MaxJwtExp string
    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.
    TokenBoundCidrs []string
    Specifies the blocks of IP addresses which are allowed to use the generated token
    TokenExplicitMaxTtl int
    Generated Token's Explicit Maximum TTL in seconds
    TokenMaxTtl int
    The maximum lifetime of the generated token
    TokenNoDefaultPolicy bool
    If true, the 'default' policy will not automatically be added to generated tokens
    TokenNumUses int
    The maximum number of times a token may be used, a value of zero means unlimited
    TokenPeriod int
    Generated Token's Period
    TokenPolicies []string
    Generated Token's Policies
    TokenTtl int
    The initial ttl of the token to generate in seconds
    TokenType string
    The type of token to generate, service or batch
    role String
    Name of the GCP role
    type String
    Type of GCP authentication role (either gce or iam)
    addGroupAliases Boolean
    allowGceInference Boolean
    backend String
    Path to the mounted GCP auth backend
    boundInstanceGroups List<String>
    boundLabels List<String>
    boundProjects List<String>
    An array of GCP project IDs. Only entities belonging to this project can authenticate under the role.
    boundRegions List<String>
    boundServiceAccounts List<String>
    GCP Service Accounts allowed to issue tokens under this role. (Note: Required if role is iam)
    boundZones List<String>
    maxJwtExp String
    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.
    tokenBoundCidrs List<String>
    Specifies the blocks of IP addresses which are allowed to use the generated token
    tokenExplicitMaxTtl Integer
    Generated Token's Explicit Maximum TTL in seconds
    tokenMaxTtl Integer
    The maximum lifetime of the generated token
    tokenNoDefaultPolicy Boolean
    If true, the 'default' policy will not automatically be added to generated tokens
    tokenNumUses Integer
    The maximum number of times a token may be used, a value of zero means unlimited
    tokenPeriod Integer
    Generated Token's Period
    tokenPolicies List<String>
    Generated Token's Policies
    tokenTtl Integer
    The initial ttl of the token to generate in seconds
    tokenType String
    The type of token to generate, service or batch
    role string
    Name of the GCP role
    type string
    Type of GCP authentication role (either gce or iam)
    addGroupAliases boolean
    allowGceInference boolean
    backend string
    Path to the mounted GCP auth backend
    boundInstanceGroups string[]
    boundLabels string[]
    boundProjects string[]
    An array of GCP project IDs. Only entities belonging to this project can authenticate under the role.
    boundRegions string[]
    boundServiceAccounts string[]
    GCP Service Accounts allowed to issue tokens under this role. (Note: Required if role is iam)
    boundZones string[]
    maxJwtExp string
    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.
    tokenBoundCidrs string[]
    Specifies the blocks of IP addresses which are allowed to use the generated token
    tokenExplicitMaxTtl number
    Generated Token's Explicit Maximum TTL in seconds
    tokenMaxTtl number
    The maximum lifetime of the generated token
    tokenNoDefaultPolicy boolean
    If true, the 'default' policy will not automatically be added to generated tokens
    tokenNumUses number
    The maximum number of times a token may be used, a value of zero means unlimited
    tokenPeriod number
    Generated Token's Period
    tokenPolicies string[]
    Generated Token's Policies
    tokenTtl number
    The initial ttl of the token to generate in seconds
    tokenType string
    The type of token to generate, service or batch
    role str
    Name of the GCP role
    type str
    Type of GCP authentication role (either gce or iam)
    add_group_aliases bool
    allow_gce_inference bool
    backend str
    Path to the mounted GCP auth backend
    bound_instance_groups Sequence[str]
    bound_labels Sequence[str]
    bound_projects Sequence[str]
    An array of GCP project IDs. Only entities belonging to this project can authenticate under the role.
    bound_regions Sequence[str]
    bound_service_accounts Sequence[str]
    GCP Service Accounts allowed to issue tokens under this role. (Note: Required if role is iam)
    bound_zones Sequence[str]
    max_jwt_exp str
    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.
    token_bound_cidrs Sequence[str]
    Specifies the blocks of IP addresses which are allowed to use the generated token
    token_explicit_max_ttl int
    Generated Token's Explicit Maximum TTL in seconds
    token_max_ttl int
    The maximum lifetime of the generated token
    token_no_default_policy bool
    If true, the 'default' policy will not automatically be added to generated tokens
    token_num_uses int
    The maximum number of times a token may be used, a value of zero means unlimited
    token_period int
    Generated Token's Period
    token_policies Sequence[str]
    Generated Token's Policies
    token_ttl int
    The initial ttl of the token to generate in seconds
    token_type str
    The type of token to generate, service or batch
    role String
    Name of the GCP role
    type String
    Type of GCP authentication role (either gce or iam)
    addGroupAliases Boolean
    allowGceInference Boolean
    backend String
    Path to the mounted GCP auth backend
    boundInstanceGroups List<String>
    boundLabels List<String>
    boundProjects List<String>
    An array of GCP project IDs. Only entities belonging to this project can authenticate under the role.
    boundRegions List<String>
    boundServiceAccounts List<String>
    GCP Service Accounts allowed to issue tokens under this role. (Note: Required if role is iam)
    boundZones List<String>
    maxJwtExp String
    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.
    tokenBoundCidrs List<String>
    Specifies the blocks of IP addresses which are allowed to use the generated token
    tokenExplicitMaxTtl Number
    Generated Token's Explicit Maximum TTL in seconds
    tokenMaxTtl Number
    The maximum lifetime of the generated token
    tokenNoDefaultPolicy Boolean
    If true, the 'default' policy will not automatically be added to generated tokens
    tokenNumUses Number
    The maximum number of times a token may be used, a value of zero means unlimited
    tokenPeriod Number
    Generated Token's Period
    tokenPolicies List<String>
    Generated Token's Policies
    tokenTtl Number
    The initial ttl of the token to generate in seconds
    tokenType String
    The type of token to generate, service or batch

    Outputs

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

    Get an existing AuthBackendRole 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?: AuthBackendRoleState, opts?: CustomResourceOptions): AuthBackendRole
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        add_group_aliases: Optional[bool] = None,
        allow_gce_inference: Optional[bool] = None,
        backend: Optional[str] = None,
        bound_instance_groups: Optional[Sequence[str]] = None,
        bound_labels: Optional[Sequence[str]] = None,
        bound_projects: Optional[Sequence[str]] = None,
        bound_regions: Optional[Sequence[str]] = None,
        bound_service_accounts: Optional[Sequence[str]] = None,
        bound_zones: Optional[Sequence[str]] = None,
        max_jwt_exp: Optional[str] = None,
        namespace: Optional[str] = None,
        role: Optional[str] = None,
        token_bound_cidrs: Optional[Sequence[str]] = None,
        token_explicit_max_ttl: Optional[int] = None,
        token_max_ttl: Optional[int] = None,
        token_no_default_policy: Optional[bool] = None,
        token_num_uses: Optional[int] = None,
        token_period: Optional[int] = None,
        token_policies: Optional[Sequence[str]] = None,
        token_ttl: Optional[int] = None,
        token_type: Optional[str] = None,
        type: Optional[str] = None) -> AuthBackendRole
    func GetAuthBackendRole(ctx *Context, name string, id IDInput, state *AuthBackendRoleState, opts ...ResourceOption) (*AuthBackendRole, error)
    public static AuthBackendRole Get(string name, Input<string> id, AuthBackendRoleState? state, CustomResourceOptions? opts = null)
    public static AuthBackendRole get(String name, Output<String> id, AuthBackendRoleState 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:
    AddGroupAliases bool
    AllowGceInference bool
    Backend string
    Path to the mounted GCP auth backend
    BoundInstanceGroups List<string>
    BoundLabels List<string>
    BoundProjects List<string>
    An array of GCP project IDs. Only entities belonging to this project can authenticate under the role.
    BoundRegions List<string>
    BoundServiceAccounts List<string>
    GCP Service Accounts allowed to issue tokens under this role. (Note: Required if role is iam)
    BoundZones List<string>
    MaxJwtExp string
    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.
    Role string
    Name of the GCP role
    TokenBoundCidrs List<string>
    Specifies the blocks of IP addresses which are allowed to use the generated token
    TokenExplicitMaxTtl int
    Generated Token's Explicit Maximum TTL in seconds
    TokenMaxTtl int
    The maximum lifetime of the generated token
    TokenNoDefaultPolicy bool
    If true, the 'default' policy will not automatically be added to generated tokens
    TokenNumUses int
    The maximum number of times a token may be used, a value of zero means unlimited
    TokenPeriod int
    Generated Token's Period
    TokenPolicies List<string>
    Generated Token's Policies
    TokenTtl int
    The initial ttl of the token to generate in seconds
    TokenType string
    The type of token to generate, service or batch
    Type string
    Type of GCP authentication role (either gce or iam)
    AddGroupAliases bool
    AllowGceInference bool
    Backend string
    Path to the mounted GCP auth backend
    BoundInstanceGroups []string
    BoundLabels []string
    BoundProjects []string
    An array of GCP project IDs. Only entities belonging to this project can authenticate under the role.
    BoundRegions []string
    BoundServiceAccounts []string
    GCP Service Accounts allowed to issue tokens under this role. (Note: Required if role is iam)
    BoundZones []string
    MaxJwtExp string
    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.
    Role string
    Name of the GCP role
    TokenBoundCidrs []string
    Specifies the blocks of IP addresses which are allowed to use the generated token
    TokenExplicitMaxTtl int
    Generated Token's Explicit Maximum TTL in seconds
    TokenMaxTtl int
    The maximum lifetime of the generated token
    TokenNoDefaultPolicy bool
    If true, the 'default' policy will not automatically be added to generated tokens
    TokenNumUses int
    The maximum number of times a token may be used, a value of zero means unlimited
    TokenPeriod int
    Generated Token's Period
    TokenPolicies []string
    Generated Token's Policies
    TokenTtl int
    The initial ttl of the token to generate in seconds
    TokenType string
    The type of token to generate, service or batch
    Type string
    Type of GCP authentication role (either gce or iam)
    addGroupAliases Boolean
    allowGceInference Boolean
    backend String
    Path to the mounted GCP auth backend
    boundInstanceGroups List<String>
    boundLabels List<String>
    boundProjects List<String>
    An array of GCP project IDs. Only entities belonging to this project can authenticate under the role.
    boundRegions List<String>
    boundServiceAccounts List<String>
    GCP Service Accounts allowed to issue tokens under this role. (Note: Required if role is iam)
    boundZones List<String>
    maxJwtExp String
    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.
    role String
    Name of the GCP role
    tokenBoundCidrs List<String>
    Specifies the blocks of IP addresses which are allowed to use the generated token
    tokenExplicitMaxTtl Integer
    Generated Token's Explicit Maximum TTL in seconds
    tokenMaxTtl Integer
    The maximum lifetime of the generated token
    tokenNoDefaultPolicy Boolean
    If true, the 'default' policy will not automatically be added to generated tokens
    tokenNumUses Integer
    The maximum number of times a token may be used, a value of zero means unlimited
    tokenPeriod Integer
    Generated Token's Period
    tokenPolicies List<String>
    Generated Token's Policies
    tokenTtl Integer
    The initial ttl of the token to generate in seconds
    tokenType String
    The type of token to generate, service or batch
    type String
    Type of GCP authentication role (either gce or iam)
    addGroupAliases boolean
    allowGceInference boolean
    backend string
    Path to the mounted GCP auth backend
    boundInstanceGroups string[]
    boundLabels string[]
    boundProjects string[]
    An array of GCP project IDs. Only entities belonging to this project can authenticate under the role.
    boundRegions string[]
    boundServiceAccounts string[]
    GCP Service Accounts allowed to issue tokens under this role. (Note: Required if role is iam)
    boundZones string[]
    maxJwtExp string
    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.
    role string
    Name of the GCP role
    tokenBoundCidrs string[]
    Specifies the blocks of IP addresses which are allowed to use the generated token
    tokenExplicitMaxTtl number
    Generated Token's Explicit Maximum TTL in seconds
    tokenMaxTtl number
    The maximum lifetime of the generated token
    tokenNoDefaultPolicy boolean
    If true, the 'default' policy will not automatically be added to generated tokens
    tokenNumUses number
    The maximum number of times a token may be used, a value of zero means unlimited
    tokenPeriod number
    Generated Token's Period
    tokenPolicies string[]
    Generated Token's Policies
    tokenTtl number
    The initial ttl of the token to generate in seconds
    tokenType string
    The type of token to generate, service or batch
    type string
    Type of GCP authentication role (either gce or iam)
    add_group_aliases bool
    allow_gce_inference bool
    backend str
    Path to the mounted GCP auth backend
    bound_instance_groups Sequence[str]
    bound_labels Sequence[str]
    bound_projects Sequence[str]
    An array of GCP project IDs. Only entities belonging to this project can authenticate under the role.
    bound_regions Sequence[str]
    bound_service_accounts Sequence[str]
    GCP Service Accounts allowed to issue tokens under this role. (Note: Required if role is iam)
    bound_zones Sequence[str]
    max_jwt_exp str
    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.
    role str
    Name of the GCP role
    token_bound_cidrs Sequence[str]
    Specifies the blocks of IP addresses which are allowed to use the generated token
    token_explicit_max_ttl int
    Generated Token's Explicit Maximum TTL in seconds
    token_max_ttl int
    The maximum lifetime of the generated token
    token_no_default_policy bool
    If true, the 'default' policy will not automatically be added to generated tokens
    token_num_uses int
    The maximum number of times a token may be used, a value of zero means unlimited
    token_period int
    Generated Token's Period
    token_policies Sequence[str]
    Generated Token's Policies
    token_ttl int
    The initial ttl of the token to generate in seconds
    token_type str
    The type of token to generate, service or batch
    type str
    Type of GCP authentication role (either gce or iam)
    addGroupAliases Boolean
    allowGceInference Boolean
    backend String
    Path to the mounted GCP auth backend
    boundInstanceGroups List<String>
    boundLabels List<String>
    boundProjects List<String>
    An array of GCP project IDs. Only entities belonging to this project can authenticate under the role.
    boundRegions List<String>
    boundServiceAccounts List<String>
    GCP Service Accounts allowed to issue tokens under this role. (Note: Required if role is iam)
    boundZones List<String>
    maxJwtExp String
    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.
    role String
    Name of the GCP role
    tokenBoundCidrs List<String>
    Specifies the blocks of IP addresses which are allowed to use the generated token
    tokenExplicitMaxTtl Number
    Generated Token's Explicit Maximum TTL in seconds
    tokenMaxTtl Number
    The maximum lifetime of the generated token
    tokenNoDefaultPolicy Boolean
    If true, the 'default' policy will not automatically be added to generated tokens
    tokenNumUses Number
    The maximum number of times a token may be used, a value of zero means unlimited
    tokenPeriod Number
    Generated Token's Period
    tokenPolicies List<String>
    Generated Token's Policies
    tokenTtl Number
    The initial ttl of the token to generate in seconds
    tokenType String
    The type of token to generate, service or batch
    type String
    Type of GCP authentication role (either gce or iam)

    Import

    GCP authentication roles can be imported using the path, e.g.

    $ pulumi import vault:gcp/authBackendRole:AuthBackendRole my_role auth/gcp/role/my_role

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Vault pulumi/pulumi-vault
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vault Terraform Provider.
    vault logo
    HashiCorp Vault v6.4.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-vault