amazonka-greengrassv2-2.0: Amazon IoT Greengrass V2 SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.GreengrassV2.Types.ComponentDeploymentSpecification

Description

 
Synopsis

Documentation

data ComponentDeploymentSpecification Source #

Contains information about a component to deploy.

See: newComponentDeploymentSpecification smart constructor.

Constructors

ComponentDeploymentSpecification' 

Fields

  • componentVersion :: Maybe Text

    The version of the component.

  • configurationUpdate :: Maybe 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.

  • runWith :: Maybe 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.

Instances

Instances details
FromJSON ComponentDeploymentSpecification Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.ComponentDeploymentSpecification

ToJSON ComponentDeploymentSpecification Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.ComponentDeploymentSpecification

Generic ComponentDeploymentSpecification Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.ComponentDeploymentSpecification

Associated Types

type Rep ComponentDeploymentSpecification :: Type -> Type #

Read ComponentDeploymentSpecification Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.ComponentDeploymentSpecification

Show ComponentDeploymentSpecification Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.ComponentDeploymentSpecification

NFData ComponentDeploymentSpecification Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.ComponentDeploymentSpecification

Eq ComponentDeploymentSpecification Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.ComponentDeploymentSpecification

Hashable ComponentDeploymentSpecification Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.ComponentDeploymentSpecification

type Rep ComponentDeploymentSpecification Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.ComponentDeploymentSpecification

type Rep ComponentDeploymentSpecification = D1 ('MetaData "ComponentDeploymentSpecification" "Amazonka.GreengrassV2.Types.ComponentDeploymentSpecification" "amazonka-greengrassv2-2.0-CXiJQl197i43YI1Cz5IpiZ" 'False) (C1 ('MetaCons "ComponentDeploymentSpecification'" 'PrefixI 'True) (S1 ('MetaSel ('Just "componentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "configurationUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComponentConfigurationUpdate)) :*: S1 ('MetaSel ('Just "runWith") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComponentRunWith)))))

newComponentDeploymentSpecification :: ComponentDeploymentSpecification Source #

Create a value of ComponentDeploymentSpecification with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:componentVersion:ComponentDeploymentSpecification', componentDeploymentSpecification_componentVersion - The version of the component.

$sel:configurationUpdate:ComponentDeploymentSpecification', componentDeploymentSpecification_configurationUpdate - 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.

$sel:runWith:ComponentDeploymentSpecification', componentDeploymentSpecification_runWith - 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.

componentDeploymentSpecification_configurationUpdate :: Lens' ComponentDeploymentSpecification (Maybe ComponentConfigurationUpdate) Source #

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.

componentDeploymentSpecification_runWith :: Lens' ComponentDeploymentSpecification (Maybe ComponentRunWith) Source #

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.