iam

package
v0.0.0-...-ac9024e Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 18, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Group 

type Group struct {
	pulumi.CustomResourceState

	// The name of the user group.
	Name pulumi.StringOutput `pulumi:"name"`
	// The QOS maximum download rate. Defaults to `-1`.
	QosRateMaxDown pulumi.IntPtrOutput `pulumi:"qosRateMaxDown"`
	// The QOS maximum upload rate. Defaults to `-1`.
	QosRateMaxUp pulumi.IntPtrOutput `pulumi:"qosRateMaxUp"`
	// The name of the site to associate the user group with.
	Site pulumi.StringOutput `pulumi:"site"`
}

`iam.Group` manages a user group (called "client group" in the UI), which can be used to limit bandwidth for groups of users.

## 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.NewGroup(ctx, "wifi", &iam.GroupArgs{
			QosRateMaxDown: pulumi.Int(2000),
			QosRateMaxUp:   pulumi.Int(10),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

import using the ID

```sh 

$ pulumi import unifi:iam/group:Group wifi 5fe6261995fe130013456a36

```

func GetGroup 

func GetGroup(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *GroupState, opts ...pulumi.ResourceOption) (*Group, error)

GetGroup gets an existing Group 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 NewGroup 

func NewGroup(ctx *pulumi.Context,
	name string, args *GroupArgs, opts ...pulumi.ResourceOption) (*Group, error)

NewGroup registers a new resource with the given unique name, arguments, and options.

func (*Group) ElementType 

func (*Group) ElementType() reflect.Type

func (*Group) ToGroupOutput 

func (i *Group) ToGroupOutput() GroupOutput

func (*Group) ToGroupOutputWithContext 

func (i *Group) ToGroupOutputWithContext(ctx context.Context) GroupOutput

func (*Group) ToOutput 

func (i *Group) ToOutput(ctx context.Context) pulumix.Output[*Group]

type GroupArgs 

type GroupArgs struct {
	// The name of the user group.
	Name pulumi.StringPtrInput
	// The QOS maximum download rate. Defaults to `-1`.
	QosRateMaxDown pulumi.IntPtrInput
	// The QOS maximum upload rate. Defaults to `-1`.
	QosRateMaxUp pulumi.IntPtrInput
	// The name of the site to associate the user group with.
	Site pulumi.StringPtrInput
}

The set of arguments for constructing a Group resource.

func (GroupArgs) ElementType 

func (GroupArgs) ElementType() reflect.Type

type GroupArray 

type GroupArray []GroupInput

func (GroupArray) ElementType 

func (GroupArray) ElementType() reflect.Type

func (GroupArray) ToGroupArrayOutput 

func (i GroupArray) ToGroupArrayOutput() GroupArrayOutput

func (GroupArray) ToGroupArrayOutputWithContext 

func (i GroupArray) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput

func (GroupArray) ToOutput 

func (i GroupArray) ToOutput(ctx context.Context) pulumix.Output[[]*Group]

type GroupArrayInput 

type GroupArrayInput interface {
	pulumi.Input

	ToGroupArrayOutput() GroupArrayOutput
	ToGroupArrayOutputWithContext(context.Context) GroupArrayOutput
}

GroupArrayInput is an input type that accepts GroupArray and GroupArrayOutput values. You can construct a concrete instance of `GroupArrayInput` via: 

GroupArray{ GroupArgs{...} }

type GroupArrayOutput 

type GroupArrayOutput struct{ *pulumi.OutputState }

func (GroupArrayOutput) ElementType 

func (GroupArrayOutput) ElementType() reflect.Type

func (GroupArrayOutput) Index 

func (o GroupArrayOutput) Index(i pulumi.IntInput) GroupOutput

func (GroupArrayOutput) ToGroupArrayOutput 

func (o GroupArrayOutput) ToGroupArrayOutput() GroupArrayOutput

func (GroupArrayOutput) ToGroupArrayOutputWithContext 

func (o GroupArrayOutput) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput

func (GroupArrayOutput) ToOutput 

func (o GroupArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]*Group]

type GroupInput 

type GroupInput interface {
	pulumi.Input

	ToGroupOutput() GroupOutput
	ToGroupOutputWithContext(ctx context.Context) GroupOutput
}

type GroupMap 

type GroupMap map[string]GroupInput

func (GroupMap) ElementType 

func (GroupMap) ElementType() reflect.Type

func (GroupMap) ToGroupMapOutput 

func (i GroupMap) ToGroupMapOutput() GroupMapOutput

