AWS CDK Reference

Appearance

v2.275.0

SystemdConfigFileOptions Struct ​

Options for creating a SystemD configuration file.

Source
aws-ec2/lib/cfn-init-elements.ts
Type last changed
v2.140.0 · 2 May 2024

Example ​

ts
declare const vpc: ec2.Vpc;
declare const instanceType: ec2.InstanceType;

new ec2.Instance(this, 'Instance', {
  vpc,
  instanceType,
  machineImage: ec2.MachineImage.latestAmazonLinux2023(),

  init: ec2.CloudFormationInit.fromElements(
    // Create a simple config file that runs a Python web server
    ec2.InitService.systemdConfigFile('simpleserver', {
      command: '/usr/bin/python3 -m http.server 8080',
      cwd: '/var/www/html',
    }),
    // Start the server using SystemD
    ec2.InitService.enable('simpleserver', {
      serviceManager: ec2.ServiceManager.SYSTEMD,
    }),
    // Drop an example file to show the web server working
    ec2.InitFile.fromString('/var/www/html/index.html', 'Hello! It\'s working!'),
  ),
});

Properties ​

afterNetworkoptionalbooleanafter_networkoptionalboolafterNetworkoptionalBooleanAfterNetworkoptionalboolAfterNetworkoptional*bool= true#
Start the service after the networking part of the OS comes up.
commandstringcommandstrcommandStringCommandstringCommand*stringrequired#
The command to run to start this service.
cwdoptionalstringcwdoptionalstrcwdoptionalStringCwdoptionalstringCwdoptional*string#
The working directory for the command.

Default: Root directory or home directory of specified user

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description of this service.

Default: No description

environmentFilesoptionalstring[]environment_filesoptionaltyping.List[str]environmentFilesoptionalList<String>EnvironmentFilesoptionalstring[]EnvironmentFilesoptional*[]*string#
Loads environment variables from files when the process is running.

Default: No environment files

Must use absolute paths.

environmentVariablesoptional{ [key: string]: string }environment_variablesoptionaltyping.Mapping[str, str]environmentVariablesoptionalMap<String, String>EnvironmentVariablesoptionalIDictionary<string, string>EnvironmentVariablesoptional*map[string]*string#
Environment variables to load when the process is running.

Default: No environment variables set

groupoptionalstringgroupoptionalstrgroupoptionalStringGroupoptionalstringGroupoptional*string= root#
The group to execute the process under.
keepRunningoptionalbooleankeep_runningoptionalboolkeepRunningoptionalBooleanKeepRunningoptionalboolKeepRunningoptional*bool= true#
Keep the process running all the time.

Restarts the process when it exits for any reason other than the machine shutting down.

useroptionalstringuseroptionalstruseroptionalStringUseroptionalstringUseroptional*string= root#
The user to execute the process under.