software.amazon.awscdk.services.ec2

Class InitUser

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ec2.InitElement

software.amazon.awscdk.services.ec2.InitUser

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-18T02:14:09.672Z")
public class InitUser
extends InitElement

Create Linux/UNIX users and to assign user IDs.

Users are created as non-interactive system users with a shell of /sbin/nologin. This is by design and cannot be modified.

Not supported for Windows systems.

Example:

 Vpc vpc;
 InstanceType instanceType;
 IMachineImage machineImage;
 Instance.Builder.create(this, "Instance")
         .vpc(vpc)
         .instanceType(instanceType)
         .machineImage(machineImage)
         // Showing the most complex setup, if you have simpler requirements
         // you can use `CloudFormationInit.fromElements()`.
         .init(CloudFormationInit.fromConfigSets(ConfigSetProps.builder()
                 .configSets(Map.of(
                         // Applies the configs below in this order
                         "default", List.of("yumPreinstall", "config")))
                 .configs(Map.of(
                         "yumPreinstall", new InitConfig(List.of(InitPackage.yum("git"))),
                         "config", new InitConfig(List.of(InitFile.fromObject("/etc/stack.json", Map.of(
                                 "stackId", Stack.of(this).getStackId(),
                                 "stackName", Stack.of(this).getStackName(),
                                 "region", Stack.of(this).getRegion())), InitGroup.fromName("my-group"), InitUser.fromName("my-user"), InitPackage.rpm("http://mirrors.ukfast.co.uk/sites/dl.fedoraproject.org/pub/epel/8/Everything/x86_64/Packages/r/rubygem-git-1.5.0-2.el8.noarch.rpm")))))
                 .build()))
         .initOptions(ApplyCloudFormationInitOptions.builder()
                 // Optional, which configsets to activate (['default'] by default)
                 .configSets(List.of("default"))
                 // Optional, how long the installation is expected to take (5 minutes by default)
                 .timeout(Duration.minutes(30))
                 // Optional, whether to include the --url argument when running cfn-init and cfn-signal commands (false by default)
                 .includeUrl(true)
                 // Optional, whether to include the --role argument when running cfn-init and cfn-signal commands (false by default)
                 .includeRole(true)
                 .build())
         .build();
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InitUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	InitUser(software.amazon.jsii.JsiiObjectRef objRef)
protected	InitUser(java.lang.String userName, InitUserOptions userOptions)

Method Summary

Modifier and Type	Method and Description
static InitUser	fromName(java.lang.String userName) Create a user from user name.
static InitUser	fromName(java.lang.String userName, InitUserOptions options) Create a user from user name.
java.lang.String	getElementType() Returns the init element type for this element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InitUser

protected InitUser(software.amazon.jsii.JsiiObjectRef objRef)

InitUser

protected InitUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

InitUser

protected InitUser(java.lang.String userName,
                   InitUserOptions userOptions)

Parameters:

userName - This parameter is required.

userOptions - This parameter is required.

Method Detail

fromName

public static InitUser fromName(java.lang.String userName,
                                InitUserOptions options)

Create a user from user name.

Parameters:

userName - This parameter is required.

options -

fromName

public static InitUser fromName(java.lang.String userName)

Create a user from user name.

Parameters:

userName - This parameter is required.

getElementType

public java.lang.String getElementType()

Returns the init element type for this element.

Specified by:

getElementType in class InitElement