Skip to content

workmailUser.python.md

Latest commit

 

History

History
2138 lines (1355 loc) · 79.8 KB

workmailUser.python.md

File metadata and controls

2138 lines (1355 loc) · 79.8 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 

from cdktn_provider_aws import workmail_user

workmailUser.WorkmailUser(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  display_name: str,
  email: str,
  name: str,
  organization_id: str,
  city: str = None,
  company: str = None,
  country: str = None,
  department: str = None,
  first_name: str = None,
  hidden_from_global_address_list: bool | IResolvable = None,
  identity_provider_user_id: str = None,
  initials: str = None,
  job_title: str = None,
  last_name: str = None,
  office: str = None,
  password: str = None,
  region: str = None,
  street: str = None,
  telephone: str = None,
  user_role: str = None,
  zip_code: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[cdktn.ITerraformDependable] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
display_name str Display name of the user.
email str Primary email address used to register the user with WorkMail.
name str Username of the user.
organization_id str Identifier of the WorkMail organization where the user is managed.
city str City where the user is located.
company str Company associated with the user.
country str Country where the user is located.
department str Department associated with the user.
first_name str First name of the user.
hidden_from_global_address_list bool | cdktn.IResolvable Whether to hide the user from the global address list.
identity_provider_user_id str User ID from IAM Identity Center associated with the user.
initials str Initials of the user.
job_title str Job title of the user.
last_name str Last name of the user.
office str Office where the user is located.
password str Password to set for the user.
region str Region where this resource will be managed. Defaults to the Region set in the provider configuration.
street str Street address of the user.
telephone str Telephone number of the user.
user_role str Role assigned to the user.
zip_code str ZIP or postal code of the user.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional
  • Type: typing.Union[int, float] | cdktn.TerraformCount
depends_onOptional
  • Type: typing.List[cdktn.ITerraformDependable]
for_eachOptional
  • Type: cdktn.ITerraformIterator
lifecycleOptional
  • Type: cdktn.TerraformResourceLifecycle
providerOptional
  • Type: cdktn.TerraformProvider
provisionersOptional
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
display_nameRequired
  • Type: str

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: str

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: str

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}

organization_idRequired
  • Type: str

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: str

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: str

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: str

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: str

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}

first_nameOptional
  • Type: str

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}

hidden_from_global_address_listOptional
  • Type: bool | 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}

identity_provider_user_idOptional
  • Type: str

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: str

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}

job_titleOptional
  • Type: str

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}

last_nameOptional
  • Type: str

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: str

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: str

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: str

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: str

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: str

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}

user_roleOptional
  • Type: str

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}

zip_codeOptional
  • Type: str

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
to_string Returns a string representation of this construct.
with Applies one or more mixins to this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
reset_city No description.
reset_company No description.
reset_country No description.
reset_department No description.
reset_first_name No description.
reset_hidden_from_global_address_list No description.
reset_identity_provider_user_id No description.
reset_initials No description.
reset_job_title No description.
reset_last_name No description.
reset_office No description.
reset_password No description.
reset_region No description.
reset_street No description.
reset_telephone No description.
reset_user_role No description.
reset_zip_code No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

with 
def with(
  mixins: *IMixin
) -> IConstruct

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: *constructs.IMixin

The mixins to apply.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

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

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

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

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktn.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

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: str

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

