Skip to content

workmailUser.java.md

Latest commit

 

History

History
2088 lines (1305 loc) · 85 KB

workmailUser.java.md

File metadata and controls

2088 lines (1305 loc) · 85 KB

workmailUser Submodule

Constructs

WorkmailUser

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user aws_workmail_user}.

Initializers 

import io.cdktn.providers.aws.workmail_user.WorkmailUser;

WorkmailUser.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .displayName(java.lang.String)
    .email(java.lang.String)
    .name(java.lang.String)
    .organizationId(java.lang.String)
//  .city(java.lang.String)
//  .company(java.lang.String)
//  .country(java.lang.String)
//  .department(java.lang.String)
//  .firstName(java.lang.String)
//  .hiddenFromGlobalAddressList(java.lang.Boolean|IResolvable)
//  .identityProviderUserId(java.lang.String)
//  .initials(java.lang.String)
//  .jobTitle(java.lang.String)
//  .lastName(java.lang.String)
//  .office(java.lang.String)
//  .password(java.lang.String)
//  .region(java.lang.String)
//  .street(java.lang.String)
//  .telephone(java.lang.String)
//  .userRole(java.lang.String)
//  .zipCode(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection No description.
count java.lang.Number|io.cdktn.cdktn.TerraformCount No description.
dependsOn java.util.List<io.cdktn.cdktn.ITerraformDependable> No description.
forEach io.cdktn.cdktn.ITerraformIterator No description.
lifecycle io.cdktn.cdktn.TerraformResourceLifecycle No description.
provider io.cdktn.cdktn.TerraformProvider No description.
provisioners java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> No description.
displayName java.lang.String Display name of the user.
email java.lang.String Primary email address used to register the user with WorkMail.
name java.lang.String Username of the user.
organizationId java.lang.String Identifier of the WorkMail organization where the user is managed.
city java.lang.String City where the user is located.
company java.lang.String Company associated with the user.
country java.lang.String Country where the user is located.
department java.lang.String Department associated with the user.
firstName java.lang.String First name of the user.
hiddenFromGlobalAddressList java.lang.Boolean|io.cdktn.cdktn.IResolvable Whether to hide the user from the global address list.
identityProviderUserId java.lang.String User ID from IAM Identity Center associated with the user.
initials java.lang.String Initials of the user.
jobTitle java.lang.String Job title of the user.
lastName java.lang.String Last name of the user.
office java.lang.String Office where the user is located.
password java.lang.String Password to set for the user.
region java.lang.String Region where this resource will be managed. Defaults to the Region set in the provider configuration.
street java.lang.String Street address of the user.
telephone java.lang.String Telephone number of the user.
userRole java.lang.String Role assigned to the user.
zipCode java.lang.String ZIP or postal code of the user.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number|io.cdktn.cdktn.TerraformCount
dependsOnOptional
  • Type: java.util.List<io.cdktn.cdktn.ITerraformDependable>
forEachOptional
  • Type: io.cdktn.cdktn.ITerraformIterator
lifecycleOptional
  • Type: io.cdktn.cdktn.TerraformResourceLifecycle
providerOptional
  • Type: io.cdktn.cdktn.TerraformProvider
provisionersOptional
  • Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>
displayNameRequired
  • Type: java.lang.String

Display name of the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#display_name WorkmailUser#display_name}

emailRequired
  • Type: java.lang.String

Primary email address used to register the user with WorkMail.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#email WorkmailUser#email}

nameRequired
  • Type: java.lang.String

Username of the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#name WorkmailUser#name}

organizationIdRequired
  • Type: java.lang.String

Identifier of the WorkMail organization where the user is managed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#organization_id WorkmailUser#organization_id}

cityOptional
  • Type: java.lang.String

City where the user is located.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#city WorkmailUser#city}

companyOptional
  • Type: java.lang.String

Company associated with the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#company WorkmailUser#company}

countryOptional
  • Type: java.lang.String

Country where the user is located.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#country WorkmailUser#country}

departmentOptional
  • Type: java.lang.String

Department associated with the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#department WorkmailUser#department}

firstNameOptional
  • Type: java.lang.String

First name of the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#first_name WorkmailUser#first_name}

hiddenFromGlobalAddressListOptional
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

Whether to hide the user from the global address list.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#hidden_from_global_address_list WorkmailUser#hidden_from_global_address_list}

