InitUserOptions

class aws_cdk.aws_ec2.InitUserOptions(*, groups=None, home_dir=None, user_id=None)

Bases: object

Optional parameters used when creating a user.

Parameters:
  • groups (Optional[Sequence[str]]) – A list of group names. The user will be added to each group in the list. Default: the user is not associated with any groups.

  • home_dir (Optional[str]) – The user’s home directory. Default: assigned by the OS

  • user_id (Union[int, float, None]) – A user ID. The creation process fails if the user name exists with a different user ID. If the user ID is already assigned to an existing user the operating system may reject the creation request. Default: assigned by the OS

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

init_user_options = ec2.InitUserOptions(
    groups=["groups"],
    home_dir="homeDir",
    user_id=123
)

Attributes

groups

A list of group names.

The user will be added to each group in the list.

Default:

the user is not associated with any groups.

home_dir

The user’s home directory.

Default:

assigned by the OS

user_id

A user ID.

The creation process fails if the user name exists with a different user ID. If the user ID is already assigned to an existing user the operating system may reject the creation request.

Default:

assigned by the OS