software.amazon.awscdk.services.ec2

Class MultipartUserData

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ec2.UserData

software.amazon.awscdk.services.ec2.MultipartUserData

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.484Z")
 @Stability(value=Stable)
public class MultipartUserData
extends UserData

Mime multipart user data.

This class represents MIME multipart user data, as described in. Specifying Multiple User Data Blocks Using a MIME Multi Part Archive

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 UserData bootHookConf = UserData.forLinux();
 bootHookConf.addCommands("cloud-init-per once docker_options echo 'OPTIONS=\"${OPTIONS} --storage-opt dm.basesize=40G\"' >> /etc/sysconfig/docker");
 UserData setupCommands = UserData.forLinux();
 setupCommands.addCommands("sudo yum install awscli && echo Packages installed らと > /var/tmp/setup");
 MultipartUserData multipartUserData = new MultipartUserData();
 // The docker has to be configured at early stage, so content type is overridden to boothook
 multipartUserData.addPart(MultipartBody.fromUserData(bootHookConf, "text/cloud-boothook; charset=\"us-ascii\""));
 // Execute the rest of setup
 multipartUserData.addPart(MultipartBody.fromUserData(setupCommands));
 LaunchTemplate.Builder.create(this, "")
         .userData(multipartUserData)
         .blockDevices(List.of())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultipartUserData.Builder A fluent builder for MultipartUserData.

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addCommands(String... commands) Add one or more commands to the user data.
void	addExecuteFileCommand(ExecuteFileOptions params) Adds commands to execute a file.
void	addOnExitCommands(String... commands) Add one or more commands to the user data that will run when the script exits.
void	addPart(MultipartBody part) Adds a part to the list of parts.
String	addS3DownloadCommand(S3DownloadOptions params) Adds commands to download a file from S3.
void	addSignalOnExitCommand(Resource resource) Adds a command which will send a cfn-signal when the user data script ends.
void	addUserDataPart(UserData userData) Adds a multipart part based on a UserData object.
void	addUserDataPart(UserData userData, String contentType) Adds a multipart part based on a UserData object.
void	addUserDataPart(UserData userData, String contentType, Boolean makeDefault) Adds a multipart part based on a UserData object.
String	render() Render the UserData for use in a construct.

Methods inherited from class software.amazon.awscdk.services.ec2.UserData

custom, forLinux, forLinux, forOperatingSystem, forWindows

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

MultipartUserData

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

MultipartUserData

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

MultipartUserData

@Stability(value=Stable)
public MultipartUserData(@Nullable
                                                  MultipartUserDataOptions opts)

Parameters:

opts -

MultipartUserData

@Stability(value=Stable)
public MultipartUserData()

Method Detail

addCommands

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

Add one or more commands to the user data.

Specified by:

addCommands in class UserData

Parameters:

commands - This parameter is required.

addExecuteFileCommand

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

Adds commands to execute a file.

Specified by:

addExecuteFileCommand in class UserData

Parameters:

params - This parameter is required.

addOnExitCommands

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

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

Specified by:

addOnExitCommands in class UserData

Parameters:

commands - This parameter is required.

addPart

@Stability(value=Stable)
public void addPart(@NotNull
                                             MultipartBody part)

Adds a part to the list of parts.

Parameters:

part - This parameter is required.

addS3DownloadCommand

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

Adds commands to download a file from S3.

Specified by:

addS3DownloadCommand in class UserData

Parameters:

params - This parameter is required.

Returns:

: The local path that the file will be downloaded to

addSignalOnExitCommand

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

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

Specified by:

addSignalOnExitCommand in class UserData

Parameters:

resource - This parameter is required.

addUserDataPart

@Stability(value=Stable)
public void addUserDataPart(@NotNull
                                                     UserData userData,
                                                     @Nullable
                                                     String contentType,
                                                     @Nullable
                                                     Boolean makeDefault)

Adds a multipart part based on a UserData object.

If makeDefault is true, then the UserData added by this method will also be the target of calls to the add*Command methods on this MultipartUserData object.

If makeDefault is false, then this is the same as calling:

 // Example automatically generated from non-compiling source. May contain errors.
 MultipartUserData multiPart;
 UserData userData;
 String contentType;
 multiPart.addPart(MultipartBody.fromUserData(userData, contentType));
 

An undefined makeDefault defaults to either:

• true if no default UserData has been set yet; or
• false if there is no default UserData set.

Parameters:

userData - This parameter is required.

contentType -

makeDefault -

addUserDataPart

@Stability(value=Stable)
public void addUserDataPart(@NotNull
                                                     UserData userData,
                                                     @Nullable
                                                     String contentType)

Adds a multipart part based on a UserData object.

If makeDefault is true, then the UserData added by this method will also be the target of calls to the add*Command methods on this MultipartUserData object.

If makeDefault is false, then this is the same as calling:

 // Example automatically generated from non-compiling source. May contain errors.
 MultipartUserData multiPart;
 UserData userData;
 String contentType;
 multiPart.addPart(MultipartBody.fromUserData(userData, contentType));
 

An undefined makeDefault defaults to either:

• true if no default UserData has been set yet; or
• false if there is no default UserData set.

Parameters:

userData - This parameter is required.

contentType -

addUserDataPart

@Stability(value=Stable)
public void addUserDataPart(@NotNull
                                                     UserData userData)

Adds a multipart part based on a UserData object.

If makeDefault is true, then the UserData added by this method will also be the target of calls to the add*Command methods on this MultipartUserData object.

If makeDefault is false, then this is the same as calling:

 // Example automatically generated from non-compiling source. May contain errors.
 MultipartUserData multiPart;
 UserData userData;
 String contentType;
 multiPart.addPart(MultipartBody.fromUserData(userData, contentType));
 

An undefined makeDefault defaults to either:

• true if no default UserData has been set yet; or
• false if there is no default UserData set.

Parameters:

userData - This parameter is required.

render

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

Render the UserData for use in a construct.

Specified by:

render in class UserData