identityProviderUserIdOptional
  • Type: java.lang.String

User ID from IAM Identity Center associated with the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#identity_provider_user_id WorkmailUser#identity_provider_user_id}

initialsOptional
  • Type: java.lang.String

Initials of the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#initials WorkmailUser#initials}

jobTitleOptional
  • Type: java.lang.String

Job title of the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#job_title WorkmailUser#job_title}

lastNameOptional
  • Type: java.lang.String

Last name of the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#last_name WorkmailUser#last_name}

officeOptional
  • Type: java.lang.String

Office where the user is located.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#office WorkmailUser#office}

passwordOptional
  • Type: java.lang.String

Password to set for the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#password WorkmailUser#password}

regionOptional
  • Type: java.lang.String

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#region WorkmailUser#region}

streetOptional
  • Type: java.lang.String

Street address of the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#street WorkmailUser#street}

telephoneOptional
  • Type: java.lang.String

Telephone number of the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#telephone WorkmailUser#telephone}

userRoleOptional
  • Type: java.lang.String

Role assigned to the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#user_role WorkmailUser#user_role}

zipCodeOptional
  • Type: java.lang.String

ZIP or postal code of the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#zip_code WorkmailUser#zip_code}

Methods

Name Description
toString Returns a string representation of this construct.
with Applies one or more mixins to this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
resetCity No description.
resetCompany No description.
resetCountry No description.
resetDepartment No description.
resetFirstName No description.
resetHiddenFromGlobalAddressList No description.
resetIdentityProviderUserId No description.
resetInitials No description.
resetJobTitle No description.
resetLastName No description.
resetOffice No description.
resetPassword No description.
resetRegion No description.
resetStreet No description.
resetTelephone No description.
resetUserRole No description.
resetZipCode No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

with 
public IConstruct with(IMixin... mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixinsRequired
  • Type: software.constructs.IMixin...

The mixins to apply.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: io.cdktn.cdktn.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

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.

idRequired
  • Type: java.lang.String

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: java.lang.String|java.lang.Number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

moveToId 
public void moveToId(java.lang.String id)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: java.lang.String

Full id of resource to move to, e.g. "aws_s3_bucket.example".

resetCity 
public void resetCity()
resetCompany 
public void resetCompany()
resetCountry 
public void resetCountry()
resetDepartment 
public void resetDepartment()
resetFirstName 
public void resetFirstName()
resetHiddenFromGlobalAddressList 
public void resetHiddenFromGlobalAddressList()
resetIdentityProviderUserId 
public void resetIdentityProviderUserId()
resetInitials 
public void resetInitials()
resetJobTitle 
public void resetJobTitle()
resetLastName 
public void resetLastName()
resetOffice 
public void resetOffice()
resetPassword 
public void resetPassword()
resetRegion 
public void resetRegion()
resetStreet 
public void resetStreet()
resetTelephone 
public void resetTelephone()
resetUserRole 
public void resetUserRole()
resetZipCode 
public void resetZipCode()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTN code for importing a WorkmailUser resource upon running "cdktn plan ".
isConstruct 
import io.cdktn.providers.aws.workmail_user.WorkmailUser;

WorkmailUser.isConstruct(java.lang.Object x)

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.

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import io.cdktn.providers.aws.workmail_user.WorkmailUser;

WorkmailUser.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import io.cdktn.providers.aws.workmail_user.WorkmailUser;

WorkmailUser.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import io.cdktn.providers.aws.workmail_user.WorkmailUser;

WorkmailUser.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),WorkmailUser.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

Generates CDKTN code for importing a WorkmailUser resource upon running "cdktn plan ".

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

The construct id used in the generated config for the WorkmailUser to import.

importFromIdRequired
  • Type: java.lang.String

The id of the existing WorkmailUser that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: io.cdktn.cdktn.TerraformProvider

