user

README

ad_user

Refer to the Terraform Registory for docs: ad_user.

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
  • func NewUser(scope constructs.Construct, id *string, config *UserConfig) User
• type UserConfig

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/hashicorp/ad/0.4.4/docs/resources/user ad_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_IsTerraformElement

func User_IsTerraformElement(x interface{}) *bool

Experimental.

func User_IsTerraformResource

func User_IsTerraformResource(x interface{}) *bool

Experimental.

func User_TfResourceType

func User_TfResourceType() *string

Types

type User

type User interface {
	cdktf.TerraformResource
	CannotChangePassword() interface{}
	SetCannotChangePassword(val interface{})
	CannotChangePasswordInput() interface{}
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	City() *string
	SetCity(val *string)
	CityInput() *string
	Company() *string
	SetCompany(val *string)
	CompanyInput() *string
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	Container() *string
	SetContainer(val *string)
	ContainerInput() *string
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	Country() *string
	SetCountry(val *string)
	CountryInput() *string
	CustomAttributes() *string
	SetCustomAttributes(val *string)
	CustomAttributesInput() *string
	Department() *string
	SetDepartment(val *string)
	DepartmentInput() *string
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	Description() *string
	SetDescription(val *string)
	DescriptionInput() *string
	DisplayName() *string
	SetDisplayName(val *string)
	DisplayNameInput() *string
	Division() *string
	SetDivision(val *string)
	DivisionInput() *string
	Dn() *string
	EmailAddress() *string
	SetEmailAddress(val *string)
	EmailAddressInput() *string
	EmployeeId() *string
	SetEmployeeId(val *string)
	EmployeeIdInput() *string
	EmployeeNumber() *string
	SetEmployeeNumber(val *string)
	EmployeeNumberInput() *string
	Enabled() interface{}
	SetEnabled(val interface{})
	EnabledInput() interface{}
	Fax() *string
	SetFax(val *string)
	FaxInput() *string
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	GivenName() *string
	SetGivenName(val *string)
	GivenNameInput() *string
	HomeDirectory() *string
	SetHomeDirectory(val *string)
	HomeDirectoryInput() *string
	HomeDrive() *string
	SetHomeDrive(val *string)
	HomeDriveInput() *string
	HomePage() *string
	SetHomePage(val *string)
	HomePageInput() *string
	HomePhone() *string
	SetHomePhone(val *string)
	HomePhoneInput() *string
	Id() *string
	SetId(val *string)
	IdInput() *string
	InitialPassword() *string
	SetInitialPassword(val *string)
	InitialPasswordInput() *string
	Initials() *string
	SetInitials(val *string)
	InitialsInput() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	MobilePhone() *string
	SetMobilePhone(val *string)
	MobilePhoneInput() *string
	// The tree node.
	Node() constructs.Node
	Office() *string
	SetOffice(val *string)
	OfficeInput() *string
	OfficePhone() *string
	SetOfficePhone(val *string)
	OfficePhoneInput() *string
	Organization() *string
	SetOrganization(val *string)
	OrganizationInput() *string
	OtherName() *string
	SetOtherName(val *string)
	OtherNameInput() *string
	PasswordNeverExpires() interface{}
	SetPasswordNeverExpires(val interface{})
	PasswordNeverExpiresInput() interface{}
	PoBox() *string
	SetPoBox(val *string)
	PoBoxInput() *string
	PostalCode() *string
	SetPostalCode(val *string)
	PostalCodeInput() *string
	PrincipalName() *string
	SetPrincipalName(val *string)
	PrincipalNameInput() *string
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	SamAccountName() *string
	SetSamAccountName(val *string)
	SamAccountNameInput() *string
	Sid() *string
	SmartCardLogonRequired() interface{}
	SetSmartCardLogonRequired(val interface{})
	SmartCardLogonRequiredInput() interface{}
	State() *string
	SetState(val *string)
	StateInput() *string
	StreetAddress() *string
	SetStreetAddress(val *string)
	StreetAddressInput() *string
	Surname() *string
	SetSurname(val *string)
	SurnameInput() *string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Title() *string
	SetTitle(val *string)
	TitleInput() *string
	TrustedForDelegation() interface{}
	SetTrustedForDelegation(val interface{})
	TrustedForDelegationInput() interface{}
	// 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.
	ImportFrom(id *string, provider cdktf.TerraformProvider)
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Moves this resource to the target resource given by moveTarget.
	// Experimental.
	MoveTo(moveTarget *string, index interface{})
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetCannotChangePassword()
	ResetCity()
	ResetCompany()
	ResetContainer()
	ResetCountry()
	ResetCustomAttributes()
	ResetDepartment()
	ResetDescription()
	ResetDivision()
	ResetEmailAddress()
	ResetEmployeeId()
	ResetEmployeeNumber()
	ResetEnabled()
	ResetFax()
	ResetGivenName()
	ResetHomeDirectory()
	ResetHomeDrive()
	ResetHomePage()
	ResetHomePhone()
	ResetId()
	ResetInitialPassword()
	ResetInitials()
	ResetMobilePhone()
	ResetOffice()
	ResetOfficePhone()
	ResetOrganization()
	ResetOtherName()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetPasswordNeverExpires()
	ResetPoBox()
	ResetPostalCode()
	ResetSmartCardLogonRequired()
	ResetState()
	ResetStreetAddress()
	ResetSurname()
	ResetTitle()
	ResetTrustedForDelegation()
	SynthesizeAttributes() *map[string]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/hashicorp/ad/0.4.4/docs/resources/user ad_user}.