move_to 
def move_to(
  move_target: str,
  index: str | typing.Union[int, float] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

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

indexOptional
  • Type: str | typing.Union[int, float]

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

move_to_id 
def move_to_id(
  id: str
) -> None

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

idRequired
  • Type: str

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

reset_city 
def reset_city() -> None
reset_company 
def reset_company() -> None
reset_country 
def reset_country() -> None
reset_department 
def reset_department() -> None
reset_first_name 
def reset_first_name() -> None
reset_hidden_from_global_address_list 
def reset_hidden_from_global_address_list() -> None
reset_identity_provider_user_id 
def reset_identity_provider_user_id() -> None
reset_initials 
def reset_initials() -> None
reset_job_title 
def reset_job_title() -> None
reset_last_name 
def reset_last_name() -> None
reset_office 
def reset_office() -> None
reset_password 
def reset_password() -> None
reset_region 
def reset_region() -> None
reset_street 
def reset_street() -> None
reset_telephone 
def reset_telephone() -> None
reset_user_role 
def reset_user_role() -> None
reset_zip_code 
def reset_zip_code() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTN code for importing a WorkmailUser resource upon running "cdktn plan ".
is_construct 
from cdktn_provider_aws import workmail_user

workmailUser.WorkmailUser.is_construct(
  x: typing.Any
)

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: typing.Any

Any object.

is_terraform_element 
from cdktn_provider_aws import workmail_user

workmailUser.WorkmailUser.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktn_provider_aws import workmail_user

workmailUser.WorkmailUser.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktn_provider_aws import workmail_user

workmailUser.WorkmailUser.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

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

import_from_idRequired
  • Type: str

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: cdktn.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktn.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktn.TerraformProviderGeneratorMetadata No description.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[str] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
disabled_date str No description.
enabled_date str No description.
identity_provider_identity_store_id str No description.
mailbox_deprovisioned_date str No description.
mailbox_provisioned_date str No description.
state str No description.
user_id str No description.
city_input str No description.
company_input str No description.
country_input str No description.
department_input str No description.
display_name_input str No description.
email_input str No description.
first_name_input str No description.
hidden_from_global_address_list_input bool | cdktn.IResolvable No description.
identity_provider_user_id_input str No description.
initials_input str No description.
job_title_input str No description.
last_name_input str No description.
name_input str No description.
office_input str No description.
organization_id_input str No description.
password_input str No description.
region_input str No description.
street_input str No description.
telephone_input str No description.
user_role_input str No description.
zip_code_input str No description.
city str No description.
company str No description.
country str No description.
department str No description.
display_name str No description.
email str No description.
first_name str No description.
hidden_from_global_address_list bool | cdktn.IResolvable No description.
identity_provider_user_id str No description.
initials str No description.
job_title str No description.
last_name str No description.
name str No description.
office str No description.
organization_id str No description.
password str No description.
region str No description.
street str No description.
telephone str No description.
user_role str No description.
zip_code str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktn.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktn.TerraformProviderGeneratorMetadata
connectionOptional 
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional 
count: typing.Union[int, float] | TerraformCount
  • Type: typing.Union[int, float] | cdktn.TerraformCount
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktn.TerraformProvider
provisionersOptional 
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
disabled_dateRequired 
disabled_date: str
  • Type: str
enabled_dateRequired 
enabled_date: str
  • Type: str
identity_provider_identity_store_idRequired 
identity_provider_identity_store_id: str
  • Type: str
mailbox_deprovisioned_dateRequired 
mailbox_deprovisioned_date: str
  • Type: str
mailbox_provisioned_dateRequired 
mailbox_provisioned_date: str
  • Type: str
stateRequired 
state: str
  • Type: str
user_idRequired 
user_id: str
  • Type: str
city_inputOptional 
city_input: str
  • Type: str
company_inputOptional 
company_input: str
  • Type: str
country_inputOptional 
country_input: str
  • Type: str
department_inputOptional 
department_input: str
  • Type: str
display_name_inputOptional 
display_name_input: str
  • Type: str
email_inputOptional 
email_input: str
  • Type: str
first_name_inputOptional 
first_name_input: str
  • Type: str
hidden_from_global_address_list_inputOptional 
hidden_from_global_address_list_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
identity_provider_user_id_inputOptional 
identity_provider_user_id_input: str
  • Type: str
initials_inputOptional 
initials_input: str
  • Type: str
job_title_inputOptional 
job_title_input: str
  • Type: str
last_name_inputOptional 
last_name_input: str
  • Type: str
name_inputOptional 
name_input: str
  • Type: str
office_inputOptional 
office_input: str
  • Type: str
organization_id_inputOptional 
organization_id_input: str
  • Type: str
password_inputOptional 
password_input: str
  • Type: str
region_inputOptional 
region_input: str
  • Type: str
street_inputOptional 
street_input: str
  • Type: str
telephone_inputOptional 
telephone_input: str
  • Type: str
user_role_inputOptional 
user_role_input: str
  • Type: str
zip_code_inputOptional 
zip_code_input: str
  • Type: str
cityRequired 
city: str
  • Type: str
companyRequired 
company: str
  • Type: str
countryRequired 
country: str
  • Type: str
departmentRequired 
department: str
  • Type: str
display_nameRequired 
display_name: str
  • Type: str
emailRequired 
email: str
  • Type: str
first_nameRequired 
first_name: str
  • Type: str
hidden_from_global_address_listRequired 
hidden_from_global_address_list: bool | IResolvable
  • Type: bool | cdktn.IResolvable
identity_provider_user_idRequired 
identity_provider_user_id: str
  • Type: str
initialsRequired 
initials: str
  • Type: str
job_titleRequired 
job_title: str
  • Type: str
last_nameRequired 
last_name: str
  • Type: str
nameRequired 
name: str
  • Type: str
officeRequired 
office: str
  • Type: str
organization_idRequired 
organization_id: str
  • Type: str
passwordRequired 
password: str
  • Type: str
regionRequired 
region: str
  • Type: str
streetRequired 
street: str
  • Type: str
telephoneRequired 
telephone: str
  • Type: str
user_roleRequired 
user_role: str
  • Type: str
zip_codeRequired 
zip_code: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

WorkmailUserConfig

Initializer 

from cdktn_provider_aws import workmail_user

workmailUser.WorkmailUserConfig(
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  display_name: str,
  email: str,
  name: str,
  organization_id: str,
  city: str = None,
  company: str = None,
  country: str = None,
  department: str = None,
  first_name: str = None,
  hidden_from_global_address_list: bool | IResolvable = None,
  identity_provider_user_id: str = None,
  initials: str = None,
  job_title: str = None,
  last_name: str = None,
  office: str = None,
  password: str = None,
  region: str = None,
  street: str = None,
  telephone: str = None,
  user_role: str = None,
  zip_code: str = None
)

Properties

Name Type Description
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[cdktn.ITerraformDependable] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
display_name str Display name of the user.
email str Primary email address used to register the user with WorkMail.
name str Username of the user.
organization_id str Identifier of the WorkMail organization where the user is managed.
city str City where the user is located.
company str Company associated with the user.
country str Country where the user is located.
department str Department associated with the user.
first_name str First name of the user.
hidden_from_global_address_list bool | cdktn.IResolvable Whether to hide the user from the global address list.
identity_provider_user_id str User ID from IAM Identity Center associated with the user.
initials str Initials of the user.
job_title str Job title of the user.
last_name str Last name of the user.
office str Office where the user is located.
password str Password to set for the user.
region str Region where this resource will be managed. Defaults to the Region set in the provider configuration.
street str Street address of the user.
telephone str Telephone number of the user.
user_role str Role assigned to the user.
zip_code str ZIP or postal code of the user.
connectionOptional 
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional 
count: typing.Union[int, float] | TerraformCount
  • Type: typing.Union[int, float] | cdktn.TerraformCount
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktn.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktn.TerraformProvider
provisionersOptional 
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
display_nameRequired 
display_name: str
  • Type: str

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 
email: str
  • Type: str

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 
name: str
  • Type: str

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}

organization_idRequired 
organization_id: str
  • Type: str

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 
city: str
  • Type: str

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 
company: str
  • Type: str

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 
country: str
  • Type: str

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 
department: str
  • Type: str

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}

first_nameOptional 
first_name: str
  • Type: str

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}

hidden_from_global_address_listOptional 
hidden_from_global_address_list: bool | IResolvable
  • Type: bool | 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}

identity_provider_user_idOptional 
identity_provider_user_id: str
  • Type: str

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 
initials: str
  • Type: str

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}

job_titleOptional 
job_title: str
  • Type: str

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}

last_nameOptional 
last_name: str
  • Type: str

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 
office: str
  • Type: str

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 
password: str
  • Type: str

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 
region: str
  • Type: str

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 
street: str
  • Type: str

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 
telephone: str
  • Type: str

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}

user_roleOptional 
user_role: str
  • Type: str

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}

zip_codeOptional 
zip_code: str
  • Type: str

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}