Header menu logo FsCDK

UserBuilder Type

Constructors

Constructor Description

UserBuilder()

Full Usage: UserBuilder()

Returns: UserBuilder
Returns: UserBuilder

Instance members

Instance member Description

this.Combine

Full Usage: this.Combine

Parameters:
Returns: UserConfig
state1 : UserConfig
state2 : UserConfig
Returns: UserConfig

this.Delay

Full Usage: this.Delay

Parameters:
Returns: UserConfig
Modifiers: inline
f : unit -> UserConfig
Returns: UserConfig

this.For

Full Usage: this.For

Parameters:
Returns: UserConfig
Modifiers: inline
config : UserConfig
f : unit -> UserConfig
Returns: UserConfig

groups group

Full Usage: groups group

Parameters:
    group : IGroup list - The IAM group to add the user to.

Returns: UserConfig

Adds the user to IAM groups.

group : IGroup list

The IAM group to add the user to.

Returns: UserConfig

managedPolicies policy

Full Usage: managedPolicies policy

Parameters:
Returns: UserConfig

Attaches managed policies to the user.

policy : IManagedPolicy list

The managed policy to attach.

Returns: UserConfig

password password

Full Usage: password password

Parameters:
    password : SecretValue - The user's password as a SecretValue.

Returns: UserConfig

Sets the user's password.

password : SecretValue

The user's password as a SecretValue.

Returns: UserConfig

passwordResetRequired required

Full Usage: passwordResetRequired required

Parameters:
    required : bool - True if password reset is required, false otherwise.

Returns: UserConfig

Sets whether the user is required to reset their password on next sign-in.

required : bool

True if password reset is required, false otherwise.

Returns: UserConfig

path path

Full Usage: path path

Parameters:
    path : string - The path (e.g., "/division/team/").

Returns: UserConfig

Sets the IAM path for the user.

path : string

The path (e.g., "/division/team/").

Returns: UserConfig

permissionsBoundary permissionsBoundary

Full Usage: permissionsBoundary permissionsBoundary

Parameters:
    permissionsBoundary : IManagedPolicy - The managed policy to use as the permissions boundary.

Returns: UserConfig

Sets the permissions boundary for the user.

permissionsBoundary : IManagedPolicy

The managed policy to use as the permissions boundary.

Returns: UserConfig

this.Run

Full Usage: this.Run

Parameters:
Returns: UserSpec
config : UserConfig
Returns: UserSpec

userName userName

Full Usage: userName userName

Parameters:
    userName : string - The user name.

Returns: UserConfig

Sets the user name.

userName : string

The user name.

Returns: UserConfig

this.Yield

Full Usage: this.Yield

Parameters:
Returns: UserConfig
group : IGroup
Returns: UserConfig

this.Yield

Full Usage: this.Yield

Parameters:
Returns: UserConfig
permissionsBoundary : IManagedPolicy
Returns: UserConfig

this.Yield

Full Usage: this.Yield

Parameters:
    () : unit

Returns: UserConfig
() : unit
Returns: UserConfig

this.Zero

Full Usage: this.Zero

Returns: UserConfig
Returns: UserConfig

Type something to start searching.