com.amazonaws.services.imagebuilder.model

Class AdditionalInstanceConfiguration

java.lang.Object

com.amazonaws.services.imagebuilder.model.AdditionalInstanceConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AdditionalInstanceConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

In addition to your infrastructure configuration, these settings provide an extra layer of control over your build instances. You can also specify commands to run on launch for all of your build instances.

Image Builder does not automatically install the Systems Manager agent on Windows instances. If your base image includes the Systems Manager agent, then the AMI that you create will also include the agent. For Linux instances, if the base image does not already include the Systems Manager agent, Image Builder installs it. For Linux instances where Image Builder installs the Systems Manager agent, you can choose whether to keep it for the AMI that you create.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdditionalInstanceConfiguration()

Method Summary

Modifier and Type	Method and Description
AdditionalInstanceConfiguration	clone()
boolean	equals(Object obj)
SystemsManagerAgent	getSystemsManagerAgent() Contains settings for the Systems Manager agent on your build instance.
String	getUserDataOverride() Use this property to provide commands or a command script to run when you launch your build instance.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setSystemsManagerAgent(SystemsManagerAgent systemsManagerAgent) Contains settings for the Systems Manager agent on your build instance.
void	setUserDataOverride(String userDataOverride) Use this property to provide commands or a command script to run when you launch your build instance.
String	toString() Returns a string representation of this object.
AdditionalInstanceConfiguration	withSystemsManagerAgent(SystemsManagerAgent systemsManagerAgent) Contains settings for the Systems Manager agent on your build instance.
AdditionalInstanceConfiguration	withUserDataOverride(String userDataOverride) Use this property to provide commands or a command script to run when you launch your build instance.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AdditionalInstanceConfiguration

public AdditionalInstanceConfiguration()

Method Detail

setSystemsManagerAgent

public void setSystemsManagerAgent(SystemsManagerAgent systemsManagerAgent)

Contains settings for the Systems Manager agent on your build instance.

Parameters:

systemsManagerAgent - Contains settings for the Systems Manager agent on your build instance.

getSystemsManagerAgent

public SystemsManagerAgent getSystemsManagerAgent()

Contains settings for the Systems Manager agent on your build instance.

Returns:

Contains settings for the Systems Manager agent on your build instance.

withSystemsManagerAgent

public AdditionalInstanceConfiguration withSystemsManagerAgent(SystemsManagerAgent systemsManagerAgent)

Contains settings for the Systems Manager agent on your build instance.

Parameters:

systemsManagerAgent - Contains settings for the Systems Manager agent on your build instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

setUserDataOverride

public void setUserDataOverride(String userDataOverride)

Use this property to provide commands or a command script to run when you launch your build instance.

The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.

The user data is always base 64 encoded. For example, the following commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$:

#!/bin/bash

mkdir -p /var/bb/

touch /var

Parameters:

userDataOverride - Use this property to provide commands or a command script to run when you launch your build instance.

The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.

The user data is always base 64 encoded. For example, the following commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$:

#!/bin/bash

mkdir -p /var/bb/

touch /var

getUserDataOverride

public String getUserDataOverride()

Use this property to provide commands or a command script to run when you launch your build instance.

The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.

The user data is always base 64 encoded. For example, the following commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$:

#!/bin/bash

mkdir -p /var/bb/

touch /var

Returns:

Use this property to provide commands or a command script to run when you launch your build instance.

The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.

The user data is always base 64 encoded. For example, the following commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$:

#!/bin/bash

mkdir -p /var/bb/

touch /var

withUserDataOverride

public AdditionalInstanceConfiguration withUserDataOverride(String userDataOverride)

Use this property to provide commands or a command script to run when you launch your build instance.

The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.

The user data is always base 64 encoded. For example, the following commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$:

#!/bin/bash

mkdir -p /var/bb/

touch /var

Parameters:

userDataOverride - Use this property to provide commands or a command script to run when you launch your build instance.

The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.

The user data is always base 64 encoded. For example, the following commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$:

#!/bin/bash

mkdir -p /var/bb/

touch /var

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AdditionalInstanceConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.