func (GroupMap) ToGroupMapOutputWithContext 

func (i GroupMap) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput

func (GroupMap) ToOutput 

func (i GroupMap) ToOutput(ctx context.Context) pulumix.Output[map[string]*Group]

type GroupMapInput 

type GroupMapInput interface {
	pulumi.Input

	ToGroupMapOutput() GroupMapOutput
	ToGroupMapOutputWithContext(context.Context) GroupMapOutput
}

GroupMapInput is an input type that accepts GroupMap and GroupMapOutput values. You can construct a concrete instance of `GroupMapInput` via: 

GroupMap{ "key": GroupArgs{...} }

type GroupMapOutput 

type GroupMapOutput struct{ *pulumi.OutputState }

func (GroupMapOutput) ElementType 

func (GroupMapOutput) ElementType() reflect.Type

func (GroupMapOutput) MapIndex 

func (o GroupMapOutput) MapIndex(k pulumi.StringInput) GroupOutput

func (GroupMapOutput) ToGroupMapOutput 

func (o GroupMapOutput) ToGroupMapOutput() GroupMapOutput

func (GroupMapOutput) ToGroupMapOutputWithContext 

func (o GroupMapOutput) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput

func (GroupMapOutput) ToOutput 

func (o GroupMapOutput) ToOutput(ctx context.Context) pulumix.Output[map[string]*Group]

type GroupOutput 

type GroupOutput struct{ *pulumi.OutputState }

func (GroupOutput) ElementType 

func (GroupOutput) ElementType() reflect.Type

func (GroupOutput) Name 

func (o GroupOutput) Name() pulumi.StringOutput

The name of the user group.

func (GroupOutput) QosRateMaxDown 

func (o GroupOutput) QosRateMaxDown() pulumi.IntPtrOutput

The QOS maximum download rate. Defaults to `-1`.

func (GroupOutput) QosRateMaxUp 

func (o GroupOutput) QosRateMaxUp() pulumi.IntPtrOutput

The QOS maximum upload rate. Defaults to `-1`.

func (GroupOutput) Site 

func (o GroupOutput) Site() pulumi.StringOutput

The name of the site to associate the user group with.

func (GroupOutput) ToGroupOutput 

func (o GroupOutput) ToGroupOutput() GroupOutput

func (GroupOutput) ToGroupOutputWithContext 

func (o GroupOutput) ToGroupOutputWithContext(ctx context.Context) GroupOutput

func (GroupOutput) ToOutput 

func (o GroupOutput) ToOutput(ctx context.Context) pulumix.Output[*Group]

type GroupState 

type GroupState struct {
	// The name of the user group.
	Name pulumi.StringPtrInput
	// The QOS maximum download rate. Defaults to `-1`.
	QosRateMaxDown pulumi.IntPtrInput
	// The QOS maximum upload rate. Defaults to `-1`.
	QosRateMaxUp pulumi.IntPtrInput
	// The name of the site to associate the user group with.
	Site pulumi.StringPtrInput
}

func (GroupState) ElementType 

func (GroupState) ElementType() reflect.Type

type LookupGroupArgs 

type LookupGroupArgs struct {
	// The name of the user group to look up. Defaults to `Default`.
	Name *string `pulumi:"name"`
	// The name of the site the user group is associated with.
	Site *string `pulumi:"site"`
}

A collection of arguments for invoking getGroup.

type LookupGroupOutputArgs 

type LookupGroupOutputArgs struct {
	// The name of the user group to look up. Defaults to `Default`.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// The name of the site the user group is associated with.
	Site pulumi.StringPtrInput `pulumi:"site"`
}

A collection of arguments for invoking getGroup.

func (LookupGroupOutputArgs) ElementType 

func (LookupGroupOutputArgs) ElementType() reflect.Type

type LookupGroupResult 

type LookupGroupResult struct {
	// The ID of this AP group.
	Id string `pulumi:"id"`
	// The name of the user group to look up. Defaults to `Default`.
	Name           *string `pulumi:"name"`
	QosRateMaxDown int     `pulumi:"qosRateMaxDown"`
	QosRateMaxUp   int     `pulumi:"qosRateMaxUp"`
	// The name of the site the user group is associated with.
	Site string `pulumi:"site"`
}

A collection of values returned by getGroup.

func LookupGroup 

func LookupGroup(ctx *pulumi.Context, args *LookupGroupArgs, opts ...pulumi.InvokeOption) (*LookupGroupResult, error)

