CfnDeploymentProps Struct
Properties for defining a CfnDeployment.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_greengrassv2 as greengrassv2 } from 'aws-cdk-lib';
declare const rateIncreaseCriteria: any;
const cfnDeploymentProps: greengrassv2.CfnDeploymentProps = {
targetArn: 'targetArn',
// the properties below are optional
components: {
componentsKey: {
componentVersion: 'componentVersion',
configurationUpdate: {
merge: 'merge',
reset: ['reset'],
},
runWith: {
posixUser: 'posixUser',
systemResourceLimits: {
cpus: 123,
memory: 123,
},
windowsUser: 'windowsUser',
},
},
},
deploymentName: 'deploymentName',
deploymentPolicies: {
componentUpdatePolicy: {
action: 'action',
timeoutInSeconds: 123,
},
configurationValidationPolicy: {
timeoutInSeconds: 123,
},
failureHandlingPolicy: 'failureHandlingPolicy',
},
iotJobConfiguration: {
abortConfig: {
criteriaList: [{
action: 'action',
failureType: 'failureType',
minNumberOfExecutedThings: 123,
thresholdPercentage: 123,
}],
},
jobExecutionsRolloutConfig: {
exponentialRate: {
baseRatePerMinute: 123,
incrementFactor: 123,
rateIncreaseCriteria: rateIncreaseCriteria,
},
maximumPerMinute: 123,
},
timeoutConfig: {
inProgressTimeoutInMinutes: 123,
},
},
parentTargetArn: 'parentTargetArn',
tags: {
tagsKey: 'tags',
},
};
Properties
componentsoptionalIResolvable | { [key: string]: IResolvable | CfnDeployment.ComponentDeploymentSpecificationProperty }componentsoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, ComponentDeploymentSpecificationProperty]]]componentsoptionalIResolvableComponentsoptionalIResolvableComponentsoptionalinterface{}#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.
deploymentNameoptionalstringdeployment_nameoptionalstrdeploymentNameoptionalStringDeploymentNameoptionalstringDeploymentNameoptional*string#deploymentPoliciesoptionalIResolvable | CfnDeployment.DeploymentPoliciesPropertydeployment_policiesoptionaltyping.Union[IResolvable, DeploymentPoliciesProperty]deploymentPoliciesoptionalIResolvableDeploymentPoliciesoptionalIResolvableDeploymentPoliciesoptionalinterface{}#These policies define how the deployment updates components and handles failure.
iotJobConfigurationoptionalIResolvable | CfnDeployment.DeploymentIoTJobConfigurationPropertyiot_job_configurationoptionaltyping.Union[IResolvable, DeploymentIoTJobConfigurationProperty]iotJobConfigurationoptionalIResolvableIotJobConfigurationoptionalIResolvableIotJobConfigurationoptionalinterface{}#The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
parentTargetArnoptionalstringparent_target_arnoptionalstrparentTargetArnoptionalStringParentTargetArnoptionalstringParentTargetArnoptional*string#tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#notes
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 CloudFormation templates.
"Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
}