Skip to content
v2.277.0

UserData Class ​

Instance User Data.

Example ​

ts
declare const cluster: eks.Cluster;
const userData = ec2.UserData.forLinux();
userData.addCommands(
  'set -o xtrace',
  `/etc/eks/bootstrap.sh ${cluster.clusterName}`,
);
const lt = new ec2.CfnLaunchTemplate(this, 'LaunchTemplate', {
  launchTemplateData: {
    imageId: 'some-ami-id', // custom AMI
    instanceType: 't3.small',
    userData: Fn.base64(userData.render()),
  },
});
cluster.addNodegroupCapacity('extra-ng', {
  launchTemplateSpec: {
    id: lt.ref,
    version: lt.attrLatestVersionNumber,
  },
});
python
# cluster: eks.Cluster

user_data = ec2.UserData.for_linux()
user_data.add_commands("set -o xtrace", f"/etc/eks/bootstrap.sh {cluster.clusterName}")
lt = ec2.CfnLaunchTemplate(self, "LaunchTemplate",
    launch_template_data=ec2.CfnLaunchTemplate.LaunchTemplateDataProperty(
        image_id="some-ami-id",  # custom AMI
        instance_type="t3.small",
        user_data=Fn.base64(user_data.render())
    )
)
cluster.add_nodegroup_capacity("extra-ng",
    launch_template_spec=eks.LaunchTemplateSpec(
        id=lt.ref,
        version=lt.attr_latest_version_number
    )
)
java
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());
csharp
// Install: dotnet add package Amazon.CDK.Lib
Cluster cluster;

var userData = UserData.ForLinux();
userData.AddCommands("set -o xtrace", $"/etc/eks/bootstrap.sh {cluster.clusterName}");
var lt = new CfnLaunchTemplate(this, "LaunchTemplate", new CfnLaunchTemplateProps {
    LaunchTemplateData = new LaunchTemplateDataProperty {
        ImageId = "some-ami-id",  // custom AMI
        InstanceType = "t3.small",
        UserData = Fn.Base64(userData.Render())
    }
});
cluster.AddNodegroupCapacity("extra-ng", new NodegroupOptions {
    LaunchTemplateSpec = new LaunchTemplateSpec {
        Id = lt.Ref,
        Version = lt.AttrLatestVersionNumber
    }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var cluster Cluster

userData := ec2.UserData_ForLinux()
userData.AddCommands(jsii.String("set -o xtrace"),
fmt.Sprintf("/etc/eks/bootstrap.sh %v", cluster.clusterName))
lt := ec2.NewCfnLaunchTemplate(this, jsii.String("LaunchTemplate"), &CfnLaunchTemplateProps{
	LaunchTemplateData: &LaunchTemplateDataProperty{
		ImageId: jsii.String("some-ami-id"),
		 // custom AMI
		InstanceType: jsii.String("t3.small"),
		UserData: awscdk.Fn_Base64(userData.Render()),
	},
})
cluster.AddNodegroupCapacity(jsii.String("extra-ng"), &NodegroupOptions{
	LaunchTemplateSpec: &LaunchTemplateSpec{
		Id: lt.ref,
		Version: lt.attrLatestVersionNumber,
	},
})

Initializer ​

ts
new UserData()
python
UserData()
java
new UserData()
csharp
new UserData()
go
NewUserData()

Methods ​

addCommands(...commands: string[]): voiddef add_commands(self, commands: str) -> Nonepublic void addCommands(String commands)public void AddCommands(string commands)func AddCommands(Commands *string) #
Add one or more commands to the user data.
addExecuteFileCommand(params: ExecuteFileOptions): voiddef add_execute_file_command(self, params: ExecuteFileOptions) -> Nonepublic void addExecuteFileCommand(ExecuteFileOptions params)public void AddExecuteFileCommand(ExecuteFileOptions params)func AddExecuteFileCommand(Params ExecuteFileOptions) #
Adds commands to execute a file.
addOnExitCommands(...commands: string[]): voiddef add_on_exit_commands(self, commands: str) -> Nonepublic void addOnExitCommands(String commands)public void AddOnExitCommands(string commands)func AddOnExitCommands(Commands *string) #
Add one or more commands to the user data that will run when the script exits.
addS3DownloadCommand(params: S3DownloadOptions): stringdef add_s3_download_command(self, params: S3DownloadOptions) -> strpublic String addS3DownloadCommand(S3DownloadOptions params)public string AddS3DownloadCommand(S3DownloadOptions params)func AddS3DownloadCommand(Params S3DownloadOptions) *string #
Adds commands to download a file from S3.
returns

Returns: : The local path that the file will be downloaded to

addSignalOnExitCommand(resource: Resource): voiddef add_signal_on_exit_command(self, resource: Resource) -> Nonepublic void addSignalOnExitCommand(Resource resource)public void AddSignalOnExitCommand(Resource resource)func AddSignalOnExitCommand(Resource Resource) #
Adds a command which will send a cfn-signal when the user data script ends.
custom(content: string): UserData // chainable@staticmethod def custom(content: str) -> UserDatapublic static UserData custom(String content)public static UserData Custom(string content)func Custom(Content *string) UserData static #
Create a userdata object with custom content.
forLinux(options?: LinuxUserDataOptions): UserData // chainable@staticmethod def for_linux(options: typing.Optional[LinuxUserDataOptions] = None) -> UserDatapublic static UserData forLinux(LinuxUserDataOptions options)public static UserData ForLinux(LinuxUserDataOptions? options = null)func ForLinux(Options LinuxUserDataOptions) UserData static #
Create a userdata object for Linux hosts.
forOperatingSystem(os: OperatingSystemType): UserData // chainable@staticmethod def for_operating_system(os: OperatingSystemType) -> UserDatapublic static UserData forOperatingSystem(OperatingSystemType os)public static UserData ForOperatingSystem(OperatingSystemType os)func ForOperatingSystem(Os OperatingSystemType) UserData static #
forWindows(options?: WindowsUserDataOptions): UserData // chainable@staticmethod def for_windows(options: typing.Optional[WindowsUserDataOptions] = None) -> UserDatapublic static UserData forWindows(WindowsUserDataOptions options)public static UserData ForWindows(WindowsUserDataOptions? options = null)func ForWindows(Options WindowsUserDataOptions) UserData static #
Create a userdata object for Windows hosts.
render(): stringdef render(self, ) -> strpublic String render()public string Render()func Render() *string #
Render the UserData for use in a construct.