? Optional instance of the provider where the WorkmailUser to import is found.

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack io.cdktn.cdktn.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata io.cdktn.cdktn.TerraformProviderGeneratorMetadata No description.
connection io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection No description.
count java.lang.Number|io.cdktn.cdktn.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach io.cdktn.cdktn.ITerraformIterator No description.
lifecycle io.cdktn.cdktn.TerraformResourceLifecycle No description.
provider io.cdktn.cdktn.TerraformProvider No description.
provisioners java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> No description.
disabledDate java.lang.String No description.
enabledDate java.lang.String No description.
identityProviderIdentityStoreId java.lang.String No description.
mailboxDeprovisionedDate java.lang.String No description.
mailboxProvisionedDate java.lang.String No description.
state java.lang.String No description.
userId java.lang.String No description.
cityInput java.lang.String No description.
companyInput java.lang.String No description.
countryInput java.lang.String No description.
departmentInput java.lang.String No description.
displayNameInput java.lang.String No description.
emailInput java.lang.String No description.
firstNameInput java.lang.String No description.
hiddenFromGlobalAddressListInput java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
identityProviderUserIdInput java.lang.String No description.
initialsInput java.lang.String No description.
jobTitleInput java.lang.String No description.
lastNameInput java.lang.String No description.
nameInput java.lang.String No description.
officeInput java.lang.String No description.
organizationIdInput java.lang.String No description.
passwordInput java.lang.String No description.
regionInput java.lang.String No description.
streetInput java.lang.String No description.
telephoneInput java.lang.String No description.
userRoleInput java.lang.String No description.
zipCodeInput java.lang.String No description.
city java.lang.String No description.
company java.lang.String No description.
country java.lang.String No description.
department java.lang.String No description.
displayName java.lang.String No description.
email java.lang.String No description.
firstName java.lang.String No description.
hiddenFromGlobalAddressList java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
identityProviderUserId java.lang.String No description.
initials java.lang.String No description.
jobTitle java.lang.String No description.
lastName java.lang.String No description.
name java.lang.String No description.
office java.lang.String No description.
organizationId java.lang.String No description.
password java.lang.String No description.
region java.lang.String No description.
street java.lang.String No description.
telephone java.lang.String No description.
userRole java.lang.String No description.
zipCode java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: io.cdktn.cdktn.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: io.cdktn.cdktn.TerraformProviderGeneratorMetadata
connectionOptional 
public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();
  • Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection
countOptional 
public java.lang.Number|TerraformCount getCount();
  • Type: java.lang.Number|io.cdktn.cdktn.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: io.cdktn.cdktn.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: io.cdktn.cdktn.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: io.cdktn.cdktn.TerraformProvider
provisionersOptional 
public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();
  • Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>
disabledDateRequired 
public java.lang.String getDisabledDate();
  • Type: java.lang.String
enabledDateRequired 
public java.lang.String getEnabledDate();
  • Type: java.lang.String
identityProviderIdentityStoreIdRequired 
public java.lang.String getIdentityProviderIdentityStoreId();
  • Type: java.lang.String
mailboxDeprovisionedDateRequired 
public java.lang.String getMailboxDeprovisionedDate();
  • Type: java.lang.String
mailboxProvisionedDateRequired 
public java.lang.String getMailboxProvisionedDate();
  • Type: java.lang.String
stateRequired 
public java.lang.String getState();
  • Type: java.lang.String
userIdRequired 
public java.lang.String getUserId();
  • Type: java.lang.String
cityInputOptional 
public java.lang.String getCityInput();
  • Type: java.lang.String
companyInputOptional 
public java.lang.String getCompanyInput();
  • Type: java.lang.String
countryInputOptional 
public java.lang.String getCountryInput();
  • Type: java.lang.String
departmentInputOptional 
public java.lang.String getDepartmentInput();
  • Type: java.lang.String
displayNameInputOptional 
public java.lang.String getDisplayNameInput();
  • Type: java.lang.String
emailInputOptional 
public java.lang.String getEmailInput();
  • Type: java.lang.String
firstNameInputOptional 
public java.lang.String getFirstNameInput();
  • Type: java.lang.String
hiddenFromGlobalAddressListInputOptional 
public java.lang.Boolean|IResolvable getHiddenFromGlobalAddressListInput();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
identityProviderUserIdInputOptional 
public java.lang.String getIdentityProviderUserIdInput();
  • Type: java.lang.String
initialsInputOptional 
public java.lang.String getInitialsInput();
  • Type: java.lang.String
jobTitleInputOptional 
public java.lang.String getJobTitleInput();
  • Type: java.lang.String
lastNameInputOptional 
public java.lang.String getLastNameInput();
  • Type: java.lang.String
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
officeInputOptional 
public java.lang.String getOfficeInput();
  • Type: java.lang.String
