Interface InitUserOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
InitUserOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:39.394Z") @Stability(Stable) public interface InitUserOptions extends software.amazon.jsii.JsiiSerializable
Optional parameters used when creating a user.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 InitUserOptions initUserOptions = InitUserOptions.builder()
         .groups(List.of("groups"))
         .homeDir("homeDir")
         .userId(123)
         .build();
 
  • Method Details

    • getGroups

      @Stability(Stable) @Nullable default List<String> getGroups()
      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.

    • getHomeDir

      @Stability(Stable) @Nullable default String getHomeDir()
      The user's home directory.

      Default: assigned by the OS

    • getUserId

      @Stability(Stable) @Nullable default Number getUserId()
      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

    • builder

      @Stability(Stable) static InitUserOptions.Builder builder()
      Returns:
      a InitUserOptions.Builder of InitUserOptions