Package software.amazon.awscdk.services.ec2

Interface InitFileOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

InitFileAssetOptions

All Known Implementing Classes:

InitFileAssetOptions.Jsii$Proxy, InitFileOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:39.377Z")
@Stability(Stable)
public interface InitFileOptions
extends software.amazon.jsii.JsiiSerializable

Options for InitFile.

Example:

 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()));
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	InitFileOptions.Builder	A builder for InitFileOptions
static final class	InitFileOptions.Jsii$Proxy	An implementation for InitFileOptions

Method Summary

Modifier and Type	Method	Description
static InitFileOptions.Builder	builder()
default Boolean	getBase64Encoded()	True if the inlined content (from a string or file) should be treated as base64 encoded.
default String	getGroup()	The name of the owning group for this file.
default String	getMode()	A six-digit octal value representing the mode for this file.
default String	getOwner()	The name of the owning user for this file.
default List<InitServiceRestartHandle>	getServiceRestartHandles()	Restart the given service after this file has been written.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBase64Encoded

@Stability(Stable)
@Nullable
default Boolean getBase64Encoded()

True if the inlined content (from a string or file) should be treated as base64 encoded.

Only applicable for inlined string and file content.

Default: false

getGroup

@Stability(Stable)
@Nullable
default String getGroup()

The name of the owning group for this file.

Not supported for Windows systems.

Default: 'root'

getMode

@Stability(Stable)
@Nullable
default String getMode()

A six-digit octal value representing the mode for this file.

Use the first three digits for symlinks and the last three digits for setting permissions. To create a symlink, specify 120xxx, where xxx defines the permissions of the target file. To specify permissions for a file, use the last three digits, such as 000644.

Not supported for Windows systems.

Default: '000644'

getOwner

@Stability(Stable)
@Nullable
default String getOwner()

The name of the owning user for this file.

Not supported for Windows systems.

Default: 'root'

getServiceRestartHandles

@Stability(Stable)
@Nullable
default List<InitServiceRestartHandle> getServiceRestartHandles()

Restart the given service after this file has been written.

Default: - Do not restart any service

builder

@Stability(Stable)
static InitFileOptions.Builder builder()

Returns:

a InitFileOptions.Builder of InitFileOptions