Package software.amazon.awscdk.services.greengrassv2

Interface CfnDeployment.ComponentConfigurationUpdateProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeployment.ComponentConfigurationUpdateProperty.Jsii$Proxy

Enclosing class:

CfnDeployment

@Stability(Stable)
public static interface CfnDeployment.ComponentConfigurationUpdateProperty
extends software.amazon.jsii.JsiiSerializable

Contains information about a deployment's update to a component's configuration on AWS IoT Greengrass core devices.

For more information, see Update component configurations in the AWS IoT Greengrass V2 Developer Guide .

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.greengrassv2.*;
 ComponentConfigurationUpdateProperty componentConfigurationUpdateProperty = ComponentConfigurationUpdateProperty.builder()
         .merge("merge")
         .reset(List.of("reset"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDeployment.ComponentConfigurationUpdateProperty.Builder	A builder for CfnDeployment.ComponentConfigurationUpdateProperty
static final class	CfnDeployment.ComponentConfigurationUpdateProperty.Jsii$Proxy	An implementation for CfnDeployment.ComponentConfigurationUpdateProperty

Method Summary

Modifier and Type	Method	Description
static CfnDeployment.ComponentConfigurationUpdateProperty.Builder	builder()
default String	getMerge()	A serialized JSON string that contains the configuration object to merge to target devices.
default List<String>	getReset()	The list of configuration nodes to reset to default values on target devices.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMerge

@Stability(Stable)
@Nullable
default String getMerge()

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 AWS IoT Greengrass V2 Developer Guide .

getReset

@Stability(Stable)
@Nullable
default List<String> getReset()

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 AWS IoT Greengrass V2 Developer Guide .

builder

@Stability(Stable)
static CfnDeployment.ComponentConfigurationUpdateProperty.Builder builder()

Returns:

a CfnDeployment.ComponentConfigurationUpdateProperty.Builder of CfnDeployment.ComponentConfigurationUpdateProperty