/
getAuthBackendRole.go
382 lines (347 loc) · 19.7 KB
/
getAuthBackendRole.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package kubernetes
import (
"context"
"reflect"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
// Reads the Role of an Kubernetes from a Vault server. See the [Vault
// documentation](https://www.vaultproject.io/api-docs/auth/kubernetes#read-role) for more
// information.
//
// ## Example Usage
//
// ```go
// package main
//
// import (
// "github.com/pulumi/pulumi-vault/sdk/v4/go/vault/kubernetes"
// "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
// )
//
// func main() {
// pulumi.Run(func(ctx *pulumi.Context) error {
// opt0 := "my-kubernetes-backend"
// role, err := kubernetes.LookupAuthBackendRole(ctx, &kubernetes.LookupAuthBackendRoleArgs{
// Backend: &opt0,
// RoleName: "my-role",
// }, nil)
// if err != nil {
// return err
// }
// ctx.Export("policies", role.Policies)
// return nil
// })
// }
// ```
func LookupAuthBackendRole(ctx *pulumi.Context, args *LookupAuthBackendRoleArgs, opts ...pulumi.InvokeOption) (*LookupAuthBackendRoleResult, error) {
var rv LookupAuthBackendRoleResult
err := ctx.Invoke("vault:kubernetes/getAuthBackendRole:getAuthBackendRole", args, &rv, opts...)
if err != nil {
return nil, err
}
return &rv, nil
}
// A collection of arguments for invoking getAuthBackendRole.
type LookupAuthBackendRoleArgs struct {
// (Optional) Audience claim to verify in the JWT.
Audience *string `pulumi:"audience"`
// The unique name for the Kubernetes backend the role to
// retrieve Role attributes for resides in. Defaults to "kubernetes".
Backend *string `pulumi:"backend"`
// Deprecated: use `token_bound_cidrs` instead if you are running Vault >= 1.2
BoundCidrs []string `pulumi:"boundCidrs"`
// Deprecated: use `token_max_ttl` instead if you are running Vault >= 1.2
MaxTtl *int `pulumi:"maxTtl"`
// Deprecated: use `token_num_uses` instead if you are running Vault >= 1.2
NumUses *int `pulumi:"numUses"`
// Deprecated: use `token_period` instead if you are running Vault >= 1.2
Period *int `pulumi:"period"`
// Deprecated: use `token_policies` instead if you are running Vault >= 1.2
Policies []string `pulumi:"policies"`
// The name of the role to retrieve the Role attributes for.
RoleName string `pulumi:"roleName"`
// 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.
TokenBoundCidrs []string `pulumi:"tokenBoundCidrs"`
// If set, will encode an
// [explicit max TTL](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls)
// onto the token in number of seconds. This is a hard cap even if `tokenTtl` and
// `tokenMaxTtl` would otherwise allow a renewal.
TokenExplicitMaxTtl *int `pulumi:"tokenExplicitMaxTtl"`
// The maximum lifetime for generated tokens in number of seconds.
// Its current value will be referenced at renewal time.
TokenMaxTtl *int `pulumi:"tokenMaxTtl"`
// If set, the default policy will not be set on
// generated tokens; otherwise it will be added to the policies set in token_policies.
TokenNoDefaultPolicy *bool `pulumi:"tokenNoDefaultPolicy"`
// The
// [period](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls),
// if any, in number of seconds to set on the token.
TokenNumUses *int `pulumi:"tokenNumUses"`
// (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.
TokenPeriod *int `pulumi:"tokenPeriod"`
// List of policies to encode onto generated tokens. Depending
// on the auth method, this list may be supplemented by user/group/other values.
TokenPolicies []string `pulumi:"tokenPolicies"`
// The incremental lifetime for generated tokens in number of seconds.
// Its current value will be referenced at renewal time.
TokenTtl *int `pulumi:"tokenTtl"`
// The type of token that should be generated. Can be `service`,
// `batch`, or `default` to use the mount's tuned default (which unless changed will be
// `service` tokens). For token store roles, there are two additional possibilities:
// `default-service` and `default-batch` which specify the type to return unless the client
// requests a different type at generation time.
TokenType *string `pulumi:"tokenType"`
// Deprecated: use `token_ttl` instead if you are running Vault >= 1.2
Ttl *int `pulumi:"ttl"`
}
// A collection of values returned by getAuthBackendRole.
type LookupAuthBackendRoleResult struct {
// (Optional) Audience claim to verify in the JWT.
Audience *string `pulumi:"audience"`
Backend *string `pulumi:"backend"`
// Deprecated: use `token_bound_cidrs` instead if you are running Vault >= 1.2
BoundCidrs []string `pulumi:"boundCidrs"`
// List of service account names able to access this role. If set to "*" all names are allowed, both this and boundServiceAccountNamespaces can not be "*".
BoundServiceAccountNames []string `pulumi:"boundServiceAccountNames"`
// List of namespaces allowed to access this role. If set to "*" all namespaces are allowed, both this and boundServiceAccountNames can not be set to "*".
BoundServiceAccountNamespaces []string `pulumi:"boundServiceAccountNamespaces"`
// The provider-assigned unique ID for this managed resource.
Id string `pulumi:"id"`
// Deprecated: use `token_max_ttl` instead if you are running Vault >= 1.2
MaxTtl *int `pulumi:"maxTtl"`
// Deprecated: use `token_num_uses` instead if you are running Vault >= 1.2
NumUses *int `pulumi:"numUses"`
// Deprecated: use `token_period` instead if you are running Vault >= 1.2
Period *int `pulumi:"period"`
// Deprecated: use `token_policies` instead if you are running Vault >= 1.2
Policies []string `pulumi:"policies"`
RoleName string `pulumi:"roleName"`
// 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.
TokenBoundCidrs []string `pulumi:"tokenBoundCidrs"`
// If set, will encode an
// [explicit max TTL](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls)
// onto the token in number of seconds. This is a hard cap even if `tokenTtl` and
// `tokenMaxTtl` would otherwise allow a renewal.
TokenExplicitMaxTtl *int `pulumi:"tokenExplicitMaxTtl"`
// The maximum lifetime for generated tokens in number of seconds.
// Its current value will be referenced at renewal time.
TokenMaxTtl *int `pulumi:"tokenMaxTtl"`
// If set, the default policy will not be set on
// generated tokens; otherwise it will be added to the policies set in token_policies.
TokenNoDefaultPolicy *bool `pulumi:"tokenNoDefaultPolicy"`
// The
// [period](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls),
// if any, in number of seconds to set on the token.
TokenNumUses *int `pulumi:"tokenNumUses"`
// (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.
TokenPeriod *int `pulumi:"tokenPeriod"`
// List of policies to encode onto generated tokens. Depending
// on the auth method, this list may be supplemented by user/group/other values.
TokenPolicies []string `pulumi:"tokenPolicies"`
// The incremental lifetime for generated tokens in number of seconds.
// Its current value will be referenced at renewal time.
TokenTtl *int `pulumi:"tokenTtl"`
// The type of token that should be generated. Can be `service`,
// `batch`, or `default` to use the mount's tuned default (which unless changed will be
// `service` tokens). For token store roles, there are two additional possibilities:
// `default-service` and `default-batch` which specify the type to return unless the client
// requests a different type at generation time.
TokenType *string `pulumi:"tokenType"`
// Deprecated: use `token_ttl` instead if you are running Vault >= 1.2
Ttl *int `pulumi:"ttl"`
}
func LookupAuthBackendRoleOutput(ctx *pulumi.Context, args LookupAuthBackendRoleOutputArgs, opts ...pulumi.InvokeOption) LookupAuthBackendRoleResultOutput {
return pulumi.ToOutputWithContext(context.Background(), args).
ApplyT(func(v interface{}) (LookupAuthBackendRoleResult, error) {
args := v.(LookupAuthBackendRoleArgs)
r, err := LookupAuthBackendRole(ctx, &args, opts...)
return *r, err
}).(LookupAuthBackendRoleResultOutput)
}
// A collection of arguments for invoking getAuthBackendRole.
type LookupAuthBackendRoleOutputArgs struct {
// (Optional) Audience claim to verify in the JWT.
Audience pulumi.StringPtrInput `pulumi:"audience"`
// The unique name for the Kubernetes backend the role to
// retrieve Role attributes for resides in. Defaults to "kubernetes".
Backend pulumi.StringPtrInput `pulumi:"backend"`
// Deprecated: use `token_bound_cidrs` instead if you are running Vault >= 1.2
BoundCidrs pulumi.StringArrayInput `pulumi:"boundCidrs"`
// Deprecated: use `token_max_ttl` instead if you are running Vault >= 1.2
MaxTtl pulumi.IntPtrInput `pulumi:"maxTtl"`
// Deprecated: use `token_num_uses` instead if you are running Vault >= 1.2
NumUses pulumi.IntPtrInput `pulumi:"numUses"`
// Deprecated: use `token_period` instead if you are running Vault >= 1.2
Period pulumi.IntPtrInput `pulumi:"period"`
// Deprecated: use `token_policies` instead if you are running Vault >= 1.2
Policies pulumi.StringArrayInput `pulumi:"policies"`
// The name of the role to retrieve the Role attributes for.
RoleName pulumi.StringInput `pulumi:"roleName"`
// 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.
TokenBoundCidrs pulumi.StringArrayInput `pulumi:"tokenBoundCidrs"`
// If set, will encode an
// [explicit max TTL](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls)
// onto the token in number of seconds. This is a hard cap even if `tokenTtl` and
// `tokenMaxTtl` would otherwise allow a renewal.
TokenExplicitMaxTtl pulumi.IntPtrInput `pulumi:"tokenExplicitMaxTtl"`
// The maximum lifetime for generated tokens in number of seconds.
// Its current value will be referenced at renewal time.
TokenMaxTtl pulumi.IntPtrInput `pulumi:"tokenMaxTtl"`
// If set, the default policy will not be set on
// generated tokens; otherwise it will be added to the policies set in token_policies.
TokenNoDefaultPolicy pulumi.BoolPtrInput `pulumi:"tokenNoDefaultPolicy"`
// The
// [period](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls),
// if any, in number of seconds to set on the token.
TokenNumUses pulumi.IntPtrInput `pulumi:"tokenNumUses"`
// (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.
TokenPeriod pulumi.IntPtrInput `pulumi:"tokenPeriod"`
// List of policies to encode onto generated tokens. Depending
// on the auth method, this list may be supplemented by user/group/other values.
TokenPolicies pulumi.StringArrayInput `pulumi:"tokenPolicies"`
// The incremental lifetime for generated tokens in number of seconds.
// Its current value will be referenced at renewal time.
TokenTtl pulumi.IntPtrInput `pulumi:"tokenTtl"`
// The type of token that should be generated. Can be `service`,
// `batch`, or `default` to use the mount's tuned default (which unless changed will be
// `service` tokens). For token store roles, there are two additional possibilities:
// `default-service` and `default-batch` which specify the type to return unless the client
// requests a different type at generation time.
TokenType pulumi.StringPtrInput `pulumi:"tokenType"`
// Deprecated: use `token_ttl` instead if you are running Vault >= 1.2
Ttl pulumi.IntPtrInput `pulumi:"ttl"`
}
func (LookupAuthBackendRoleOutputArgs) ElementType() reflect.Type {
return reflect.TypeOf((*LookupAuthBackendRoleArgs)(nil)).Elem()
}
// A collection of values returned by getAuthBackendRole.
type LookupAuthBackendRoleResultOutput struct{ *pulumi.OutputState }
func (LookupAuthBackendRoleResultOutput) ElementType() reflect.Type {
return reflect.TypeOf((*LookupAuthBackendRoleResult)(nil)).Elem()
}
func (o LookupAuthBackendRoleResultOutput) ToLookupAuthBackendRoleResultOutput() LookupAuthBackendRoleResultOutput {
return o
}
func (o LookupAuthBackendRoleResultOutput) ToLookupAuthBackendRoleResultOutputWithContext(ctx context.Context) LookupAuthBackendRoleResultOutput {
return o
}
// (Optional) Audience claim to verify in the JWT.
func (o LookupAuthBackendRoleResultOutput) Audience() pulumi.StringPtrOutput {
return o.ApplyT(func(v LookupAuthBackendRoleResult) *string { return v.Audience }).(pulumi.StringPtrOutput)
}
func (o LookupAuthBackendRoleResultOutput) Backend() pulumi.StringPtrOutput {
return o.ApplyT(func(v LookupAuthBackendRoleResult) *string { return v.Backend }).(pulumi.StringPtrOutput)
}
// Deprecated: use `token_bound_cidrs` instead if you are running Vault >= 1.2
func (o LookupAuthBackendRoleResultOutput) BoundCidrs() pulumi.StringArrayOutput {
return o.ApplyT(func(v LookupAuthBackendRoleResult) []string { return v.BoundCidrs }).(pulumi.StringArrayOutput)
}
// List of service account names able to access this role. If set to "*" all names are allowed, both this and boundServiceAccountNamespaces can not be "*".
func (o LookupAuthBackendRoleResultOutput) BoundServiceAccountNames() pulumi.StringArrayOutput {
return o.ApplyT(func(v LookupAuthBackendRoleResult) []string { return v.BoundServiceAccountNames }).(pulumi.StringArrayOutput)
}
// List of namespaces allowed to access this role. If set to "*" all namespaces are allowed, both this and boundServiceAccountNames can not be set to "*".
func (o LookupAuthBackendRoleResultOutput) BoundServiceAccountNamespaces() pulumi.StringArrayOutput {
return o.ApplyT(func(v LookupAuthBackendRoleResult) []string { return v.BoundServiceAccountNamespaces }).(pulumi.StringArrayOutput)
}
// The provider-assigned unique ID for this managed resource.
func (o LookupAuthBackendRoleResultOutput) Id() pulumi.StringOutput {
return o.ApplyT(func(v LookupAuthBackendRoleResult) string { return v.Id }).(pulumi.StringOutput)
}
// Deprecated: use `token_max_ttl` instead if you are running Vault >= 1.2
func (o LookupAuthBackendRoleResultOutput) MaxTtl() pulumi.IntPtrOutput {
return o.ApplyT(func(v LookupAuthBackendRoleResult) *int { return v.MaxTtl }).(pulumi.IntPtrOutput)
}
// Deprecated: use `token_num_uses` instead if you are running Vault >= 1.2
func (o LookupAuthBackendRoleResultOutput) NumUses() pulumi.IntPtrOutput {
return o.ApplyT(func(v LookupAuthBackendRoleResult) *int { return v.NumUses }).(pulumi.IntPtrOutput)
}
// Deprecated: use `token_period` instead if you are running Vault >= 1.2
func (o LookupAuthBackendRoleResultOutput) Period() pulumi.IntPtrOutput {
return o.ApplyT(func(v LookupAuthBackendRoleResult) *int { return v.Period }).(pulumi.IntPtrOutput)
}
// Deprecated: use `token_policies` instead if you are running Vault >= 1.2
func (o LookupAuthBackendRoleResultOutput) Policies() pulumi.StringArrayOutput {
return o.ApplyT(func(v LookupAuthBackendRoleResult) []string { return v.Policies }).(pulumi.StringArrayOutput)
}
func (o LookupAuthBackendRoleResultOutput) RoleName() pulumi.StringOutput {
return o.ApplyT(func(v LookupAuthBackendRoleResult) string { return v.RoleName }).(pulumi.StringOutput)
}
// 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.
func (o LookupAuthBackendRoleResultOutput) TokenBoundCidrs() pulumi.StringArrayOutput {
return o.ApplyT(func(v LookupAuthBackendRoleResult) []string { return v.TokenBoundCidrs }).(pulumi.StringArrayOutput)
}
// If set, will encode an
// [explicit max TTL](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls)
// onto the token in number of seconds. This is a hard cap even if `tokenTtl` and
// `tokenMaxTtl` would otherwise allow a renewal.
func (o LookupAuthBackendRoleResultOutput) TokenExplicitMaxTtl() pulumi.IntPtrOutput {
return o.ApplyT(func(v LookupAuthBackendRoleResult) *int { return v.TokenExplicitMaxTtl }).(pulumi.IntPtrOutput)
}
// The maximum lifetime for generated tokens in number of seconds.
// Its current value will be referenced at renewal time.
func (o LookupAuthBackendRoleResultOutput) TokenMaxTtl() pulumi.IntPtrOutput {
return o.ApplyT(func(v LookupAuthBackendRoleResult) *int { return v.TokenMaxTtl }).(pulumi.IntPtrOutput)
}
// If set, the default policy will not be set on
// generated tokens; otherwise it will be added to the policies set in token_policies.
func (o LookupAuthBackendRoleResultOutput) TokenNoDefaultPolicy() pulumi.BoolPtrOutput {
return o.ApplyT(func(v LookupAuthBackendRoleResult) *bool { return v.TokenNoDefaultPolicy }).(pulumi.BoolPtrOutput)
}
// The
// [period](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls),
// if any, in number of seconds to set on the token.
func (o LookupAuthBackendRoleResultOutput) TokenNumUses() pulumi.IntPtrOutput {
return o.ApplyT(func(v LookupAuthBackendRoleResult) *int { return v.TokenNumUses }).(pulumi.IntPtrOutput)
}
// (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.
func (o LookupAuthBackendRoleResultOutput) TokenPeriod() pulumi.IntPtrOutput {
return o.ApplyT(func(v LookupAuthBackendRoleResult) *int { return v.TokenPeriod }).(pulumi.IntPtrOutput)
}
// List of policies to encode onto generated tokens. Depending
// on the auth method, this list may be supplemented by user/group/other values.
func (o LookupAuthBackendRoleResultOutput) TokenPolicies() pulumi.StringArrayOutput {
return o.ApplyT(func(v LookupAuthBackendRoleResult) []string { return v.TokenPolicies }).(pulumi.StringArrayOutput)
}
// The incremental lifetime for generated tokens in number of seconds.
// Its current value will be referenced at renewal time.
func (o LookupAuthBackendRoleResultOutput) TokenTtl() pulumi.IntPtrOutput {
return o.ApplyT(func(v LookupAuthBackendRoleResult) *int { return v.TokenTtl }).(pulumi.IntPtrOutput)
}
// The type of token that should be generated. Can be `service`,
// `batch`, or `default` to use the mount's tuned default (which unless changed will be
// `service` tokens). For token store roles, there are two additional possibilities:
// `default-service` and `default-batch` which specify the type to return unless the client
// requests a different type at generation time.
func (o LookupAuthBackendRoleResultOutput) TokenType() pulumi.StringPtrOutput {
return o.ApplyT(func(v LookupAuthBackendRoleResult) *string { return v.TokenType }).(pulumi.StringPtrOutput)
}
// Deprecated: use `token_ttl` instead if you are running Vault >= 1.2
func (o LookupAuthBackendRoleResultOutput) Ttl() pulumi.IntPtrOutput {
return o.ApplyT(func(v LookupAuthBackendRoleResult) *int { return v.Ttl }).(pulumi.IntPtrOutput)
}
func init() {
pulumi.RegisterOutputType(LookupAuthBackendRoleResultOutput{})
}