class UserData

Language	Type name
.NET	Amazon.CDK.AWS.EC2.UserData
Java	software.amazon.awscdk.services.ec2.UserData
Python	aws_cdk.aws_ec2.UserData
TypeScript (source)	@aws-cdk/aws-ec2 » UserData

Implemented by MultipartUserData

Instance User Data.

Example

const multipartUserData = new ec2.MultipartUserData();
const commandsUserData = ec2.UserData.forLinux();
multipartUserData.addUserDataPart(commandsUserData, ec2.MultipartBody.SHELL_SCRIPT, true);

// Adding commands to the multipartUserData adds them to commandsUserData, and vice-versa.
multipartUserData.addCommands('touch /root/multi.txt');
commandsUserData.addCommands('touch /root/userdata.txt');

Initializer

new UserData()

Methods

Name	Description
addCommands(...commands)	Add one or more commands to the user data.
addExecuteFileCommand(params)	Adds commands to execute a file.
addOnExitCommands(...commands)	Add one or more commands to the user data that will run when the script exits.
addS3DownloadCommand(params)	Adds commands to download a file from S3.
addSignalOnExitCommand(resource)	Adds a command which will send a cfn-signal when the user data script ends.
render()	Render the UserData for use in a construct.
static custom(content)	Create a userdata object with custom content.
static forLinux(options?)	Create a userdata object for Linux hosts.
static forOperatingSystem(os)
static forWindows()	Create a userdata object for Windows hosts.

---

addCommands(...commands)

public addCommands(...commands: string[]): void

Parameters

• commands string

Add one or more commands to the user data.

---

addExecuteFileCommand(params)

public addExecuteFileCommand(params: ExecuteFileOptions): void

Parameters

• params ExecuteFileOptions

Adds commands to execute a file.

---

addOnExitCommands(...commands)

public addOnExitCommands(...commands: string[]): void

Parameters

• commands string

Add one or more commands to the user data that will run when the script exits.

---

addS3DownloadCommand(params)

public addS3DownloadCommand(params: S3DownloadOptions): string

Parameters

• params S3DownloadOptions

Returns

• string

Adds commands to download a file from S3.

---

addSignalOnExitCommand(resource)

public addSignalOnExitCommand(resource: Resource): void

Parameters

• resource Resource

Adds a command which will send a cfn-signal when the user data script ends.

---

render()

public render(): string

Returns

• string

Render the UserData for use in a construct.

---

static custom(content)

public static custom(content: string): UserData

Parameters

• content string

Returns

• UserData

Create a userdata object with custom content.

---

static forLinux(options?)

public static forLinux(options?: LinuxUserDataOptions): UserData

Parameters

• options LinuxUserDataOptions

Returns

• UserData

Create a userdata object for Linux hosts.

---

static forOperatingSystem(os)

public static forOperatingSystem(os: OperatingSystemType): UserData

Parameters

• os OperatingSystemType

Returns

• UserData

---

static forWindows()

public static forWindows(): UserData

Returns

• UserData

Create a userdata object for Windows hosts.