organizationIdInputOptional 
public java.lang.String getOrganizationIdInput();
  • Type: java.lang.String
passwordInputOptional 
public java.lang.String getPasswordInput();
  • Type: java.lang.String
regionInputOptional 
public java.lang.String getRegionInput();
  • Type: java.lang.String
streetInputOptional 
public java.lang.String getStreetInput();
  • Type: java.lang.String
telephoneInputOptional 
public java.lang.String getTelephoneInput();
  • Type: java.lang.String
userRoleInputOptional 
public java.lang.String getUserRoleInput();
  • Type: java.lang.String
zipCodeInputOptional 
public java.lang.String getZipCodeInput();
  • Type: java.lang.String
cityRequired 
public java.lang.String getCity();
  • Type: java.lang.String
companyRequired 
public java.lang.String getCompany();
  • Type: java.lang.String
countryRequired 
public java.lang.String getCountry();
  • Type: java.lang.String
departmentRequired 
public java.lang.String getDepartment();
  • Type: java.lang.String
displayNameRequired 
public java.lang.String getDisplayName();
  • Type: java.lang.String
emailRequired 
public java.lang.String getEmail();
  • Type: java.lang.String
firstNameRequired 
public java.lang.String getFirstName();
  • Type: java.lang.String
hiddenFromGlobalAddressListRequired 
public java.lang.Boolean|IResolvable getHiddenFromGlobalAddressList();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
identityProviderUserIdRequired 
public java.lang.String getIdentityProviderUserId();
  • Type: java.lang.String
initialsRequired 
public java.lang.String getInitials();
  • Type: java.lang.String
jobTitleRequired 
public java.lang.String getJobTitle();
  • Type: java.lang.String
lastNameRequired 
public java.lang.String getLastName();
  • Type: java.lang.String
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
officeRequired 
public java.lang.String getOffice();
  • Type: java.lang.String
organizationIdRequired 
public java.lang.String getOrganizationId();
  • Type: java.lang.String
passwordRequired 
public java.lang.String getPassword();
  • Type: java.lang.String
regionRequired 
public java.lang.String getRegion();
  • Type: java.lang.String
streetRequired 
public java.lang.String getStreet();
  • Type: java.lang.String
telephoneRequired 
public java.lang.String getTelephone();
  • Type: java.lang.String
userRoleRequired 
public java.lang.String getUserRole();
  • Type: java.lang.String
zipCodeRequired 
public java.lang.String getZipCode();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

WorkmailUserConfig

Initializer 

import io.cdktn.providers.aws.workmail_user.WorkmailUserConfig;

WorkmailUserConfig.builder()
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .displayName(java.lang.String)
    .email(java.lang.String)
    .name(java.lang.String)
    .organizationId(java.lang.String)
//  .city(java.lang.String)
//  .company(java.lang.String)
//  .country(java.lang.String)
//  .department(java.lang.String)
//  .firstName(java.lang.String)
//  .hiddenFromGlobalAddressList(java.lang.Boolean|IResolvable)
//  .identityProviderUserId(java.lang.String)
//  .initials(java.lang.String)
//  .jobTitle(java.lang.String)
//  .lastName(java.lang.String)
//  .office(java.lang.String)
//  .password(java.lang.String)
//  .region(java.lang.String)
//  .street(java.lang.String)
//  .telephone(java.lang.String)
//  .userRole(java.lang.String)
//  .zipCode(java.lang.String)
    .build();

Properties

Name Type Description
connection io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection No description.
count java.lang.Number|io.cdktn.cdktn.TerraformCount No description.
dependsOn java.util.List<io.cdktn.cdktn.ITerraformDependable> No description.
forEach io.cdktn.cdktn.ITerraformIterator No description.
lifecycle io.cdktn.cdktn.TerraformResourceLifecycle No description.
provider io.cdktn.cdktn.TerraformProvider No description.
provisioners java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> No description.
displayName java.lang.String Display name of the user.
email java.lang.String Primary email address used to register the user with WorkMail.
name java.lang.String Username of the user.
organizationId java.lang.String Identifier of the WorkMail organization where the user is managed.
city java.lang.String City where the user is located.
company java.lang.String Company associated with the user.
country java.lang.String Country where the user is located.
department java.lang.String Department associated with the user.
firstName java.lang.String First name of the user.
hiddenFromGlobalAddressList java.lang.Boolean|io.cdktn.cdktn.IResolvable Whether to hide the user from the global address list.
identityProviderUserId java.lang.String User ID from IAM Identity Center associated with the user.
initials java.lang.String Initials of the user.
jobTitle java.lang.String Job title of the user.
lastName java.lang.String Last name of the user.
office java.lang.String Office where the user is located.
password java.lang.String Password to set for the user.
region java.lang.String Region where this resource will be managed. Defaults to the Region set in the provider configuration.
street java.lang.String Street address of the user.
telephone java.lang.String Telephone number of the user.
userRole java.lang.String Role assigned to the user.
zipCode java.lang.String ZIP or postal code of the user.
connectionOptional 
public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();
  • Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection
