Skip to content

AdditionalInstanceConfiguration

Source code in docs_src/capo_imagebuilder/types/additional_instance_configuration.py
class AdditionalInstanceConfiguration(TypedDict, closed=True):
    systems_manager_agent: NotRequired[
        "capo_imagebuilder.types.systems_manager_agent.SystemsManagerAgent"
    ]
    """<p>The Systems Manager agent settings for your build instance. This setting applies to Linux and macOS build instances only. Requests that set it for a recipe with a Windows base image are rejected.</p>"""
    user_data_override: NotRequired[
        "capo_imagebuilder.types.user_data_override.UserDataOverride"
    ]
    """<p>Use this property to provide commands or a command script to run when you launch your build instance.</p> <p>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.</p> <note> <p>The user data is always base 64 encoded. For example, the following commands are encoded as <code>IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhcg==</code>:</p> <p> <i>#!/bin/bash</i> </p> <p>mkdir -p /var/bb/</p> <p>touch /var</p> </note>"""

systems_manager_agent instance-attribute

systems_manager_agent: NotRequired[SystemsManagerAgent]

The Systems Manager agent settings for your build instance. This setting applies to Linux and macOS build instances only. Requests that set it for a recipe with a Windows base image are rejected.

user_data_override instance-attribute

user_data_override: NotRequired[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 IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhcg==:

#!/bin/bash

mkdir -p /var/bb/

touch /var