/
user.go
474 lines (408 loc) · 16 KB
/
user.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
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***
package iam
import (
"context"
"reflect"
"errors"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumix"
"github.com/pulumiverse/pulumi-unifi/sdk/go/unifi/internal"
)
// `iam.User` manages a user (or "client" in the UI) of the network, these are identified by unique MAC addresses.
//
// Users are created in the controller when observed on the network, so the resource defaults to allowing itself to just take over management of a MAC address, but this can be turned off.
//
// ## Example Usage
//
// ```go
// package main
//
// import (
//
// "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
// "github.com/pulumiverse/pulumi-unifi/sdk/go/unifi/iam"
//
// )
//
// func main() {
// pulumi.Run(func(ctx *pulumi.Context) error {
// _, err := iam.NewUser(ctx, "test", &iam.UserArgs{
// Mac: pulumi.String("01:23:45:67:89:AB"),
// Note: pulumi.String("my note"),
// FixedIp: pulumi.String("10.0.0.50"),
// NetworkId: pulumi.Any(unifi_network.My_vlan.Id),
// })
// if err != nil {
// return err
// }
// return nil
// })
// }
//
// ```
type User struct {
pulumi.CustomResourceState
// Specifies whether this resource should just take over control of an existing user. Defaults to `true`.
AllowExisting pulumi.BoolPtrOutput `pulumi:"allowExisting"`
// Specifies whether this user should be blocked from the network.
Blocked pulumi.BoolPtrOutput `pulumi:"blocked"`
// Override the device fingerprint.
DevIdOverride pulumi.IntPtrOutput `pulumi:"devIdOverride"`
// A fixed IPv4 address for this user.
FixedIp pulumi.StringPtrOutput `pulumi:"fixedIp"`
// The hostname of the user.
Hostname pulumi.StringOutput `pulumi:"hostname"`
// The IP address of the user.
Ip pulumi.StringOutput `pulumi:"ip"`
// Specifies the local DNS record for this user.
LocalDnsRecord pulumi.StringPtrOutput `pulumi:"localDnsRecord"`
// The MAC address of the user.
Mac pulumi.StringOutput `pulumi:"mac"`
// The name of the user.
Name pulumi.StringOutput `pulumi:"name"`
// The network ID for this user.
NetworkId pulumi.StringPtrOutput `pulumi:"networkId"`
// A note with additional information for the user.
Note pulumi.StringPtrOutput `pulumi:"note"`
// The name of the site to associate the user with.
Site pulumi.StringOutput `pulumi:"site"`
// Specifies whether this resource should tell the controller to "forget" the user on destroy. Defaults to `false`.
SkipForgetOnDestroy pulumi.BoolPtrOutput `pulumi:"skipForgetOnDestroy"`
// The user group ID for the user.
UserGroupId pulumi.StringPtrOutput `pulumi:"userGroupId"`
}
// NewUser registers a new resource with the given unique name, arguments, and options.
func NewUser(ctx *pulumi.Context,
name string, args *UserArgs, opts ...pulumi.ResourceOption) (*User, error) {
if args == nil {
return nil, errors.New("missing one or more required arguments")
}
if args.Mac == nil {
return nil, errors.New("invalid value for required argument 'Mac'")
}
opts = internal.PkgResourceDefaultOpts(opts)
var resource User
err := ctx.RegisterResource("unifi:iam/user:User", name, args, &resource, opts...)
if err != nil {
return nil, err
}
return &resource, nil
}
// GetUser gets an existing User resource's state with the given name, ID, and optional
// state properties that are used to uniquely qualify the lookup (nil if not required).
func GetUser(ctx *pulumi.Context,
name string, id pulumi.IDInput, state *UserState, opts ...pulumi.ResourceOption) (*User, error) {
var resource User
err := ctx.ReadResource("unifi:iam/user:User", name, id, state, &resource, opts...)
if err != nil {
return nil, err
}
return &resource, nil
}
// Input properties used for looking up and filtering User resources.
type userState struct {
// Specifies whether this resource should just take over control of an existing user. Defaults to `true`.
AllowExisting *bool `pulumi:"allowExisting"`
// Specifies whether this user should be blocked from the network.
Blocked *bool `pulumi:"blocked"`
// Override the device fingerprint.
DevIdOverride *int `pulumi:"devIdOverride"`
// A fixed IPv4 address for this user.
FixedIp *string `pulumi:"fixedIp"`
// The hostname of the user.
Hostname *string `pulumi:"hostname"`
// The IP address of the user.
Ip *string `pulumi:"ip"`
// Specifies the local DNS record for this user.
LocalDnsRecord *string `pulumi:"localDnsRecord"`
// The MAC address of the user.
Mac *string `pulumi:"mac"`
// The name of the user.
Name *string `pulumi:"name"`
// The network ID for this user.
NetworkId *string `pulumi:"networkId"`
// A note with additional information for the user.
Note *string `pulumi:"note"`
// The name of the site to associate the user with.
Site *string `pulumi:"site"`
// Specifies whether this resource should tell the controller to "forget" the user on destroy. Defaults to `false`.
SkipForgetOnDestroy *bool `pulumi:"skipForgetOnDestroy"`
// The user group ID for the user.
UserGroupId *string `pulumi:"userGroupId"`
}
type UserState struct {
// Specifies whether this resource should just take over control of an existing user. Defaults to `true`.
AllowExisting pulumi.BoolPtrInput
// Specifies whether this user should be blocked from the network.
Blocked pulumi.BoolPtrInput
// Override the device fingerprint.
DevIdOverride pulumi.IntPtrInput
// A fixed IPv4 address for this user.
FixedIp pulumi.StringPtrInput
// The hostname of the user.
Hostname pulumi.StringPtrInput
// The IP address of the user.
Ip pulumi.StringPtrInput
// Specifies the local DNS record for this user.
LocalDnsRecord pulumi.StringPtrInput
// The MAC address of the user.
Mac pulumi.StringPtrInput
// The name of the user.
Name pulumi.StringPtrInput
// The network ID for this user.
NetworkId pulumi.StringPtrInput
// A note with additional information for the user.
Note pulumi.StringPtrInput
// The name of the site to associate the user with.
Site pulumi.StringPtrInput
// Specifies whether this resource should tell the controller to "forget" the user on destroy. Defaults to `false`.
SkipForgetOnDestroy pulumi.BoolPtrInput
// The user group ID for the user.
UserGroupId pulumi.StringPtrInput
}
func (UserState) ElementType() reflect.Type {
return reflect.TypeOf((*userState)(nil)).Elem()
}
type userArgs struct {
// Specifies whether this resource should just take over control of an existing user. Defaults to `true`.
AllowExisting *bool `pulumi:"allowExisting"`
// Specifies whether this user should be blocked from the network.
Blocked *bool `pulumi:"blocked"`
// Override the device fingerprint.
DevIdOverride *int `pulumi:"devIdOverride"`
// A fixed IPv4 address for this user.
FixedIp *string `pulumi:"fixedIp"`
// Specifies the local DNS record for this user.
LocalDnsRecord *string `pulumi:"localDnsRecord"`
// The MAC address of the user.
Mac string `pulumi:"mac"`
// The name of the user.
Name *string `pulumi:"name"`
// The network ID for this user.
NetworkId *string `pulumi:"networkId"`
// A note with additional information for the user.
Note *string `pulumi:"note"`
// The name of the site to associate the user with.
Site *string `pulumi:"site"`
// Specifies whether this resource should tell the controller to "forget" the user on destroy. Defaults to `false`.
SkipForgetOnDestroy *bool `pulumi:"skipForgetOnDestroy"`
// The user group ID for the user.
UserGroupId *string `pulumi:"userGroupId"`
}
// The set of arguments for constructing a User resource.
type UserArgs struct {
// Specifies whether this resource should just take over control of an existing user. Defaults to `true`.
AllowExisting pulumi.BoolPtrInput
// Specifies whether this user should be blocked from the network.
Blocked pulumi.BoolPtrInput
// Override the device fingerprint.
DevIdOverride pulumi.IntPtrInput
// A fixed IPv4 address for this user.
FixedIp pulumi.StringPtrInput
// Specifies the local DNS record for this user.
LocalDnsRecord pulumi.StringPtrInput
// The MAC address of the user.
Mac pulumi.StringInput
// The name of the user.
Name pulumi.StringPtrInput
// The network ID for this user.
NetworkId pulumi.StringPtrInput
// A note with additional information for the user.
Note pulumi.StringPtrInput
// The name of the site to associate the user with.
Site pulumi.StringPtrInput
// Specifies whether this resource should tell the controller to "forget" the user on destroy. Defaults to `false`.
SkipForgetOnDestroy pulumi.BoolPtrInput
// The user group ID for the user.
UserGroupId pulumi.StringPtrInput
}
func (UserArgs) ElementType() reflect.Type {
return reflect.TypeOf((*userArgs)(nil)).Elem()
}
type UserInput interface {
pulumi.Input
ToUserOutput() UserOutput
ToUserOutputWithContext(ctx context.Context) UserOutput
}
func (*User) ElementType() reflect.Type {
return reflect.TypeOf((**User)(nil)).Elem()
}
func (i *User) ToUserOutput() UserOutput {
return i.ToUserOutputWithContext(context.Background())
}
func (i *User) ToUserOutputWithContext(ctx context.Context) UserOutput {
return pulumi.ToOutputWithContext(ctx, i).(UserOutput)
}
func (i *User) ToOutput(ctx context.Context) pulumix.Output[*User] {
return pulumix.Output[*User]{
OutputState: i.ToUserOutputWithContext(ctx).OutputState,
}
}
// UserArrayInput is an input type that accepts UserArray and UserArrayOutput values.
// You can construct a concrete instance of `UserArrayInput` via:
//
// UserArray{ UserArgs{...} }
type UserArrayInput interface {
pulumi.Input
ToUserArrayOutput() UserArrayOutput
ToUserArrayOutputWithContext(context.Context) UserArrayOutput
}
type UserArray []UserInput
func (UserArray) ElementType() reflect.Type {
return reflect.TypeOf((*[]*User)(nil)).Elem()
}
func (i UserArray) ToUserArrayOutput() UserArrayOutput {
return i.ToUserArrayOutputWithContext(context.Background())
}
func (i UserArray) ToUserArrayOutputWithContext(ctx context.Context) UserArrayOutput {
return pulumi.ToOutputWithContext(ctx, i).(UserArrayOutput)
}
func (i UserArray) ToOutput(ctx context.Context) pulumix.Output[[]*User] {
return pulumix.Output[[]*User]{
OutputState: i.ToUserArrayOutputWithContext(ctx).OutputState,
}
}
// UserMapInput is an input type that accepts UserMap and UserMapOutput values.
// You can construct a concrete instance of `UserMapInput` via:
//
// UserMap{ "key": UserArgs{...} }
type UserMapInput interface {
pulumi.Input
ToUserMapOutput() UserMapOutput
ToUserMapOutputWithContext(context.Context) UserMapOutput
}
type UserMap map[string]UserInput
func (UserMap) ElementType() reflect.Type {
return reflect.TypeOf((*map[string]*User)(nil)).Elem()
}
func (i UserMap) ToUserMapOutput() UserMapOutput {
return i.ToUserMapOutputWithContext(context.Background())
}
func (i UserMap) ToUserMapOutputWithContext(ctx context.Context) UserMapOutput {
return pulumi.ToOutputWithContext(ctx, i).(UserMapOutput)
}
func (i UserMap) ToOutput(ctx context.Context) pulumix.Output[map[string]*User] {
return pulumix.Output[map[string]*User]{
OutputState: i.ToUserMapOutputWithContext(ctx).OutputState,
}
}
type UserOutput struct{ *pulumi.OutputState }
func (UserOutput) ElementType() reflect.Type {
return reflect.TypeOf((**User)(nil)).Elem()
}
func (o UserOutput) ToUserOutput() UserOutput {
return o
}
func (o UserOutput) ToUserOutputWithContext(ctx context.Context) UserOutput {
return o
}
func (o UserOutput) ToOutput(ctx context.Context) pulumix.Output[*User] {
return pulumix.Output[*User]{
OutputState: o.OutputState,
}
}
// Specifies whether this resource should just take over control of an existing user. Defaults to `true`.
func (o UserOutput) AllowExisting() pulumi.BoolPtrOutput {
return o.ApplyT(func(v *User) pulumi.BoolPtrOutput { return v.AllowExisting }).(pulumi.BoolPtrOutput)
}
// Specifies whether this user should be blocked from the network.
func (o UserOutput) Blocked() pulumi.BoolPtrOutput {
return o.ApplyT(func(v *User) pulumi.BoolPtrOutput { return v.Blocked }).(pulumi.BoolPtrOutput)
}
// Override the device fingerprint.
func (o UserOutput) DevIdOverride() pulumi.IntPtrOutput {
return o.ApplyT(func(v *User) pulumi.IntPtrOutput { return v.DevIdOverride }).(pulumi.IntPtrOutput)
}
// A fixed IPv4 address for this user.
func (o UserOutput) FixedIp() pulumi.StringPtrOutput {
return o.ApplyT(func(v *User) pulumi.StringPtrOutput { return v.FixedIp }).(pulumi.StringPtrOutput)
}
// The hostname of the user.
func (o UserOutput) Hostname() pulumi.StringOutput {
return o.ApplyT(func(v *User) pulumi.StringOutput { return v.Hostname }).(pulumi.StringOutput)
}
// The IP address of the user.
func (o UserOutput) Ip() pulumi.StringOutput {
return o.ApplyT(func(v *User) pulumi.StringOutput { return v.Ip }).(pulumi.StringOutput)
}
// Specifies the local DNS record for this user.
func (o UserOutput) LocalDnsRecord() pulumi.StringPtrOutput {
return o.ApplyT(func(v *User) pulumi.StringPtrOutput { return v.LocalDnsRecord }).(pulumi.StringPtrOutput)
}
// The MAC address of the user.
func (o UserOutput) Mac() pulumi.StringOutput {
return o.ApplyT(func(v *User) pulumi.StringOutput { return v.Mac }).(pulumi.StringOutput)
}
// The name of the user.
func (o UserOutput) Name() pulumi.StringOutput {
return o.ApplyT(func(v *User) pulumi.StringOutput { return v.Name }).(pulumi.StringOutput)
}
// The network ID for this user.
func (o UserOutput) NetworkId() pulumi.StringPtrOutput {
return o.ApplyT(func(v *User) pulumi.StringPtrOutput { return v.NetworkId }).(pulumi.StringPtrOutput)
}
// A note with additional information for the user.
func (o UserOutput) Note() pulumi.StringPtrOutput {
return o.ApplyT(func(v *User) pulumi.StringPtrOutput { return v.Note }).(pulumi.StringPtrOutput)
}
// The name of the site to associate the user with.
func (o UserOutput) Site() pulumi.StringOutput {
return o.ApplyT(func(v *User) pulumi.StringOutput { return v.Site }).(pulumi.StringOutput)
}
// Specifies whether this resource should tell the controller to "forget" the user on destroy. Defaults to `false`.
func (o UserOutput) SkipForgetOnDestroy() pulumi.BoolPtrOutput {
return o.ApplyT(func(v *User) pulumi.BoolPtrOutput { return v.SkipForgetOnDestroy }).(pulumi.BoolPtrOutput)
}
// The user group ID for the user.
func (o UserOutput) UserGroupId() pulumi.StringPtrOutput {
return o.ApplyT(func(v *User) pulumi.StringPtrOutput { return v.UserGroupId }).(pulumi.StringPtrOutput)
}
type UserArrayOutput struct{ *pulumi.OutputState }
func (UserArrayOutput) ElementType() reflect.Type {
return reflect.TypeOf((*[]*User)(nil)).Elem()
}
func (o UserArrayOutput) ToUserArrayOutput() UserArrayOutput {
return o
}
func (o UserArrayOutput) ToUserArrayOutputWithContext(ctx context.Context) UserArrayOutput {
return o
}
func (o UserArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]*User] {
return pulumix.Output[[]*User]{
OutputState: o.OutputState,
}
}
func (o UserArrayOutput) Index(i pulumi.IntInput) UserOutput {
return pulumi.All(o, i).ApplyT(func(vs []interface{}) *User {
return vs[0].([]*User)[vs[1].(int)]
}).(UserOutput)
}
type UserMapOutput struct{ *pulumi.OutputState }
func (UserMapOutput) ElementType() reflect.Type {
return reflect.TypeOf((*map[string]*User)(nil)).Elem()
}
func (o UserMapOutput) ToUserMapOutput() UserMapOutput {
return o
}
func (o UserMapOutput) ToUserMapOutputWithContext(ctx context.Context) UserMapOutput {
return o
}
func (o UserMapOutput) ToOutput(ctx context.Context) pulumix.Output[map[string]*User] {
return pulumix.Output[map[string]*User]{
OutputState: o.OutputState,
}
}
func (o UserMapOutput) MapIndex(k pulumi.StringInput) UserOutput {
return pulumi.All(o, k).ApplyT(func(vs []interface{}) *User {
return vs[0].(map[string]*User)[vs[1].(string)]
}).(UserOutput)
}
func init() {
pulumi.RegisterInputType(reflect.TypeOf((*UserInput)(nil)).Elem(), &User{})
pulumi.RegisterInputType(reflect.TypeOf((*UserArrayInput)(nil)).Elem(), UserArray{})
pulumi.RegisterInputType(reflect.TypeOf((*UserMapInput)(nil)).Elem(), UserMap{})
pulumi.RegisterOutputType(UserOutput{})
pulumi.RegisterOutputType(UserArrayOutput{})
pulumi.RegisterOutputType(UserMapOutput{})
}