Package software.amazon.awscdk.services.ec2

Interface InitUserOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

InitUserOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:50.019Z")
@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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	InitUserOptions.Builder	A builder for InitUserOptions
static final class	InitUserOptions.Jsii$Proxy	An implementation for InitUserOptions

Method Summary

Modifier and Type	Method	Description
static InitUserOptions.Builder	builder()
default List<String>	getGroups()	A list of group names.
default String	getHomeDir()	The user's home directory.
default Number	getUserId()	A user ID.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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