aws-cdk-lib.aws_ec2.InitUserOptions

InitUserOptions Struct

Optional parameters used when creating a user.

InitUserOptions

used as props by

• InitUser

Source

aws-ec2/lib/cfn-init-elements.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const initUserOptions: ec2.InitUserOptions = {
  groups: ['groups'],
  homeDir: 'homeDir',
  userId: 123,
};

Properties

groupsstring[]groupstyping.List[str]groupsList<String>Groupsstring[]Groups*[]*string#

A list of group names.

Default: the user is not associated with any groups.

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

homeDirstringhome_dirstrhomeDirStringHomeDirstringHomeDir*string#

The user's home directory.

Default: assigned by the OS

userIdnumberuser_idint | floatuserIdNumberUserIddoubleUserId*float64#

A user ID.

Default: assigned by the OS

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.