func NewUser

func NewUser(scope constructs.Construct, id *string, config *UserConfig) User

Create a new {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user ad_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 Display Name of an Active Directory user.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#display_name User#display_name}
	DisplayName *string `field:"required" json:"displayName" yaml:"displayName"`
	// The Principal Name of an Active Directory user.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#principal_name User#principal_name}
	PrincipalName *string `field:"required" json:"principalName" yaml:"principalName"`
	// The pre-win2k user logon name.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#sam_account_name User#sam_account_name}
	SamAccountName *string `field:"required" json:"samAccountName" yaml:"samAccountName"`
	// If set to true, the user will not be allowed to change their password.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#cannot_change_password User#cannot_change_password}
	CannotChangePassword interface{} `field:"optional" json:"cannotChangePassword" yaml:"cannotChangePassword"`
	// Specifies the user's town or city. This parameter sets the City property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#city User#city}
	City *string `field:"optional" json:"city" yaml:"city"`
	// Specifies the user's company. This parameter sets the Company property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#company User#company}
	Company *string `field:"optional" json:"company" yaml:"company"`
	// A DN of the container object that will be holding the user.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#container User#container}
	Container *string `field:"optional" json:"container" yaml:"container"`
	// Specifies the country by setting the country code (refer to ISO 3166).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#country User#country}
	Country *string `field:"optional" json:"country" yaml:"country"`
	// JSON encoded map that represents key/value pairs for custom attributes.
	//
	// Please note that `terraform import` will not import these attributes.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#custom_attributes User#custom_attributes}
	CustomAttributes *string `field:"optional" json:"customAttributes" yaml:"customAttributes"`
	// Specifies the user's department. This parameter sets the Department property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#department User#department}
	Department *string `field:"optional" json:"department" yaml:"department"`
	// Specifies a description of the object. This parameter sets the value of the Description property for the user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#description User#description}
	Description *string `field:"optional" json:"description" yaml:"description"`
	// Specifies the user's division. This parameter sets the Division property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#division User#division}
	Division *string `field:"optional" json:"division" yaml:"division"`
	// Specifies the user's e-mail address. This parameter sets the EmailAddress property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#email_address User#email_address}
	EmailAddress *string `field:"optional" json:"emailAddress" yaml:"emailAddress"`
	// Specifies the user's employee ID. This parameter sets the EmployeeID property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#employee_id User#employee_id}
	EmployeeId *string `field:"optional" json:"employeeId" yaml:"employeeId"`
	// Specifies the user's employee number. This parameter sets the EmployeeNumber property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#employee_number User#employee_number}
	EmployeeNumber *string `field:"optional" json:"employeeNumber" yaml:"employeeNumber"`
	// If set to false, the user will be disabled.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#enabled User#enabled}
	Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
	// Specifies the user's fax phone number. This parameter sets the Fax property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#fax User#fax}
	Fax *string `field:"optional" json:"fax" yaml:"fax"`
	// Specifies the user's given name. This parameter sets the GivenName property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#given_name User#given_name}
	GivenName *string `field:"optional" json:"givenName" yaml:"givenName"`
	// Specifies a user's home directory. This parameter sets the HomeDirectory property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#home_directory User#home_directory}
	HomeDirectory *string `field:"optional" json:"homeDirectory" yaml:"homeDirectory"`
	// Specifies a drive that is associated with the UNC path defined by the HomeDirectory property.
	//
	// The drive letter is specified as <DriveLetter>: where <DriveLetter> indicates the letter of the drive to associate. The <DriveLetter> must be a single, uppercase letter and the colon is required. This parameter sets the HomeDrive property of the user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#home_drive User#home_drive}
	HomeDrive *string `field:"optional" json:"homeDrive" yaml:"homeDrive"`
	// Specifies the URL of the home page of the object.
	//
	// This parameter sets the homePage property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#home_page User#home_page}
	HomePage *string `field:"optional" json:"homePage" yaml:"homePage"`
	// Specifies the user's home telephone number. This parameter sets the HomePhone property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#home_phone User#home_phone}
	HomePhone *string `field:"optional" json:"homePhone" yaml:"homePhone"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/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"`
	// The user's initial password. This will be set on creation but will *not* be enforced in subsequent plans.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#initial_password User#initial_password}
	InitialPassword *string `field:"optional" json:"initialPassword" yaml:"initialPassword"`
	// Specifies the initials that represent part of a user's name. Maximum 6 char.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#initials User#initials}
	Initials *string `field:"optional" json:"initials" yaml:"initials"`
	// Specifies the user's mobile phone number. This parameter sets the MobilePhone property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#mobile_phone User#mobile_phone}
	MobilePhone *string `field:"optional" json:"mobilePhone" yaml:"mobilePhone"`
	// Specifies the location of the user's office or place of business.
	//
	// This parameter sets the Office property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#office User#office}
	Office *string `field:"optional" json:"office" yaml:"office"`
	// Specifies the user's office telephone number. This parameter sets the OfficePhone property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#office_phone User#office_phone}
	OfficePhone *string `field:"optional" json:"officePhone" yaml:"officePhone"`
	// Specifies the user's organization. This parameter sets the Organization property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#organization User#organization}
	Organization *string `field:"optional" json:"organization" yaml:"organization"`
	// Specifies a name in addition to a user's given name and surname, such as the user's middle name.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#other_name User#other_name}
	OtherName *string `field:"optional" json:"otherName" yaml:"otherName"`
	// If set to true, the password for this user will not expire.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#password_never_expires User#password_never_expires}
	PasswordNeverExpires interface{} `field:"optional" json:"passwordNeverExpires" yaml:"passwordNeverExpires"`
	// Specifies the user's post office box number. This parameter sets the POBox property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#po_box User#po_box}
	PoBox *string `field:"optional" json:"poBox" yaml:"poBox"`
	// Specifies the user's postal code or zip code. This parameter sets the PostalCode property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#postal_code User#postal_code}
	PostalCode *string `field:"optional" json:"postalCode" yaml:"postalCode"`
	// If set to true, a smart card is required to logon.
	//
	// This parameter sets the SmartCardLoginRequired property for a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#smart_card_logon_required User#smart_card_logon_required}
	SmartCardLogonRequired interface{} `field:"optional" json:"smartCardLogonRequired" yaml:"smartCardLogonRequired"`
	// Specifies the user's or Organizational Unit's state or province. This parameter sets the State property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#state User#state}
	State *string `field:"optional" json:"state" yaml:"state"`
	// Specifies the user's street address. This parameter sets the StreetAddress property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#street_address User#street_address}
	StreetAddress *string `field:"optional" json:"streetAddress" yaml:"streetAddress"`
	// Specifies the user's last name or surname. This parameter sets the Surname property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#surname User#surname}
	Surname *string `field:"optional" json:"surname" yaml:"surname"`
	// Specifies the user's title. This parameter sets the Title property of a user object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#title User#title}
	Title *string `field:"optional" json:"title" yaml:"title"`
	// If set to true, the user account is trusted for Kerberos delegation.
	//
	// A service that runs under an account that is trusted for Kerberos delegation can assume the identity of a client requesting the service. This parameter sets the TrustedForDelegation property of an account object.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/ad/0.4.4/docs/resources/user#trusted_for_delegation User#trusted_for_delegation}
	TrustedForDelegation interface{} `field:"optional" json:"trustedForDelegation" yaml:"trustedForDelegation"`
}