Class: AWSCDK::Greengrassv2::CfnDeployment::ComponentConfigurationUpdateProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Greengrassv2::CfnDeployment::ComponentConfigurationUpdateProperty

Defined in:

greengrassv2/cfn_deployment.rb

Overview

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 .

See Also:

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

Instance Attribute Summary

• #merge ⇒ String^? readonly

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

• #reset ⇒ Array<String>^? readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(merge: nil, reset: nil) ⇒ ComponentConfigurationUpdateProperty constructor

  A new instance of ComponentConfigurationUpdateProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(merge: nil, reset: nil) ⇒ ComponentConfigurationUpdateProperty

Returns a new instance of ComponentConfigurationUpdateProperty.

Parameters:

• merge (String, nil) (defaults to: nil) —

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

• reset (Array<String>, nil) (defaults to: nil) —

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

# File 'greengrassv2/cfn_deployment.rb', line 626

def initialize(merge: nil, reset: nil)
  @merge = merge
  Jsii::Type.check_type(@merge, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "merge") unless @merge.nil?
  @reset = reset
  Jsii::Type.check_type(@reset, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "reset") unless @reset.nil?
end

Instance Attribute Details

#merge ⇒ String^? (readonly)

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 .

Returns:

• (String, nil)

See Also:

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

# File 'greengrassv2/cfn_deployment.rb', line 639

def merge
  @merge
end

#reset ⇒ Array<String>^? (readonly)

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 .

Returns:

• (Array<String>, nil)

See Also:

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

# File 'greengrassv2/cfn_deployment.rb', line 646

def reset
  @reset
end

Class Method Details

.jsii_properties ⇒ Object

# File 'greengrassv2/cfn_deployment.rb', line 648

def self.jsii_properties
  {
    :merge => "merge",
    :reset => "reset",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'greengrassv2/cfn_deployment.rb', line 655

def to_jsii
  result = {}
  result.merge!({
    "merge" => @merge,
    "reset" => @reset,
  })
  result.compact
end