Skip to content

ComponentDeploymentSpecification

Source code in docs_src/capo_greengrassv2/types/component_deployment_specification.py 
15
16
17
18
19
20
21
22
23
24
25
class ComponentDeploymentSpecification(TypedDict, closed=True):
    component_version: (
        "capo_greengrassv2.types.component_version_string.ComponentVersionString"
    )
    """<p>The version of the component.</p>"""
    configuration_update: NotRequired[
        "capo_greengrassv2.types.component_configuration_update.ComponentConfigurationUpdate"
    ]
    """<p>The configuration updates to deploy for the component. You can define <i>reset</i> updates and <i>merge</i> 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 IoT Greengrass Core software applies reset updates before it applies merge updates. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html">Update component configurations</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>"""
    run_with: NotRequired["capo_greengrassv2.types.component_run_with.ComponentRunWith"]
    """<p>The system user and group that the IoT Greengrass Core software uses to run component processes on the core device. If you omit this parameter, the IoT Greengrass Core software uses the system user and group that you configure for the core device. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user">Configure the user and group that run components</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>"""

component_version instance-attribute 

component_version: ComponentVersionString

The version of the component.

configuration_update instance-attribute 

configuration_update: NotRequired[ComponentConfigurationUpdate]

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 IoT Greengrass Core software applies reset updates before it applies merge updates. For more information, see Update component configurations in the IoT Greengrass V2 Developer Guide.

run_with instance-attribute 

run_with: NotRequired[ComponentRunWith]

The system user and group that the IoT Greengrass Core software uses to run component processes on the core device. If you omit this parameter, the IoT Greengrass Core 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 IoT Greengrass V2 Developer Guide.