countOptional 
public java.lang.Number|TerraformCount getCount();
  • Type: java.lang.Number|io.cdktn.cdktn.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<io.cdktn.cdktn.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: io.cdktn.cdktn.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: io.cdktn.cdktn.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: io.cdktn.cdktn.TerraformProvider
provisionersOptional 
public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();
  • Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>
displayNameRequired 
public java.lang.String getDisplayName();
  • Type: java.lang.String

Display name of the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#display_name WorkmailUser#display_name}

emailRequired 
public java.lang.String getEmail();
  • Type: java.lang.String

Primary email address used to register the user with WorkMail.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#email WorkmailUser#email}

nameRequired 
public java.lang.String getName();
  • Type: java.lang.String

Username of the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#name WorkmailUser#name}

organizationIdRequired 
public java.lang.String getOrganizationId();
  • Type: java.lang.String

Identifier of the WorkMail organization where the user is managed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#organization_id WorkmailUser#organization_id}

cityOptional 
public java.lang.String getCity();
  • Type: java.lang.String

City where the user is located.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#city WorkmailUser#city}

companyOptional 
public java.lang.String getCompany();
  • Type: java.lang.String

Company associated with the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#company WorkmailUser#company}

countryOptional 
public java.lang.String getCountry();
  • Type: java.lang.String

Country where the user is located.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#country WorkmailUser#country}

departmentOptional 
public java.lang.String getDepartment();
  • Type: java.lang.String

Department associated with the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#department WorkmailUser#department}

firstNameOptional 
public java.lang.String getFirstName();
  • Type: java.lang.String

First name of the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#first_name WorkmailUser#first_name}

hiddenFromGlobalAddressListOptional 
public java.lang.Boolean|IResolvable getHiddenFromGlobalAddressList();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

Whether to hide the user from the global address list.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#hidden_from_global_address_list WorkmailUser#hidden_from_global_address_list}

identityProviderUserIdOptional 
public java.lang.String getIdentityProviderUserId();
  • Type: java.lang.String

User ID from IAM Identity Center associated with the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#identity_provider_user_id WorkmailUser#identity_provider_user_id}

initialsOptional 
public java.lang.String getInitials();
  • Type: java.lang.String

Initials of the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#initials WorkmailUser#initials}

jobTitleOptional 
public java.lang.String getJobTitle();
  • Type: java.lang.String

Job title of the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#job_title WorkmailUser#job_title}

lastNameOptional 
public java.lang.String getLastName();
  • Type: java.lang.String

Last name of the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#last_name WorkmailUser#last_name}

officeOptional 
public java.lang.String getOffice();
  • Type: java.lang.String

Office where the user is located.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#office WorkmailUser#office}

passwordOptional 
public java.lang.String getPassword();
  • Type: java.lang.String

Password to set for the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#password WorkmailUser#password}

regionOptional 
public java.lang.String getRegion();
  • Type: java.lang.String

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#region WorkmailUser#region}

streetOptional 
public java.lang.String getStreet();
  • Type: java.lang.String

Street address of the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#street WorkmailUser#street}

telephoneOptional 
public java.lang.String getTelephone();
  • Type: java.lang.String

Telephone number of the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#telephone WorkmailUser#telephone}

userRoleOptional 
public java.lang.String getUserRole();
  • Type: java.lang.String

Role assigned to the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#user_role WorkmailUser#user_role}

zipCodeOptional 
public java.lang.String getZipCode();
  • Type: java.lang.String

ZIP or postal code of the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workmail_user#zip_code WorkmailUser#zip_code}