Class: AWSCDK::Greengrassv2::CfnDeployment::ComponentDeploymentSpecificationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
greengrassv2/cfn_deployment.rb

Overview

Contains information about a component to deploy.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(component_version: nil, configuration_update: nil, run_with: nil) ⇒ ComponentDeploymentSpecificationProperty

Returns a new instance of ComponentDeploymentSpecificationProperty.

Parameters:



674
675
676
677
678
679
680
681
 
# File 'greengrassv2/cfn_deployment.rb', line 674

def initialize(component_version: nil, configuration_update: nil, run_with: nil)
  @component_version = component_version
  Jsii::Type.check_type(@component_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "componentVersion") unless @component_version.nil?
  @configuration_update = configuration_update.is_a?(Hash) ? ::AWSCDK::Greengrassv2::CfnDeployment::ComponentConfigurationUpdateProperty.new(**configuration_update.transform_keys(&:to_sym)) : configuration_update
  Jsii::Type.check_type(@configuration_update, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ncmVlbmdyYXNzdjIuQ2ZuRGVwbG95bWVudC5Db21wb25lbnRDb25maWd1cmF0aW9uVXBkYXRlUHJvcGVydHkifV19fQ==")), "configurationUpdate") unless @configuration_update.nil?
  @run_with = run_with.is_a?(Hash) ? ::AWSCDK::Greengrassv2::CfnDeployment::ComponentRunWithProperty.new(**run_with.transform_keys(&:to_sym)) : run_with
  Jsii::Type.check_type(@run_with, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ncmVlbmdyYXNzdjIuQ2ZuRGVwbG95bWVudC5Db21wb25lbnRSdW5XaXRoUHJvcGVydHkifV19fQ==")), "runWith") unless @run_with.nil?
end

Instance Attribute Details

#component_version ⇒ String? (readonly)

The version of the component.

Returns:

  • (String, nil)

See Also:



687
688
689
 
# File 'greengrassv2/cfn_deployment.rb', line 687

def component_version
  @component_version
end

#configuration_update ⇒ AWSCDK::IResolvable, ... (readonly)

The configuration updates to deploy for the component.

You can define reset updates and merge updates. A reset updates the keys that you specify to the default configuration for the component. A merge updates the core device's component configuration with the keys and values that you specify. The AWS IoT Greengrass Core software applies reset updates before it applies merge updates. For more information, see Update component configuration .

Returns:

See Also:



694
695
696
 
# File 'greengrassv2/cfn_deployment.rb', line 694

def configuration_update
  @configuration_update
end

#run_with ⇒ AWSCDK::IResolvable, ... (readonly)

The system user and group that the software uses to run component processes on the core device.

If you omit this parameter, the software uses the system user and group that you configure for the core device. For more information, see Configure the user and group that run components in the AWS IoT Greengrass V2 Developer Guide .

Returns:

See Also:



701
702
703
 
# File 'greengrassv2/cfn_deployment.rb', line 701

def run_with
  @run_with
end

Class Method Details

.jsii_properties ⇒ Object 



703
704
705
706
707
708
709
 
# File 'greengrassv2/cfn_deployment.rb', line 703

def self.jsii_properties
  {
    :component_version => "componentVersion",
    :configuration_update => "configurationUpdate",
    :run_with => "runWith",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



711
712
713
714
715
716
717
718
719
 
# File 'greengrassv2/cfn_deployment.rb', line 711

def to_jsii
  result = {}
  result.merge!({
    "componentVersion" => @component_version,
    "configurationUpdate" => @configuration_update,
    "runWith" => @run_with,
  })
  result.compact
end