software.amazon.awscdk.services.ec2

Class UserData

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ec2.UserData

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

MultipartUserData

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.502Z")
 @Stability(value=Stable)
public abstract class UserData
extends software.amazon.jsii.JsiiObject

Instance User Data.

Example:

 Cluster cluster;
 UserData userData = UserData.forLinux();
 userData.addCommands("set -o xtrace", String.format("/etc/eks/bootstrap.sh %s", cluster.getClusterName()));
 CfnLaunchTemplate lt = CfnLaunchTemplate.Builder.create(this, "LaunchTemplate")
         .launchTemplateData(LaunchTemplateDataProperty.builder()
                 .imageId("some-ami-id") // custom AMI
                 .instanceType("t3.small")
                 .userData(Fn.base64(userData.render()))
                 .build())
         .build();
 cluster.addNodegroupCapacity("extra-ng", NodegroupOptions.builder()
         .launchTemplateSpec(LaunchTemplateSpec.builder()
                 .id(lt.getRef())
                 .version(lt.getAttrLatestVersionNumber())
                 .build())
         .build());
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UserData()
protected	UserData(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	UserData(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

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

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

UserData

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

UserData

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

UserData

@Stability(value=Stable)
protected UserData()

Method Detail

custom

@Stability(value=Stable)
 @NotNull
public static UserData custom(@NotNull
                                                                 String content)

Create a userdata object with custom content.

Parameters:

content - This parameter is required.

forLinux

@Stability(value=Stable)
 @NotNull
public static UserData forLinux(@Nullable
                                                                   LinuxUserDataOptions options)

Create a userdata object for Linux hosts.

Parameters:

options -

forLinux

@Stability(value=Stable)
 @NotNull
public static UserData forLinux()

Create a userdata object for Linux hosts.

forOperatingSystem

@Stability(value=Stable)
 @NotNull
public static UserData forOperatingSystem(@NotNull
                                                                             OperatingSystemType os)

Parameters:

os - This parameter is required.

forWindows

@Stability(value=Stable)
 @NotNull
public static UserData forWindows()

Create a userdata object for Windows hosts.

addCommands

@Stability(value=Stable)
public abstract void addCommands(@NotNull
                                                          String... commands)

Add one or more commands to the user data.

Parameters:

commands - This parameter is required.

addExecuteFileCommand

@Stability(value=Stable)
public abstract void addExecuteFileCommand(@NotNull
                                                                    ExecuteFileOptions params)

Adds commands to execute a file.

Parameters:

params - This parameter is required.

addOnExitCommands

@Stability(value=Stable)
public abstract void addOnExitCommands(@NotNull
                                                                String... commands)

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

Parameters:

commands - This parameter is required.

addS3DownloadCommand

@Stability(value=Stable)
 @NotNull
public abstract String addS3DownloadCommand(@NotNull
                                                                               S3DownloadOptions params)

Adds commands to download a file from S3.

Parameters:

params - This parameter is required.

Returns:

: The local path that the file will be downloaded to

addSignalOnExitCommand

@Stability(value=Stable)
public abstract void addSignalOnExitCommand(@NotNull
                                                                     Resource resource)

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

Parameters:

resource - This parameter is required.

render

@Stability(value=Stable)
 @NotNull
public abstract String render()

Render the UserData for use in a construct.