`iam.Group` data source can be used to retrieve the ID for a user group by name.

type LookupGroupResultOutput 

type LookupGroupResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getGroup.

func LookupGroupOutput 

func LookupGroupOutput(ctx *pulumi.Context, args LookupGroupOutputArgs, opts ...pulumi.InvokeOption) LookupGroupResultOutput

func (LookupGroupResultOutput) ElementType 

func (LookupGroupResultOutput) ElementType() reflect.Type

func (LookupGroupResultOutput) Id 

func (o LookupGroupResultOutput) Id() pulumi.StringOutput

The ID of this AP group.

func (LookupGroupResultOutput) Name 

func (o LookupGroupResultOutput) Name() pulumi.StringPtrOutput

The name of the user group to look up. Defaults to `Default`.

func (LookupGroupResultOutput) QosRateMaxDown 

func (o LookupGroupResultOutput) QosRateMaxDown() pulumi.IntOutput

func (LookupGroupResultOutput) QosRateMaxUp 

func (o LookupGroupResultOutput) QosRateMaxUp() pulumi.IntOutput

func (LookupGroupResultOutput) Site 

func (o LookupGroupResultOutput) Site() pulumi.StringOutput

The name of the site the user group is associated with.

func (LookupGroupResultOutput) ToLookupGroupResultOutput 

func (o LookupGroupResultOutput) ToLookupGroupResultOutput() LookupGroupResultOutput

func (LookupGroupResultOutput) ToLookupGroupResultOutputWithContext 

func (o LookupGroupResultOutput) ToLookupGroupResultOutputWithContext(ctx context.Context) LookupGroupResultOutput

func (LookupGroupResultOutput) ToOutput 

func (o LookupGroupResultOutput) ToOutput(ctx context.Context) pulumix.Output[LookupGroupResult]

type LookupUserArgs 

type LookupUserArgs struct {
	// The MAC address of the user.
	Mac string `pulumi:"mac"`
	// The name of the site the user is associated with.
	Site *string `pulumi:"site"`
}

A collection of arguments for invoking getUser.

type LookupUserOutputArgs 

type LookupUserOutputArgs struct {
	// The MAC address of the user.
	Mac pulumi.StringInput `pulumi:"mac"`
	// The name of the site the user is associated with.
	Site pulumi.StringPtrInput `pulumi:"site"`
}

A collection of arguments for invoking getUser.

func (LookupUserOutputArgs) ElementType 

func (LookupUserOutputArgs) ElementType() reflect.Type

type LookupUserResult 

type LookupUserResult struct {
	// Specifies whether this user should be blocked from the network.
	Blocked bool `pulumi:"blocked"`
	// Override the device fingerprint.
	DevIdOverride int `pulumi:"devIdOverride"`
	// fixed IPv4 address set for this user.
	FixedIp string `pulumi:"fixedIp"`
	// The hostname of the user.
	Hostname string `pulumi:"hostname"`
	// The ID of the user.
	Id string `pulumi:"id"`
	// The IP address of the user.
	Ip string `pulumi:"ip"`
	// 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 the user is associated with.
	Site string `pulumi:"site"`
	// The user group ID for the user.
	UserGroupId string `pulumi:"userGroupId"`
}

A collection of values returned by getUser.

func LookupUser 

func LookupUser(ctx *pulumi.Context, args *LookupUserArgs, opts ...pulumi.InvokeOption) (*LookupUserResult, error)

`iam.User` retrieves properties of a user (or "client" in the UI) of the network by MAC address.

## 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.LookupUser(ctx, &iam.LookupUserArgs{
			Mac: "01:23:45:67:89:ab",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type LookupUserResultOutput 

type LookupUserResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getUser.

func LookupUserOutput 

func LookupUserOutput(ctx *pulumi.Context, args LookupUserOutputArgs, opts ...pulumi.InvokeOption) LookupUserResultOutput

func (LookupUserResultOutput) Blocked 

func (o LookupUserResultOutput) Blocked() pulumi.BoolOutput

Specifies whether this user should be blocked from the network.

func (LookupUserResultOutput) DevIdOverride 

func (o LookupUserResultOutput) DevIdOverride() pulumi.IntOutput

Override the device fingerprint.

func (LookupUserResultOutput) ElementType 

func (LookupUserResultOutput) ElementType() reflect.Type

func (LookupUserResultOutput) FixedIp 

func (o LookupUserResultOutput) FixedIp() pulumi.StringOutput

fixed IPv4 address set for this user.

