ComponentConfigurationUpdate - Amazon IoT Greengrass
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

ComponentConfigurationUpdate

Contains information about a deployment's update to a component's configuration on Greengrass core devices. For more information, see Update component configurations in the Amazon IoT Greengrass V2 Developer Guide.

Contents

merge

A serialized JSON string that contains the configuration object to merge to target devices. The core device merges this configuration with the component's existing configuration. If this is the first time a component deploys on a device, the core device merges this configuration with the component's default configuration. This means that the core device keeps it's existing configuration for keys and values that you don't specify in this object. For more information, see Merge configuration updates in the Amazon IoT Greengrass V2 Developer Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10485760.

Required: No

reset

The list of configuration nodes to reset to default values on target devices. Use JSON pointers to specify each node to reset. JSON pointers start with a forward slash (/) and use forward slashes to separate the key for each level in the object. For more information, see the JSON pointer specification and Reset configuration updates in the Amazon IoT Greengrass V2 Developer Guide.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: