Class CfnDeploymentProps
Properties for defining a CfnDeployment
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.GreengrassV2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDeploymentProps : Object, ICfnDeploymentProps
Syntax (vb)
Public Class CfnDeploymentProps
Inherits Object
Implements ICfnDeploymentProps
Remarks
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.AWS.GreengrassV2;
var rateIncreaseCriteria;
var cfnDeploymentProps = new CfnDeploymentProps {
TargetArn = "targetArn",
// the properties below are optional
Components = new Dictionary<string, object> {
{ "componentsKey", 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"
}
} }
},
DeploymentName = "deploymentName",
DeploymentPolicies = new DeploymentPoliciesProperty {
ComponentUpdatePolicy = new DeploymentComponentUpdatePolicyProperty {
Action = "action",
TimeoutInSeconds = 123
},
ConfigurationValidationPolicy = new DeploymentConfigurationValidationPolicyProperty {
TimeoutInSeconds = 123
},
FailureHandlingPolicy = "failureHandlingPolicy"
},
IotJobConfiguration = new DeploymentIoTJobConfigurationProperty {
AbortConfig = new IoTJobAbortConfigProperty {
CriteriaList = new [] { new IoTJobAbortCriteriaProperty {
Action = "action",
FailureType = "failureType",
MinNumberOfExecutedThings = 123,
ThresholdPercentage = 123
} }
},
JobExecutionsRolloutConfig = new IoTJobExecutionsRolloutConfigProperty {
ExponentialRate = new IoTJobExponentialRolloutRateProperty {
BaseRatePerMinute = 123,
IncrementFactor = 123,
RateIncreaseCriteria = rateIncreaseCriteria
},
MaximumPerMinute = 123
},
TimeoutConfig = new IoTJobTimeoutConfigProperty {
InProgressTimeoutInMinutes = 123
}
},
ParentTargetArn = "parentTargetArn",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
}
};
Synopsis
Constructors
CfnDeploymentProps() |
Properties
Components | The components to deploy. |
DeploymentName | The name of the deployment. |
DeploymentPolicies | The deployment policies for the deployment. |
IotJobConfiguration | The job configuration for the deployment configuration. |
ParentTargetArn | The parent deployment's ARN for a subdeployment. |
Tags | Application-specific metadata to attach to the deployment. |
TargetArn | The ARN of the target AWS IoT thing or thing group. |
Constructors
CfnDeploymentProps()
public CfnDeploymentProps()
Properties
Components
The components to deploy.
public object Components { get; set; }
Property Value
System.Object
Remarks
This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.
DeploymentName
The name of the deployment.
public string DeploymentName { get; set; }
Property Value
System.String
Remarks
DeploymentPolicies
The deployment policies for the deployment.
public object DeploymentPolicies { get; set; }
Property Value
System.Object
Remarks
These policies define how the deployment updates components and handles failure.
IotJobConfiguration
The job configuration for the deployment configuration.
public object IotJobConfiguration { get; set; }
Property Value
System.Object
Remarks
The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
ParentTargetArn
The parent deployment's ARN for a subdeployment.
public string ParentTargetArn { get; set; }
Property Value
System.String
Remarks
Tags
Application-specific metadata to attach to the deployment.
public IDictionary<string, string> Tags { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see Tag your AWS IoT Greengrass Version 2 resources in the AWS IoT Greengrass V2 Developer Guide .
This Json
property type is processed as a map of key-value pairs. It uses the following format, which is different from most Tags
implementations in AWS CloudFormation templates.
"Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
}
TargetArn
The ARN of the target AWS IoT thing or thing group.
public string TargetArn { get; set; }
Property Value
System.String