Show / Hide Table of Contents

Class CfnDeploymentPropsMixin.ComponentDeploymentSpecificationProperty

Contains information about a component to deploy.

Inheritance
object
CfnDeploymentPropsMixin.ComponentDeploymentSpecificationProperty
Implements
CfnDeploymentPropsMixin.IComponentDeploymentSpecificationProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.Mixins.Preview.AWS.GreengrassV2.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnDeploymentPropsMixin.ComponentDeploymentSpecificationProperty : CfnDeploymentPropsMixin.IComponentDeploymentSpecificationProperty
Syntax (vb)
Public Class CfnDeploymentPropsMixin.ComponentDeploymentSpecificationProperty Implements CfnDeploymentPropsMixin.IComponentDeploymentSpecificationProperty
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentdeploymentspecification.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.GreengrassV2.Mixins;

             var componentDeploymentSpecificationProperty = new ComponentDeploymentSpecificationProperty {
                 ComponentVersion = "componentVersion",
                 ConfigurationUpdate = new ComponentConfigurationUpdateProperty {
                     Merge = "merge",
                     Reset = new [] { "reset" }
                 },
                 RunWith = new ComponentRunWithProperty {
                     PosixUser = "posixUser",
                     SystemResourceLimits = new SystemResourceLimitsProperty {
                         Cpus = 123,
                         Memory = 123
                     },
                     WindowsUser = "windowsUser"
                 }
             };

Synopsis

Constructors

ComponentDeploymentSpecificationProperty()

Contains information about a component to deploy.

Properties

ComponentVersion

The version of the component.

ConfigurationUpdate

The configuration updates to deploy for the component.

RunWith

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

Constructors

ComponentDeploymentSpecificationProperty()

Contains information about a component to deploy.

public ComponentDeploymentSpecificationProperty()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentdeploymentspecification.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.GreengrassV2.Mixins;

             var componentDeploymentSpecificationProperty = new ComponentDeploymentSpecificationProperty {
                 ComponentVersion = "componentVersion",
                 ConfigurationUpdate = new ComponentConfigurationUpdateProperty {
                     Merge = "merge",
                     Reset = new [] { "reset" }
                 },
                 RunWith = new ComponentRunWithProperty {
                     PosixUser = "posixUser",
                     SystemResourceLimits = new SystemResourceLimitsProperty {
                         Cpus = 123,
                         Memory = 123
                     },
                     WindowsUser = "windowsUser"
                 }
             };

Properties

ComponentVersion

The version of the component.

public string? ComponentVersion { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentdeploymentspecification.html#cfn-greengrassv2-deployment-componentdeploymentspecification-componentversion

ConfigurationUpdate

The configuration updates to deploy for the component.

public object? ConfigurationUpdate { get; set; }
Property Value

object

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentdeploymentspecification.html#cfn-greengrassv2-deployment-componentdeploymentspecification-configurationupdate

Type union: either IResolvable or CfnDeploymentPropsMixin.IComponentConfigurationUpdateProperty

RunWith

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

public object? RunWith { get; set; }
Property Value

object

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentdeploymentspecification.html#cfn-greengrassv2-deployment-componentdeploymentspecification-runwith

Type union: either IResolvable or CfnDeploymentPropsMixin.IComponentRunWithProperty

Implements

CfnDeploymentPropsMixin.IComponentDeploymentSpecificationProperty
Back to top Generated by DocFX