# InitServiceOptions

Options for an InitService.

Used as argument in: [InitService.enable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.InitService.html#enable)

- Source: [`aws-ec2/lib/cfn-init-elements.ts`](https://github.com/aws/aws-cdk/blob/v2.278.0/packages/aws-cdk-lib/aws-ec2/lib/cfn-init-elements.ts#L750)
- Type last changed: v2.70.0 · 22 Mar 2023

## Example

TypeScript:

```ts
declare const myBucket: s3.Bucket;

const handle = new ec2.InitServiceRestartHandle();

ec2.CloudFormationInit.fromElements(
  ec2.InitFile.fromString('/etc/nginx/nginx.conf', '...', { serviceRestartHandles: [handle] }),
  ec2.InitSource.fromS3Object('/var/www/html', myBucket, 'html.zip', { serviceRestartHandles: [handle] }),
  ec2.InitService.enable('nginx', {
    serviceRestartHandle: handle,
  })
);
```

Python:

```python
# my_bucket: s3.Bucket

handle = ec2.InitServiceRestartHandle()

ec2.CloudFormationInit.from_elements(
    ec2.InitFile.from_string("/etc/nginx/nginx.conf", "...", service_restart_handles=[handle]),
    ec2.InitSource.from_s3_object("/var/www/html", my_bucket, "html.zip", service_restart_handles=[handle]),
    ec2.InitService.enable("nginx",
        service_restart_handle=handle
    ))
```

Java:

```java
Bucket myBucket;

InitServiceRestartHandle handle = new InitServiceRestartHandle();

CloudFormationInit.fromElements(InitFile.fromString("/etc/nginx/nginx.conf", "...", InitFileOptions.builder().serviceRestartHandles(List.of(handle)).build()), InitSource.fromS3Object("/var/www/html", myBucket, "html.zip", InitSourceOptions.builder().serviceRestartHandles(List.of(handle)).build()), InitService.enable("nginx", InitServiceOptions.builder()
        .serviceRestartHandle(handle)
        .build()));
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
Bucket myBucket;

var handle = new InitServiceRestartHandle();

CloudFormationInit.FromElements(InitFile.FromString("/etc/nginx/nginx.conf", "...", new InitFileOptions { ServiceRestartHandles = new [] { handle } }), InitSource.FromS3Object("/var/www/html", myBucket, "html.zip", new InitSourceOptions { ServiceRestartHandles = new [] { handle } }), InitService.Enable("nginx", new InitServiceOptions {
    ServiceRestartHandle = handle
}));
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var myBucket Bucket

handle := ec2.NewInitServiceRestartHandle()

ec2.CloudFormationInit_FromElements(ec2.InitFile_FromString(jsii.String("/etc/nginx/nginx.conf"), jsii.String("..."), &InitFileOptions{
	ServiceRestartHandles: []InitServiceRestartHandle{
		handle,
	},
}), ec2.InitSource_FromS3Object(jsii.String("/var/www/html"), myBucket, jsii.String("html.zip"), &InitSourceOptions{
	ServiceRestartHandles: []InitServiceRestartHandle{
		handle,
	},
}), ec2.InitService_Enable(jsii.String("nginx"), &InitServiceOptions{
	ServiceRestartHandle: handle,
}))
```

## Properties

- `enabled`: boolean — Enable or disable this service.

  **Default:** true if used in `InitService.enable()`, no change to service state if used in `InitService.fromOptions()`.

  Set to true to ensure that the service will be started automatically upon boot.

  Set to false to ensure that the service will not be started automatically upon boot.

- `ensureRunning`: boolean — Make sure this service is running or not running after cfn-init finishes.

  **Default:** same value as `enabled`.

  Set to true to ensure that the service is running after cfn-init finishes.

  Set to false to ensure that the service is not running after cfn-init finishes.

- `serviceManager`: [ServiceManager](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.ServiceManager.html) — What service manager to use.

  **Default:** ServiceManager.SYSVINIT for Linux images, ServiceManager.WINDOWS for Windows images

  This needs to match the actual service manager on your Operating System.
  For example, Amazon Linux 1 uses SysVinit, but Amazon Linux 2 uses Systemd.

- `serviceRestartHandle`: [InitServiceRestartHandle](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.InitServiceRestartHandle.html) — Restart service when the actions registered into the restartHandle have been performed.

  **Default:** No files trigger restart

  Register actions into the restartHandle by passing it to `InitFile`, `InitCommand`,
  `InitPackage` and `InitSource` objects.
