1.204.0

interface ComponentDeploymentSpecificationProperty

LanguageType name
.NETAmazon.CDK.AWS.GreengrassV2.CfnDeployment.ComponentDeploymentSpecificationProperty
Javasoftware.amazon.awscdk.services.greengrassv2.CfnDeployment.ComponentDeploymentSpecificationProperty
Pythonaws_cdk.aws_greengrassv2.CfnDeployment.ComponentDeploymentSpecificationProperty
TypeScript @aws-cdk/aws-greengrassv2 » CfnDeployment » ComponentDeploymentSpecificationProperty

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 * as greengrassv2 from '@aws-cdk/aws-greengrassv2';
const componentDeploymentSpecificationProperty: greengrassv2.CfnDeployment.ComponentDeploymentSpecificationProperty = {
  componentVersion: 'componentVersion',
  configurationUpdate: {
    merge: 'merge',
    reset: ['reset'],
  },
  runWith: {
    posixUser: 'posixUser',
    systemResourceLimits: {
      cpus: 123,
      memory: 123,
    },
    windowsUser: 'windowsUser',
  },
};

Properties

NameTypeDescription
componentVersion?stringThe version of the component.
configurationUpdate?IResolvable | ComponentConfigurationUpdatePropertyThe configuration updates to deploy for the component.
runWith?IResolvable | ComponentRunWithPropertyThe system user and group that the software uses to run component processes on the core device.

componentVersion?

Type: string (optional)

The version of the component.

configurationUpdate?

Type: IResolvable | ComponentConfigurationUpdateProperty (optional)

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 .

runWith?

Type: IResolvable | ComponentRunWithProperty (optional)

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 .

← PreviousNext →