Interface CfnDeploymentPropsMixin.IComponentConfigurationUpdateProperty

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

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.GreengrassV2

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public interface CfnDeploymentPropsMixin.IComponentConfigurationUpdateProperty

Syntax (vb)

Public Interface CfnDeploymentPropsMixin.IComponentConfigurationUpdateProperty

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentconfigurationupdate.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.GreengrassV2;

             var componentConfigurationUpdateProperty = new ComponentConfigurationUpdateProperty {
                 Merge = "merge",
                 Reset = new [] { "reset" }
             };

Synopsis

Properties

Merge	A serialized JSON string that contains the configuration object to merge to target devices.
Reset	The list of configuration nodes to reset to default values on target devices.

Properties

Merge

A serialized JSON string that contains the configuration object to merge to target devices.

string? Merge { get; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentconfigurationupdate.html#cfn-greengrassv2-deployment-componentconfigurationupdate-merge

Reset

The list of configuration nodes to reset to default values on target devices.

string[]? Reset { get; }

Property Value

string[]

Remarks

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 .