software.amazon.awscdk.services.imagebuilder

Interface CfnImageRecipe.AdditionalInstanceConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnImageRecipe.AdditionalInstanceConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnImageRecipe

@Stability(value=Stable)
public static interface CfnImageRecipe.AdditionalInstanceConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

In addition to your infrastruction configuration, these settings provide an extra layer of control over your build instances.

For instances where Image Builder installs the Systems Manager agent, you can choose whether to keep it for the AMI that you create. You can also specify commands to run on launch for all of your build instances.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.imagebuilder.*;
 AdditionalInstanceConfigurationProperty additionalInstanceConfigurationProperty = AdditionalInstanceConfigurationProperty.builder()
         .systemsManagerAgent(SystemsManagerAgentProperty.builder()
                 .uninstallAfterBuild(false)
                 .build())
         .userDataOverride("userDataOverride")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnImageRecipe.AdditionalInstanceConfigurationProperty.Builder	builder()
default Object	getSystemsManagerAgent() Contains settings for the Systems Manager agent on your build instance.
default String	getUserDataOverride() Use this property to provide commands or a command script to run when you launch your build instance.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSystemsManagerAgent

@Stability(value=Stable)
 @Nullable
default Object getSystemsManagerAgent()

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

getUserDataOverride

@Stability(value=Stable)
 @Nullable
default 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.

builder

@Stability(value=Stable)
static CfnImageRecipe.AdditionalInstanceConfigurationProperty.Builder builder()

Returns:

a CfnImageRecipe.AdditionalInstanceConfigurationProperty.Builder of CfnImageRecipe.AdditionalInstanceConfigurationProperty