Package software.amazon.awscdk.services.greengrassv2

Interface CfnDeployment.ComponentDeploymentSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeployment.ComponentDeploymentSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnDeployment

@Stability(Stable)
public static interface CfnDeployment.ComponentDeploymentSpecificationProperty
extends software.amazon.jsii.JsiiSerializable

Contains information about a component to deploy.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.greengrassv2.*;
 ComponentDeploymentSpecificationProperty componentDeploymentSpecificationProperty = ComponentDeploymentSpecificationProperty.builder()
         .componentVersion("componentVersion")
         .configurationUpdate(ComponentConfigurationUpdateProperty.builder()
                 .merge("merge")
                 .reset(List.of("reset"))
                 .build())
         .runWith(ComponentRunWithProperty.builder()
                 .posixUser("posixUser")
                 .systemResourceLimits(SystemResourceLimitsProperty.builder()
                         .cpus(123)
                         .memory(123)
                         .build())
                 .windowsUser("windowsUser")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDeployment.ComponentDeploymentSpecificationProperty.Builder	A builder for CfnDeployment.ComponentDeploymentSpecificationProperty
static final class	CfnDeployment.ComponentDeploymentSpecificationProperty.Jsii$Proxy	An implementation for CfnDeployment.ComponentDeploymentSpecificationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDeployment.ComponentDeploymentSpecificationProperty.Builder	builder()
default String	getComponentVersion()	The version of the component.
default Object	getConfigurationUpdate()	The configuration updates to deploy for the component.
default Object	getRunWith()	The system user and group that the software uses to run component processes on the core device.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComponentVersion

@Stability(Stable)
@Nullable
default String getComponentVersion()

The version of the component.

getConfigurationUpdate

@Stability(Stable)
@Nullable
default Object getConfigurationUpdate()

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 .

getRunWith

@Stability(Stable)
@Nullable
default Object getRunWith()

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 .

builder

@Stability(Stable)
static CfnDeployment.ComponentDeploymentSpecificationProperty.Builder builder()

Returns:

a CfnDeployment.ComponentDeploymentSpecificationProperty.Builder of CfnDeployment.ComponentDeploymentSpecificationProperty