func (LookupUserResultOutput) Hostname 

func (o LookupUserResultOutput) Hostname() pulumi.StringOutput

The hostname of the user.

func (LookupUserResultOutput) Id 

func (o LookupUserResultOutput) Id() pulumi.StringOutput

The ID of the user.

func (LookupUserResultOutput) Ip 

func (o LookupUserResultOutput) Ip() pulumi.StringOutput

The IP address of the user.

func (LookupUserResultOutput) LocalDnsRecord 

func (o LookupUserResultOutput) LocalDnsRecord() pulumi.StringOutput

The local DNS record for this user.

func (LookupUserResultOutput) Mac 

func (o LookupUserResultOutput) Mac() pulumi.StringOutput

The MAC address of the user.

func (LookupUserResultOutput) Name 

func (o LookupUserResultOutput) Name() pulumi.StringOutput

The name of the user.

func (LookupUserResultOutput) NetworkId 

func (o LookupUserResultOutput) NetworkId() pulumi.StringOutput

The network ID for this user.

func (LookupUserResultOutput) Note 

func (o LookupUserResultOutput) Note() pulumi.StringOutput

A note with additional information for the user.

func (LookupUserResultOutput) Site 

func (o LookupUserResultOutput) Site() pulumi.StringOutput

The name of the site the user is associated with.

func (LookupUserResultOutput) ToLookupUserResultOutput 

func (o LookupUserResultOutput) ToLookupUserResultOutput() LookupUserResultOutput

func (LookupUserResultOutput) ToLookupUserResultOutputWithContext 

func (o LookupUserResultOutput) ToLookupUserResultOutputWithContext(ctx context.Context) LookupUserResultOutput

func (LookupUserResultOutput) ToOutput 

func (o LookupUserResultOutput) ToOutput(ctx context.Context) pulumix.Output[LookupUserResult]

func (LookupUserResultOutput) UserGroupId 

func (o LookupUserResultOutput) UserGroupId() pulumi.StringOutput

The user group ID for the user.

type User 

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"`
}

`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
	})
}

```

func GetUser 

func GetUser(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *UserState, opts ...pulumi.ResourceOption) (*User, error)

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 NewUser 

func NewUser(ctx *pulumi.Context,
	name string, args *UserArgs, opts ...pulumi.ResourceOption) (*User, error)

NewUser registers a new resource with the given unique name, arguments, and options.

func (*User) ElementType 

func (*User) ElementType() reflect.Type

func (*User) ToOutput 

func (i *User) ToOutput(ctx context.Context) pulumix.Output[*User]

func (*User) ToUserOutput 

func (i *User) ToUserOutput() UserOutput

func (*User) ToUserOutputWithContext 

func (i *User) ToUserOutputWithContext(ctx context.Context) UserOutput

type UserArgs 

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
}

The set of arguments for constructing a User resource.

func (UserArgs) ElementType 

func (UserArgs) ElementType() reflect.Type

type UserArray 

type UserArray []UserInput

func (UserArray) ElementType 

func (UserArray) ElementType() reflect.Type

func (UserArray) ToOutput 

func (i UserArray) ToOutput(ctx context.Context) pulumix.Output[[]*User]

func (UserArray) ToUserArrayOutput 

func (i UserArray) ToUserArrayOutput() UserArrayOutput

func (UserArray) ToUserArrayOutputWithContext 

func (i UserArray) ToUserArrayOutputWithContext(ctx context.Context) UserArrayOutput

type UserArrayInput 

type UserArrayInput interface {
	pulumi.Input

	ToUserArrayOutput() UserArrayOutput
	ToUserArrayOutputWithContext(context.Context) UserArrayOutput
}

UserArrayInput is an input type that accepts UserArray and UserArrayOutput values. You can construct a concrete instance of `UserArrayInput` via: 

UserArray{ UserArgs{...} }

type UserArrayOutput 

type UserArrayOutput struct{ *pulumi.OutputState }

func (UserArrayOutput) ElementType 

func (UserArrayOutput) ElementType() reflect.Type

func (UserArrayOutput) Index 

func (o UserArrayOutput) Index(i pulumi.IntInput) UserOutput

func (UserArrayOutput) ToOutput 

func (o UserArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]*User]

func (UserArrayOutput) ToUserArrayOutput 

func (o UserArrayOutput) ToUserArrayOutput() UserArrayOutput

func (UserArrayOutput) ToUserArrayOutputWithContext 

