Module github
This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the
pulumi/pulumi-vaultrepo; however, if that doesn’t turn up anything, please consult the sourceterraform-providers/terraform-provider-vaultrepo.
Resources
Others
Resources
Resource AuthBackend
class AuthBackend extends CustomResourceManages a Github Auth mount in a Vault server. See the Vault documentation for more information.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";
const example = new vault.github.AuthBackend("example", {
organization: "myorg",
});constructor
new AuthBackend(name: string, args: AuthBackendArgs, opts?: pulumi.CustomResourceOptions)Create a AuthBackend resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AuthBackendState, opts?: pulumi.CustomResourceOptions): AuthBackendGet an existing AuthBackend resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is AuthBackendReturns true if the given object is an instance of AuthBackend. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property accessor
public accessor: pulumi.Output<string>;The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
property baseUrl
public baseUrl: pulumi.Output<string | undefined>;The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
property description
public description: pulumi.Output<string | undefined>;Specifies the description of the mount. This overrides the current stored value, if any.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property maxTtl
public maxTtl: pulumi.Output<string | undefined>;(Optional; Deprecated, use tokenMaxTtl instead if you are running Vault >= 1.2) The maximum allowed lifetime of tokens
issued using this role. This must be a valid duration string.
property organization
public organization: pulumi.Output<string>;The organization configured users must be part of.
property path
public path: pulumi.Output<string | undefined>;Path where the auth backend is mounted. Defaults to auth/github
if not specified.
property tokenBoundCidrs
public tokenBoundCidrs: pulumi.Output<string[] | undefined>;(Optional) List of CIDR blocks; if set, specifies blocks of IP addresses which can authenticate successfully, and ties the resulting token to these blocks as well.
property tokenExplicitMaxTtl
public tokenExplicitMaxTtl: pulumi.Output<number | undefined>;(Optional) If set, will encode an
explicit max TTL
onto the token in number of seconds. This is a hard cap even if tokenTtl and
tokenMaxTtl would otherwise allow a renewal.
property tokenMaxTtl
public tokenMaxTtl: pulumi.Output<number | undefined>;(Optional) The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
property tokenNoDefaultPolicy
public tokenNoDefaultPolicy: pulumi.Output<boolean | undefined>;(Optional) If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.
property tokenNumUses
public tokenNumUses: pulumi.Output<number | undefined>;(Optional) The period, if any, in number of seconds to set on the token.
property tokenPeriod
public tokenPeriod: pulumi.Output<number | undefined>;(Optional) If set, indicates that the token generated using this role should never expire. The token should be renewed within the duration specified by this value. At each renewal, the token’s TTL will be set to the value of this field. Specified in seconds.
property tokenPolicies
public tokenPolicies: pulumi.Output<string[] | undefined>;(Optional) List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
property tokenTtl
public tokenTtl: pulumi.Output<number | undefined>;(Optional) The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
property tokenType
public tokenType: pulumi.Output<string | undefined>;Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
property ttl
public ttl: pulumi.Output<string | undefined>;(Optional; Deprecated, use tokenTtl instead if you are running Vault >= 1.2) The TTL period of tokens issued
using this role. This must be a valid duration string.
property tune
public tune: pulumi.Output<AuthBackendTune>;property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
Resource Team
class Team extends CustomResourceconstructor
new Team(name: string, args: TeamArgs, opts?: pulumi.CustomResourceOptions)Create a Team resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TeamState, opts?: pulumi.CustomResourceOptions): TeamGet an existing Team resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is TeamReturns true if the given object is an instance of Team. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property backend
public backend: pulumi.Output<string | undefined>;Path where the github auth backend is mounted. Defaults to github
if not specified.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property policies
public policies: pulumi.Output<string[] | undefined>;An array of strings specifying the policies to be set on tokens issued using this role.
property team
public team: pulumi.Output<string>;GitHub team name in “slugified” format.
property tokenBoundCidrs
public tokenBoundCidrs: pulumi.Output<string[] | undefined>;Specifies the blocks of IP addresses which are allowed to use the generated token
property tokenExplicitMaxTtl
public tokenExplicitMaxTtl: pulumi.Output<number | undefined>;Generated Token’s Explicit Maximum TTL in seconds
property tokenMaxTtl
public tokenMaxTtl: pulumi.Output<number | undefined>;The maximum lifetime of the generated token
property tokenNoDefaultPolicy
public tokenNoDefaultPolicy: pulumi.Output<boolean | undefined>;If true, the ‘default’ policy will not automatically be added to generated tokens
property tokenNumUses
public tokenNumUses: pulumi.Output<number | undefined>;The maximum number of times a token may be used, a value of zero means unlimited
property tokenPeriod
public tokenPeriod: pulumi.Output<number | undefined>;Generated Token’s Period
property tokenPolicies
public tokenPolicies: pulumi.Output<string[] | undefined>;Generated Token’s Policies
property tokenTtl
public tokenTtl: pulumi.Output<number | undefined>;The initial ttl of the token to generate in seconds
property tokenType
public tokenType: pulumi.Output<string | undefined>;The type of token to generate, service or batch
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
Resource User
class User extends CustomResourceManages policy mappings for Github Users authenticated via Github. See the Vault documentation for more information.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";
const example = new vault.github.AuthBackend("example", {organization: "myorg"});
const tfUser = new vault.github.User("tfUser", {
backend: example.id,
user: "john.doe",
tokenPolicies: [
"developer",
"read-only",
],
});constructor
new User(name: string, args: UserArgs, opts?: pulumi.CustomResourceOptions)Create a User resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UserState, opts?: pulumi.CustomResourceOptions): UserGet an existing User resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is UserReturns true if the given object is an instance of User. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property backend
public backend: pulumi.Output<string | undefined>;Path where the github auth backend is mounted. Defaults to github
if not specified.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property policies
public policies: pulumi.Output<string[] | undefined>;An array of strings specifying the policies to be set on tokens issued using this role.
property tokenBoundCidrs
public tokenBoundCidrs: pulumi.Output<string[] | undefined>;Specifies the blocks of IP addresses which are allowed to use the generated token
property tokenExplicitMaxTtl
public tokenExplicitMaxTtl: pulumi.Output<number | undefined>;Generated Token’s Explicit Maximum TTL in seconds
property tokenMaxTtl
public tokenMaxTtl: pulumi.Output<number | undefined>;The maximum lifetime of the generated token
property tokenNoDefaultPolicy
public tokenNoDefaultPolicy: pulumi.Output<boolean | undefined>;If true, the ‘default’ policy will not automatically be added to generated tokens
property tokenNumUses
public tokenNumUses: pulumi.Output<number | undefined>;The maximum number of times a token may be used, a value of zero means unlimited
property tokenPeriod
public tokenPeriod: pulumi.Output<number | undefined>;Generated Token’s Period
property tokenPolicies
public tokenPolicies: pulumi.Output<string[] | undefined>;Generated Token’s Policies
property tokenTtl
public tokenTtl: pulumi.Output<number | undefined>;The initial ttl of the token to generate in seconds
property tokenType
public tokenType: pulumi.Output<string | undefined>;The type of token to generate, service or batch
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
property user
public user: pulumi.Output<string>;GitHub user name.
Others
interface AuthBackendArgs
interface AuthBackendArgsThe set of arguments for constructing a AuthBackend resource.
property baseUrl
baseUrl?: pulumi.Input<string>;The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
property description
description?: pulumi.Input<string>;Specifies the description of the mount. This overrides the current stored value, if any.
property maxTtl
token_max_ttl instead if you are running Vault >= 1.2maxTtl?: pulumi.Input<string>;(Optional; Deprecated, use tokenMaxTtl instead if you are running Vault >= 1.2) The maximum allowed lifetime of tokens
issued using this role. This must be a valid duration string.
property organization
organization: pulumi.Input<string>;The organization configured users must be part of.
property path
path?: pulumi.Input<string>;Path where the auth backend is mounted. Defaults to auth/github
if not specified.
property tokenBoundCidrs
tokenBoundCidrs?: pulumi.Input<pulumi.Input<string>[]>;(Optional) List of CIDR blocks; if set, specifies blocks of IP addresses which can authenticate successfully, and ties the resulting token to these blocks as well.
property tokenExplicitMaxTtl
tokenExplicitMaxTtl?: pulumi.Input<number>;(Optional) If set, will encode an
explicit max TTL
onto the token in number of seconds. This is a hard cap even if tokenTtl and
tokenMaxTtl would otherwise allow a renewal.
property tokenMaxTtl
tokenMaxTtl?: pulumi.Input<number>;(Optional) The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
property tokenNoDefaultPolicy
tokenNoDefaultPolicy?: pulumi.Input<boolean>;(Optional) If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.
property tokenNumUses
tokenNumUses?: pulumi.Input<number>;(Optional) The period, if any, in number of seconds to set on the token.
property tokenPeriod
tokenPeriod?: pulumi.Input<number>;(Optional) If set, indicates that the token generated using this role should never expire. The token should be renewed within the duration specified by this value. At each renewal, the token’s TTL will be set to the value of this field. Specified in seconds.
property tokenPolicies
tokenPolicies?: pulumi.Input<pulumi.Input<string>[]>;(Optional) List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
property tokenTtl
tokenTtl?: pulumi.Input<number>;(Optional) The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
property tokenType
tokenType?: pulumi.Input<string>;Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
property ttl
token_ttl instead if you are running Vault >= 1.2ttl?: pulumi.Input<string>;(Optional; Deprecated, use tokenTtl instead if you are running Vault >= 1.2) The TTL period of tokens issued
using this role. This must be a valid duration string.
property tune
tune?: pulumi.Input<AuthBackendTune>;interface AuthBackendState
interface AuthBackendStateInput properties used for looking up and filtering AuthBackend resources.
property accessor
accessor?: pulumi.Input<string>;The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
property baseUrl
baseUrl?: pulumi.Input<string>;The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
property description
description?: pulumi.Input<string>;Specifies the description of the mount. This overrides the current stored value, if any.
property maxTtl
token_max_ttl instead if you are running Vault >= 1.2maxTtl?: pulumi.Input<string>;(Optional; Deprecated, use tokenMaxTtl instead if you are running Vault >= 1.2) The maximum allowed lifetime of tokens
issued using this role. This must be a valid duration string.
property organization
organization?: pulumi.Input<string>;The organization configured users must be part of.
property path
path?: pulumi.Input<string>;Path where the auth backend is mounted. Defaults to auth/github
if not specified.
property tokenBoundCidrs
tokenBoundCidrs?: pulumi.Input<pulumi.Input<string>[]>;(Optional) List of CIDR blocks; if set, specifies blocks of IP addresses which can authenticate successfully, and ties the resulting token to these blocks as well.
property tokenExplicitMaxTtl
tokenExplicitMaxTtl?: pulumi.Input<number>;(Optional) If set, will encode an
explicit max TTL
onto the token in number of seconds. This is a hard cap even if tokenTtl and
tokenMaxTtl would otherwise allow a renewal.
property tokenMaxTtl
tokenMaxTtl?: pulumi.Input<number>;(Optional) The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
property tokenNoDefaultPolicy
tokenNoDefaultPolicy?: pulumi.Input<boolean>;(Optional) If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.
property tokenNumUses
tokenNumUses?: pulumi.Input<number>;(Optional) The period, if any, in number of seconds to set on the token.
property tokenPeriod
tokenPeriod?: pulumi.Input<number>;(Optional) If set, indicates that the token generated using this role should never expire. The token should be renewed within the duration specified by this value. At each renewal, the token’s TTL will be set to the value of this field. Specified in seconds.
property tokenPolicies
tokenPolicies?: pulumi.Input<pulumi.Input<string>[]>;(Optional) List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
property tokenTtl
tokenTtl?: pulumi.Input<number>;(Optional) The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
property tokenType
tokenType?: pulumi.Input<string>;Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
property ttl
token_ttl instead if you are running Vault >= 1.2ttl?: pulumi.Input<string>;(Optional; Deprecated, use tokenTtl instead if you are running Vault >= 1.2) The TTL period of tokens issued
using this role. This must be a valid duration string.
property tune
tune?: pulumi.Input<AuthBackendTune>;interface TeamArgs
interface TeamArgsThe set of arguments for constructing a Team resource.
property backend
backend?: pulumi.Input<string>;Path where the github auth backend is mounted. Defaults to github
if not specified.
property policies
policies?: pulumi.Input<pulumi.Input<string>[]>;An array of strings specifying the policies to be set on tokens issued using this role.
property team
team: pulumi.Input<string>;GitHub team name in “slugified” format.
property tokenBoundCidrs
tokenBoundCidrs?: pulumi.Input<pulumi.Input<string>[]>;Specifies * the * blocks * of * IP * addresses * which * are * allowed * to * use * the * generated * token *
property tokenExplicitMaxTtl
tokenExplicitMaxTtl?: pulumi.Input<number>;Generated * Token’s * Explicit * Maximum * TTL * in * seconds *
property tokenMaxTtl
tokenMaxTtl?: pulumi.Input<number>;The * maximum * lifetime * of * the * generated * token *
property tokenNoDefaultPolicy
tokenNoDefaultPolicy?: pulumi.Input<boolean>;If * true, * the * ‘default’ * policy * will * not * automatically * be * added * to * generated * tokens *
property tokenNumUses
tokenNumUses?: pulumi.Input<number>;The * maximum * number * of * times * a * token * may * be * used, * a * value * of * zero * means * unlimited *
property tokenPeriod
tokenPeriod?: pulumi.Input<number>;Generated * Token’s * Period *
property tokenPolicies
tokenPolicies?: pulumi.Input<pulumi.Input<string>[]>;Generated * Token’s * Policies *
property tokenTtl
tokenTtl?: pulumi.Input<number>;The * initial * ttl * of * the * token * to * generate * in * seconds *
property tokenType
tokenType?: pulumi.Input<string>;The * type * of * token * to * generate, * service * or * batch *
interface TeamState
interface TeamStateInput properties used for looking up and filtering Team resources.
property backend
backend?: pulumi.Input<string>;Path where the github auth backend is mounted. Defaults to github
if not specified.
property policies
policies?: pulumi.Input<pulumi.Input<string>[]>;An array of strings specifying the policies to be set on tokens issued using this role.
property team
team?: pulumi.Input<string>;GitHub team name in “slugified” format.
property tokenBoundCidrs
tokenBoundCidrs?: pulumi.Input<pulumi.Input<string>[]>;Specifies * the * blocks * of * IP * addresses * which * are * allowed * to * use * the * generated * token *
property tokenExplicitMaxTtl
tokenExplicitMaxTtl?: pulumi.Input<number>;Generated * Token’s * Explicit * Maximum * TTL * in * seconds *
property tokenMaxTtl
tokenMaxTtl?: pulumi.Input<number>;The * maximum * lifetime * of * the * generated * token *
property tokenNoDefaultPolicy
tokenNoDefaultPolicy?: pulumi.Input<boolean>;If * true, * the * ‘default’ * policy * will * not * automatically * be * added * to * generated * tokens *
property tokenNumUses
tokenNumUses?: pulumi.Input<number>;The * maximum * number * of * times * a * token * may * be * used, * a * value * of * zero * means * unlimited *
property tokenPeriod
tokenPeriod?: pulumi.Input<number>;Generated * Token’s * Period *
property tokenPolicies
tokenPolicies?: pulumi.Input<pulumi.Input<string>[]>;Generated * Token’s * Policies *
property tokenTtl
tokenTtl?: pulumi.Input<number>;The * initial * ttl * of * the * token * to * generate * in * seconds *
property tokenType
tokenType?: pulumi.Input<string>;The * type * of * token * to * generate, * service * or * batch *
interface UserArgs
interface UserArgsThe set of arguments for constructing a User resource.
property backend
backend?: pulumi.Input<string>;Path where the github auth backend is mounted. Defaults to github
if not specified.
property policies
policies?: pulumi.Input<pulumi.Input<string>[]>;An array of strings specifying the policies to be set on tokens issued using this role.
property tokenBoundCidrs
tokenBoundCidrs?: pulumi.Input<pulumi.Input<string>[]>;Specifies * the * blocks * of * IP * addresses * which * are * allowed * to * use * the * generated * token *
property tokenExplicitMaxTtl
tokenExplicitMaxTtl?: pulumi.Input<number>;Generated * Token’s * Explicit * Maximum * TTL * in * seconds *
property tokenMaxTtl
tokenMaxTtl?: pulumi.Input<number>;The * maximum * lifetime * of * the * generated * token *
property tokenNoDefaultPolicy
tokenNoDefaultPolicy?: pulumi.Input<boolean>;If * true, * the * ‘default’ * policy * will * not * automatically * be * added * to * generated * tokens *
property tokenNumUses
tokenNumUses?: pulumi.Input<number>;The * maximum * number * of * times * a * token * may * be * used, * a * value * of * zero * means * unlimited *
property tokenPeriod
tokenPeriod?: pulumi.Input<number>;Generated * Token’s * Period *
property tokenPolicies
tokenPolicies?: pulumi.Input<pulumi.Input<string>[]>;Generated * Token’s * Policies *
property tokenTtl
tokenTtl?: pulumi.Input<number>;The * initial * ttl * of * the * token * to * generate * in * seconds *
property tokenType
tokenType?: pulumi.Input<string>;The * type * of * token * to * generate, * service * or * batch *
property user
user: pulumi.Input<string>;GitHub user name.
interface UserState
interface UserStateInput properties used for looking up and filtering User resources.
property backend
backend?: pulumi.Input<string>;Path where the github auth backend is mounted. Defaults to github
if not specified.
property policies
policies?: pulumi.Input<pulumi.Input<string>[]>;An array of strings specifying the policies to be set on tokens issued using this role.
property tokenBoundCidrs
tokenBoundCidrs?: pulumi.Input<pulumi.Input<string>[]>;Specifies * the * blocks * of * IP * addresses * which * are * allowed * to * use * the * generated * token *
property tokenExplicitMaxTtl
tokenExplicitMaxTtl?: pulumi.Input<number>;Generated * Token’s * Explicit * Maximum * TTL * in * seconds *
property tokenMaxTtl
tokenMaxTtl?: pulumi.Input<number>;The * maximum * lifetime * of * the * generated * token *
property tokenNoDefaultPolicy
tokenNoDefaultPolicy?: pulumi.Input<boolean>;If * true, * the * ‘default’ * policy * will * not * automatically * be * added * to * generated * tokens *
property tokenNumUses
tokenNumUses?: pulumi.Input<number>;The * maximum * number * of * times * a * token * may * be * used, * a * value * of * zero * means * unlimited *
property tokenPeriod
tokenPeriod?: pulumi.Input<number>;Generated * Token’s * Period *
property tokenPolicies
tokenPolicies?: pulumi.Input<pulumi.Input<string>[]>;Generated * Token’s * Policies *
property tokenTtl
tokenTtl?: pulumi.Input<number>;The * initial * ttl * of * the * token * to * generate * in * seconds *
property tokenType
tokenType?: pulumi.Input<string>;The * type * of * token * to * generate, * service * or * batch *
property user
user?: pulumi.Input<string>;GitHub user name.