Documentation
¶
Index ¶
- func NewUser_Override(u User, scope constructs.Construct, id *string, config *UserConfig)
- func User_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func User_IsConstruct(x interface{}) *bool
- func User_IsTerraformElement(x interface{}) *bool
- func User_IsTerraformResource(x interface{}) *bool
- func User_TfResourceType() *string
- type User
- type UserConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewUser_Override ¶
func NewUser_Override(u User, scope constructs.Construct, id *string, config *UserConfig)
Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.2.0/docs/resources/user gitlab_user} Resource.
func User_GenerateConfigForImport ¶
func User_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a User resource upon running "cdktf plan <stack-name>".
func User_IsConstruct ¶
func User_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func User_TfResourceType ¶
func User_TfResourceType() *string
Types ¶
type User ¶
type User interface {
cdktf.TerraformResource
CanCreateGroup() interface{}
SetCanCreateGroup(val interface{})
CanCreateGroupInput() interface{}
// Experimental.
CdktfStack() cdktf.TerraformStack
// Experimental.
Connection() interface{}
// Experimental.
SetConnection(val interface{})
// Experimental.
ConstructNodeMetadata() *map[string]interface{}
// Experimental.
Count() interface{}
// Experimental.
SetCount(val interface{})
// Experimental.
DependsOn() *[]*string
// Experimental.
SetDependsOn(val *[]*string)
Email() *string
SetEmail(val *string)
EmailInput() *string
// Experimental.
ForEach() cdktf.ITerraformIterator
// Experimental.
SetForEach(val cdktf.ITerraformIterator)
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
Id() *string
SetId(val *string)
IdInput() *string
IsAdmin() interface{}
SetIsAdmin(val interface{})
IsAdminInput() interface{}
IsExternal() interface{}
SetIsExternal(val interface{})
IsExternalInput() interface{}
// Experimental.
Lifecycle() *cdktf.TerraformResourceLifecycle
// Experimental.
SetLifecycle(val *cdktf.TerraformResourceLifecycle)
Name() *string
SetName(val *string)
NameInput() *string
NamespaceId() *float64
SetNamespaceId(val *float64)
NamespaceIdInput() *float64
// The tree node.
Node() constructs.Node
Note() *string
SetNote(val *string)
NoteInput() *string
Password() *string
SetPassword(val *string)
PasswordInput() *string
ProjectsLimit() *float64
SetProjectsLimit(val *float64)
ProjectsLimitInput() *float64
// Experimental.
Provider() cdktf.TerraformProvider
// Experimental.
SetProvider(val cdktf.TerraformProvider)
// Experimental.
Provisioners() *[]interface{}
// Experimental.
SetProvisioners(val *[]interface{})
// Experimental.
RawOverrides() interface{}
ResetPassword() interface{}
SetResetPassword(val interface{})
ResetPasswordInput() interface{}
SkipConfirmation() interface{}
SetSkipConfirmation(val interface{})
SkipConfirmationInput() interface{}
State() *string
SetState(val *string)
StateInput() *string
// Experimental.
TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
// Experimental.
TerraformMetaArguments() *map[string]interface{}
// Experimental.
TerraformResourceType() *string
Username() *string
SetUsername(val *string)
UsernameInput() *string
// Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
// Experimental.
AddMoveTarget(moveTarget *string)
// Experimental.
AddOverride(path *string, value interface{})
// Experimental.
GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
// Experimental.
GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
// Experimental.
GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
// Experimental.
GetListAttribute(terraformAttribute *string) *[]*string
// Experimental.
GetNumberAttribute(terraformAttribute *string) *float64
// Experimental.
GetNumberListAttribute(terraformAttribute *string) *[]*float64
// Experimental.
GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
// Experimental.
GetStringAttribute(terraformAttribute *string) *string
// Experimental.
GetStringMapAttribute(terraformAttribute *string) *map[string]*string
// Experimental.
HasResourceMove() interface{}
// Experimental.
ImportFrom(id *string, provider cdktf.TerraformProvider)
// Experimental.
InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
// Move the resource corresponding to "id" to this resource.
//
// Note that the resource being moved from must be marked as moved using it's instance function.
// Experimental.
MoveFromId(id *string)
// Moves this resource to the target resource given by moveTarget.
// Experimental.
MoveTo(moveTarget *string, index interface{})
// Moves this resource to the resource corresponding to "id".
// Experimental.
MoveToId(id *string)
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
ResetCanCreateGroup()
ResetId()
ResetIsAdmin()
ResetIsExternal()
ResetNamespaceId()
ResetNote()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
ResetProjectsLimit()
ResetResetPassword()
ResetSkipConfirmation()
ResetState()
ResetTfPassword()
SynthesizeAttributes() *map[string]interface{}
SynthesizeHclAttributes() *map[string]interface{}
// Experimental.
ToHclTerraform() interface{}
// Experimental.
ToMetadata() interface{}
// Returns a string representation of this construct.
ToString() *string
// Adds this resource to the terraform JSON output.
// Experimental.
ToTerraform() interface{}
}
Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.2.0/docs/resources/user gitlab_user}.
func NewUser ¶
func NewUser(scope constructs.Construct, id *string, config *UserConfig) User
Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.2.0/docs/resources/user gitlab_user} Resource.
type UserConfig ¶
type UserConfig struct {
// Experimental.
Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
// Experimental.
Count interface{} `field:"optional" json:"count" yaml:"count"`
// Experimental.
DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
// Experimental.
ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
// Experimental.
Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
// Experimental.
Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
// Experimental.
Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
// The e-mail address of the user.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.2.0/docs/resources/user#email User#email}
Email *string `field:"required" json:"email" yaml:"email"`
// The name of the user.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.2.0/docs/resources/user#name User#name}
Name *string `field:"required" json:"name" yaml:"name"`
// The username of the user.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.2.0/docs/resources/user#username User#username}
Username *string `field:"required" json:"username" yaml:"username"`
// Boolean, defaults to false. Whether to allow the user to create groups.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.2.0/docs/resources/user#can_create_group User#can_create_group}
CanCreateGroup interface{} `field:"optional" json:"canCreateGroup" yaml:"canCreateGroup"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.2.0/docs/resources/user#id User#id}.
//
// Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2.
// If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
Id *string `field:"optional" json:"id" yaml:"id"`
// Boolean, defaults to false. Whether to enable administrative privileges.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.2.0/docs/resources/user#is_admin User#is_admin}
IsAdmin interface{} `field:"optional" json:"isAdmin" yaml:"isAdmin"`
// Boolean, defaults to false.
//
// Whether a user has access only to some internal or private projects. External users can only access projects to which they are explicitly granted access.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.2.0/docs/resources/user#is_external User#is_external}
IsExternal interface{} `field:"optional" json:"isExternal" yaml:"isExternal"`
// The ID of the user's namespace. Available since GitLab 14.10.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.2.0/docs/resources/user#namespace_id User#namespace_id}
NamespaceId *float64 `field:"optional" json:"namespaceId" yaml:"namespaceId"`
// The note associated to the user.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.2.0/docs/resources/user#note User#note}
Note *string `field:"optional" json:"note" yaml:"note"`
// The password of the user.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.2.0/docs/resources/user#password User#password}
Password *string `field:"optional" json:"password" yaml:"password"`
// Integer, defaults to 0. Number of projects user can create.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.2.0/docs/resources/user#projects_limit User#projects_limit}
ProjectsLimit *float64 `field:"optional" json:"projectsLimit" yaml:"projectsLimit"`
// Boolean, defaults to false. Send user password reset link.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.2.0/docs/resources/user#reset_password User#reset_password}
ResetPassword interface{} `field:"optional" json:"resetPassword" yaml:"resetPassword"`
// Boolean, defaults to true. Whether to skip confirmation.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.2.0/docs/resources/user#skip_confirmation User#skip_confirmation}
SkipConfirmation interface{} `field:"optional" json:"skipConfirmation" yaml:"skipConfirmation"`
// String, defaults to 'active'. The state of the user account. Valid values are `active`, `deactivated`, `blocked`.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.2.0/docs/resources/user#state User#state}
State *string `field:"optional" json:"state" yaml:"state"`
}