func (o UserArrayOutput) ToUserArrayOutputWithContext(ctx context.Context) UserArrayOutput

type UserInput 

type UserInput interface {
	pulumi.Input

	ToUserOutput() UserOutput
	ToUserOutputWithContext(ctx context.Context) UserOutput
}

type UserMap 

type UserMap map[string]UserInput

func (UserMap) ElementType 

func (UserMap) ElementType() reflect.Type

func (UserMap) ToOutput 

func (i UserMap) ToOutput(ctx context.Context) pulumix.Output[map[string]*User]

func (UserMap) ToUserMapOutput 

func (i UserMap) ToUserMapOutput() UserMapOutput

func (UserMap) ToUserMapOutputWithContext 

func (i UserMap) ToUserMapOutputWithContext(ctx context.Context) UserMapOutput

type UserMapInput 

type UserMapInput interface {
	pulumi.Input

	ToUserMapOutput() UserMapOutput
	ToUserMapOutputWithContext(context.Context) UserMapOutput
}

UserMapInput is an input type that accepts UserMap and UserMapOutput values. You can construct a concrete instance of `UserMapInput` via: 

UserMap{ "key": UserArgs{...} }

type UserMapOutput 

type UserMapOutput struct{ *pulumi.OutputState }

func (UserMapOutput) ElementType 

func (UserMapOutput) ElementType() reflect.Type

func (UserMapOutput) MapIndex 

func (o UserMapOutput) MapIndex(k pulumi.StringInput) UserOutput

func (UserMapOutput) ToOutput 

func (o UserMapOutput) ToOutput(ctx context.Context) pulumix.Output[map[string]*User]

func (UserMapOutput) ToUserMapOutput 

func (o UserMapOutput) ToUserMapOutput() UserMapOutput

func (UserMapOutput) ToUserMapOutputWithContext 

func (o UserMapOutput) ToUserMapOutputWithContext(ctx context.Context) UserMapOutput

type UserOutput 

type UserOutput struct{ *pulumi.OutputState }

func (UserOutput) AllowExisting 

func (o UserOutput) AllowExisting() pulumi.BoolPtrOutput

Specifies whether this resource should just take over control of an existing user. Defaults to `true`.

func (UserOutput) Blocked 

func (o UserOutput) Blocked() pulumi.BoolPtrOutput

Specifies whether this user should be blocked from the network.

func (UserOutput) DevIdOverride 

func (o UserOutput) DevIdOverride() pulumi.IntPtrOutput

Override the device fingerprint.

func (UserOutput) ElementType 

func (UserOutput) ElementType() reflect.Type

func (UserOutput) FixedIp 

func (o UserOutput) FixedIp() pulumi.StringPtrOutput

A fixed IPv4 address for this user.

func (UserOutput) Hostname 

func (o UserOutput) Hostname() pulumi.StringOutput

The hostname of the user.

func (UserOutput) Ip 

func (o UserOutput) Ip() pulumi.StringOutput

The IP address of the user.

func (UserOutput) LocalDnsRecord 

func (o UserOutput) LocalDnsRecord() pulumi.StringPtrOutput

Specifies the local DNS record for this user.

func (UserOutput) Mac 

func (o UserOutput) Mac() pulumi.StringOutput

The MAC address of the user.

func (UserOutput) Name 

func (o UserOutput) Name() pulumi.StringOutput

The name of the user.

func (UserOutput) NetworkId 

func (o UserOutput) NetworkId() pulumi.StringPtrOutput

The network ID for this user.

func (UserOutput) Note 

func (o UserOutput) Note() pulumi.StringPtrOutput

A note with additional information for the user.

func (UserOutput) Site 

func (o UserOutput) Site() pulumi.StringOutput

The name of the site to associate the user with.

func (UserOutput) SkipForgetOnDestroy 

func (o UserOutput) SkipForgetOnDestroy() pulumi.BoolPtrOutput

Specifies whether this resource should tell the controller to "forget" the user on destroy. Defaults to `false`.

func (UserOutput) ToOutput 

func (o UserOutput) ToOutput(ctx context.Context) pulumix.Output[*User]

func (UserOutput) ToUserOutput 

func (o UserOutput) ToUserOutput() UserOutput

func (UserOutput) ToUserOutputWithContext 

func (o UserOutput) ToUserOutputWithContext(ctx context.Context) UserOutput

func (UserOutput) UserGroupId 

func (o UserOutput) UserGroupId() pulumi.StringPtrOutput

The user group ID for the user.

type UserState 

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 

func (UserState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.