This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS IoT Greengrass Version 2
<a name="AWS_GreengrassV2"></a>

**Resource types**
+ [AWS::GreengrassV2::ComponentVersion](aws-resource-greengrassv2-componentversion.md)
+ [AWS::GreengrassV2::Deployment](aws-resource-greengrassv2-deployment.md)

# AWS::GreengrassV2::ComponentVersion
<a name="aws-resource-greengrassv2-componentversion"></a>

Creates a component. Components are software that run on AWS IoT Greengrass core devices. After you develop and test a component on your core device, you can use this operation to upload your component to AWS IoT Greengrass. Then, you can deploy the component to other core devices.

You can use this operation to do the following:
+  **Create components from recipes** 

  Create a component from a recipe, which is a file that defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For more information, see [AWS IoT Greengrass component recipe reference](https://docs.aws.amazon.com/greengrass/v2/developerguide/component-recipe-reference.html) in the *AWS IoT Greengrass V2 Developer Guide*.

  To create a component from a recipe, specify `inlineRecipe` when you call this operation.
+  **Create components from Lambda functions** 

  Create a component from an AWS Lambda function that runs on AWS IoT Greengrass. This creates a recipe and artifacts from the Lambda function's deployment package. You can use this operation to migrate Lambda functions from AWS IoT Greengrass V1 to AWS IoT Greengrass V2.

  This function accepts Lambda functions in all supported versions of Python, Node.js, and Java runtimes. AWS IoT Greengrass doesn't apply any additional restrictions on deprecated Lambda runtime versions.

  To create a component from a Lambda function, specify `lambdaFunction` when you call this operation.

## Syntax
<a name="aws-resource-greengrassv2-componentversion-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-greengrassv2-componentversion-syntax.json"></a>

```
{
  "Type" : "AWS::GreengrassV2::ComponentVersion",
  "Properties" : {
      "[InlineRecipe](#cfn-greengrassv2-componentversion-inlinerecipe)" : String,
      "[LambdaFunction](#cfn-greengrassv2-componentversion-lambdafunction)" : LambdaFunctionRecipeSource,
      "[Tags](#cfn-greengrassv2-componentversion-tags)" : {Key: Value, ...}
    }
}
```

### YAML
<a name="aws-resource-greengrassv2-componentversion-syntax.yaml"></a>

```
Type: AWS::GreengrassV2::ComponentVersion
Properties:
  [InlineRecipe](#cfn-greengrassv2-componentversion-inlinerecipe): String
  [LambdaFunction](#cfn-greengrassv2-componentversion-lambdafunction): 
    LambdaFunctionRecipeSource
  [Tags](#cfn-greengrassv2-componentversion-tags): 
    Key: Value
```

## Properties
<a name="aws-resource-greengrassv2-componentversion-properties"></a>

`InlineRecipe`  <a name="cfn-greengrassv2-componentversion-inlinerecipe"></a>
The recipe to use to create the component. The recipe defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform compatibility.  
You must specify either `InlineRecipe` or `LambdaFunction`.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`LambdaFunction`  <a name="cfn-greengrassv2-componentversion-lambdafunction"></a>
The parameters to create a component from a Lambda function.  
You must specify either `InlineRecipe` or `LambdaFunction`.  
*Required*: No  
*Type*: [LambdaFunctionRecipeSource](aws-properties-greengrassv2-componentversion-lambdafunctionrecipesource.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-greengrassv2-componentversion-tags"></a>
Application-specific metadata to attach to the component version. 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](https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) 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"
}
```
*Required*: No  
*Type*: Object of String  
*Pattern*: `^(?!aws:)[a-zA-Z+-=._:/]{1,128}$`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-greengrassv2-componentversion-return-values"></a>

### Ref
<a name="aws-resource-greengrassv2-componentversion-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `Arn`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-greengrassv2-componentversion-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-greengrassv2-componentversion-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The ARN of the component version.

`ComponentName`  <a name="ComponentName-fn::getatt"></a>
The name of the component.

`ComponentVersion`  <a name="ComponentVersion-fn::getatt"></a>
The version of the component.

# AWS::GreengrassV2::ComponentVersion ComponentDependencyRequirement
<a name="aws-properties-greengrassv2-componentversion-componentdependencyrequirement"></a>

Contains information about a component dependency for a Lambda function component.

## Syntax
<a name="aws-properties-greengrassv2-componentversion-componentdependencyrequirement-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-componentversion-componentdependencyrequirement-syntax.json"></a>

```
{
  "[DependencyType](#cfn-greengrassv2-componentversion-componentdependencyrequirement-dependencytype)" : String,
  "[VersionRequirement](#cfn-greengrassv2-componentversion-componentdependencyrequirement-versionrequirement)" : String
}
```

### YAML
<a name="aws-properties-greengrassv2-componentversion-componentdependencyrequirement-syntax.yaml"></a>

```
  [DependencyType](#cfn-greengrassv2-componentversion-componentdependencyrequirement-dependencytype): String
  [VersionRequirement](#cfn-greengrassv2-componentversion-componentdependencyrequirement-versionrequirement): String
```

## Properties
<a name="aws-properties-greengrassv2-componentversion-componentdependencyrequirement-properties"></a>

`DependencyType`  <a name="cfn-greengrassv2-componentversion-componentdependencyrequirement-dependencytype"></a>
The type of this dependency. Choose from the following options:  
+ `SOFT` – The component doesn't restart if the dependency changes state.
+ `HARD` – The component restarts if the dependency changes state.
Default: `HARD`  
*Required*: No  
*Type*: String  
*Allowed values*: `SOFT | HARD`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`VersionRequirement`  <a name="cfn-greengrassv2-componentversion-componentdependencyrequirement-versionrequirement"></a>
The component version requirement for the component dependency.  
AWS IoT Greengrass uses semantic version constraints. For more information, see [Semantic Versioning](https://semver.org/).  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::ComponentVersion ComponentPlatform
<a name="aws-properties-greengrassv2-componentversion-componentplatform"></a>

Contains information about a platform that a component supports.

## Syntax
<a name="aws-properties-greengrassv2-componentversion-componentplatform-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-componentversion-componentplatform-syntax.json"></a>

```
{
  "[Attributes](#cfn-greengrassv2-componentversion-componentplatform-attributes)" : {Key: Value, ...},
  "[Name](#cfn-greengrassv2-componentversion-componentplatform-name)" : String
}
```

### YAML
<a name="aws-properties-greengrassv2-componentversion-componentplatform-syntax.yaml"></a>

```
  [Attributes](#cfn-greengrassv2-componentversion-componentplatform-attributes): 
    Key: Value
  [Name](#cfn-greengrassv2-componentversion-componentplatform-name): String
```

## Properties
<a name="aws-properties-greengrassv2-componentversion-componentplatform-properties"></a>

`Attributes`  <a name="cfn-greengrassv2-componentversion-componentplatform-attributes"></a>
A dictionary of attributes for the platform. The AWS IoT Greengrass Core software defines the `os` and `platform` by default. You can specify additional platform attributes for a core device when you deploy the AWS IoT Greengrass nucleus component. For more information, see the [AWS IoT Greengrass nucleus component](https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html) in the *AWS IoT Greengrass V2 Developer Guide*.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `.+`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-greengrassv2-componentversion-componentplatform-name"></a>
The friendly name of the platform. This name helps you identify the platform.  
If you omit this parameter, AWS IoT Greengrass creates a friendly name from the `os` and `architecture` of the platform.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::ComponentVersion LambdaContainerParams
<a name="aws-properties-greengrassv2-componentversion-lambdacontainerparams"></a>

Contains information about a container in which AWS Lambda functions run on AWS IoT Greengrass core devices.

## Syntax
<a name="aws-properties-greengrassv2-componentversion-lambdacontainerparams-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-componentversion-lambdacontainerparams-syntax.json"></a>

```
{
  "[Devices](#cfn-greengrassv2-componentversion-lambdacontainerparams-devices)" : [ LambdaDeviceMount, ... ],
  "[MemorySizeInKB](#cfn-greengrassv2-componentversion-lambdacontainerparams-memorysizeinkb)" : Integer,
  "[MountROSysfs](#cfn-greengrassv2-componentversion-lambdacontainerparams-mountrosysfs)" : Boolean,
  "[Volumes](#cfn-greengrassv2-componentversion-lambdacontainerparams-volumes)" : [ LambdaVolumeMount, ... ]
}
```

### YAML
<a name="aws-properties-greengrassv2-componentversion-lambdacontainerparams-syntax.yaml"></a>

```
  [Devices](#cfn-greengrassv2-componentversion-lambdacontainerparams-devices): 
    - LambdaDeviceMount
  [MemorySizeInKB](#cfn-greengrassv2-componentversion-lambdacontainerparams-memorysizeinkb): Integer
  [MountROSysfs](#cfn-greengrassv2-componentversion-lambdacontainerparams-mountrosysfs): Boolean
  [Volumes](#cfn-greengrassv2-componentversion-lambdacontainerparams-volumes): 
    - LambdaVolumeMount
```

## Properties
<a name="aws-properties-greengrassv2-componentversion-lambdacontainerparams-properties"></a>

`Devices`  <a name="cfn-greengrassv2-componentversion-lambdacontainerparams-devices"></a>
The list of system devices that the container can access.  
*Required*: No  
*Type*: Array of [LambdaDeviceMount](aws-properties-greengrassv2-componentversion-lambdadevicemount.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MemorySizeInKB`  <a name="cfn-greengrassv2-componentversion-lambdacontainerparams-memorysizeinkb"></a>
The memory size of the container, expressed in kilobytes.  
Default: `16384` (16 MB)  
*Required*: No  
*Type*: Integer  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MountROSysfs`  <a name="cfn-greengrassv2-componentversion-lambdacontainerparams-mountrosysfs"></a>
Whether or not the container can read information from the device's `/sys` folder.  
Default: `false`  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Volumes`  <a name="cfn-greengrassv2-componentversion-lambdacontainerparams-volumes"></a>
The list of volumes that the container can access.  
*Required*: No  
*Type*: Array of [LambdaVolumeMount](aws-properties-greengrassv2-componentversion-lambdavolumemount.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::ComponentVersion LambdaDeviceMount
<a name="aws-properties-greengrassv2-componentversion-lambdadevicemount"></a>

Contains information about a device that Linux processes in a container can access.

## Syntax
<a name="aws-properties-greengrassv2-componentversion-lambdadevicemount-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-componentversion-lambdadevicemount-syntax.json"></a>

```
{
  "[AddGroupOwner](#cfn-greengrassv2-componentversion-lambdadevicemount-addgroupowner)" : Boolean,
  "[Path](#cfn-greengrassv2-componentversion-lambdadevicemount-path)" : String,
  "[Permission](#cfn-greengrassv2-componentversion-lambdadevicemount-permission)" : String
}
```

### YAML
<a name="aws-properties-greengrassv2-componentversion-lambdadevicemount-syntax.yaml"></a>

```
  [AddGroupOwner](#cfn-greengrassv2-componentversion-lambdadevicemount-addgroupowner): Boolean
  [Path](#cfn-greengrassv2-componentversion-lambdadevicemount-path): String
  [Permission](#cfn-greengrassv2-componentversion-lambdadevicemount-permission): String
```

## Properties
<a name="aws-properties-greengrassv2-componentversion-lambdadevicemount-properties"></a>

`AddGroupOwner`  <a name="cfn-greengrassv2-componentversion-lambdadevicemount-addgroupowner"></a>
Whether or not to add the component's system user as an owner of the device.  
Default: `false`  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Path`  <a name="cfn-greengrassv2-componentversion-lambdadevicemount-path"></a>
The mount path for the device in the file system.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Permission`  <a name="cfn-greengrassv2-componentversion-lambdadevicemount-permission"></a>
The permission to access the device: read/only (`ro`) or read/write (`rw`).  
Default: `ro`  
*Required*: No  
*Type*: String  
*Allowed values*: `ro | rw`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::ComponentVersion LambdaEventSource
<a name="aws-properties-greengrassv2-componentversion-lambdaeventsource"></a>

Contains information about an event source for an AWS Lambda function. The event source defines the topics on which this Lambda function subscribes to receive messages that run the function.

## Syntax
<a name="aws-properties-greengrassv2-componentversion-lambdaeventsource-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-componentversion-lambdaeventsource-syntax.json"></a>

```
{
  "[Topic](#cfn-greengrassv2-componentversion-lambdaeventsource-topic)" : String,
  "[Type](#cfn-greengrassv2-componentversion-lambdaeventsource-type)" : String
}
```

### YAML
<a name="aws-properties-greengrassv2-componentversion-lambdaeventsource-syntax.yaml"></a>

```
  [Topic](#cfn-greengrassv2-componentversion-lambdaeventsource-topic): String
  [Type](#cfn-greengrassv2-componentversion-lambdaeventsource-type): String
```

## Properties
<a name="aws-properties-greengrassv2-componentversion-lambdaeventsource-properties"></a>

`Topic`  <a name="cfn-greengrassv2-componentversion-lambdaeventsource-topic"></a>
The topic to which to subscribe to receive event messages.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Type`  <a name="cfn-greengrassv2-componentversion-lambdaeventsource-type"></a>
The type of event source. Choose from the following options:  
+ `PUB_SUB` – Subscribe to local publish/subscribe messages. This event source type doesn't support MQTT wildcards (`+` and `#`) in the event source topic.
+ `IOT_CORE` – Subscribe to AWS IoT Core MQTT messages. This event source type supports MQTT wildcards (`+` and `#`) in the event source topic.
*Required*: No  
*Type*: String  
*Allowed values*: `PUB_SUB | IOT_CORE`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::ComponentVersion LambdaExecutionParameters
<a name="aws-properties-greengrassv2-componentversion-lambdaexecutionparameters"></a>

Contains parameters for a Lambda function that runs on AWS IoT Greengrass.

## Syntax
<a name="aws-properties-greengrassv2-componentversion-lambdaexecutionparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-componentversion-lambdaexecutionparameters-syntax.json"></a>

```
{
  "[EnvironmentVariables](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-environmentvariables)" : {Key: Value, ...},
  "[EventSources](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-eventsources)" : [ LambdaEventSource, ... ],
  "[ExecArgs](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-execargs)" : [ String, ... ],
  "[InputPayloadEncodingType](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-inputpayloadencodingtype)" : String,
  "[LinuxProcessParams](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-linuxprocessparams)" : LambdaLinuxProcessParams,
  "[MaxIdleTimeInSeconds](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-maxidletimeinseconds)" : Integer,
  "[MaxInstancesCount](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-maxinstancescount)" : Integer,
  "[MaxQueueSize](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-maxqueuesize)" : Integer,
  "[Pinned](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-pinned)" : Boolean,
  "[StatusTimeoutInSeconds](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-statustimeoutinseconds)" : Integer,
  "[TimeoutInSeconds](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-timeoutinseconds)" : Integer
}
```

### YAML
<a name="aws-properties-greengrassv2-componentversion-lambdaexecutionparameters-syntax.yaml"></a>

```
  [EnvironmentVariables](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-environmentvariables): 
    Key: Value
  [EventSources](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-eventsources): 
    - LambdaEventSource
  [ExecArgs](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-execargs): 
    - String
  [InputPayloadEncodingType](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-inputpayloadencodingtype): String
  [LinuxProcessParams](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-linuxprocessparams): 
    LambdaLinuxProcessParams
  [MaxIdleTimeInSeconds](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-maxidletimeinseconds): Integer
  [MaxInstancesCount](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-maxinstancescount): Integer
  [MaxQueueSize](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-maxqueuesize): Integer
  [Pinned](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-pinned): Boolean
  [StatusTimeoutInSeconds](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-statustimeoutinseconds): Integer
  [TimeoutInSeconds](#cfn-greengrassv2-componentversion-lambdaexecutionparameters-timeoutinseconds): Integer
```

## Properties
<a name="aws-properties-greengrassv2-componentversion-lambdaexecutionparameters-properties"></a>

`EnvironmentVariables`  <a name="cfn-greengrassv2-componentversion-lambdaexecutionparameters-environmentvariables"></a>
The map of environment variables that are available to the Lambda function when it runs.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `.+`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`EventSources`  <a name="cfn-greengrassv2-componentversion-lambdaexecutionparameters-eventsources"></a>
The list of event sources to which to subscribe to receive work messages. The Lambda function runs when it receives a message from an event source. You can subscribe this function to local publish/subscribe messages and AWS IoT Core MQTT messages.  
*Required*: No  
*Type*: Array of [LambdaEventSource](aws-properties-greengrassv2-componentversion-lambdaeventsource.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ExecArgs`  <a name="cfn-greengrassv2-componentversion-lambdaexecutionparameters-execargs"></a>
The list of arguments to pass to the Lambda function when it runs.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`InputPayloadEncodingType`  <a name="cfn-greengrassv2-componentversion-lambdaexecutionparameters-inputpayloadencodingtype"></a>
The encoding type that the Lambda function supports.  
Default: `json`  
*Required*: No  
*Type*: String  
*Allowed values*: `json | binary`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`LinuxProcessParams`  <a name="cfn-greengrassv2-componentversion-lambdaexecutionparameters-linuxprocessparams"></a>
The parameters for the Linux process that contains the Lambda function.  
*Required*: No  
*Type*: [LambdaLinuxProcessParams](aws-properties-greengrassv2-componentversion-lambdalinuxprocessparams.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MaxIdleTimeInSeconds`  <a name="cfn-greengrassv2-componentversion-lambdaexecutionparameters-maxidletimeinseconds"></a>
The maximum amount of time in seconds that a non-pinned Lambda function can idle before the AWS IoT Greengrass Core software stops its process.  
*Required*: No  
*Type*: Integer  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MaxInstancesCount`  <a name="cfn-greengrassv2-componentversion-lambdaexecutionparameters-maxinstancescount"></a>
The maximum number of instances that a non-pinned Lambda function can run at the same time.  
*Required*: No  
*Type*: Integer  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MaxQueueSize`  <a name="cfn-greengrassv2-componentversion-lambdaexecutionparameters-maxqueuesize"></a>
The maximum size of the message queue for the Lambda function component. The AWS IoT Greengrass core device stores messages in a FIFO (first-in-first-out) queue until it can run the Lambda function to consume each message.  
*Required*: No  
*Type*: Integer  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Pinned`  <a name="cfn-greengrassv2-componentversion-lambdaexecutionparameters-pinned"></a>
Whether or not the Lambda function is pinned, or long-lived.  
+ A pinned Lambda function starts when the AWS IoT Greengrass Core starts and keeps running in its own container.
+ A non-pinned Lambda function starts only when it receives a work item and exists after it idles for `maxIdleTimeInSeconds`. If the function has multiple work items, the AWS IoT Greengrass Core software creates multiple instances of the function.
Default: `true`  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`StatusTimeoutInSeconds`  <a name="cfn-greengrassv2-componentversion-lambdaexecutionparameters-statustimeoutinseconds"></a>
The interval in seconds at which a pinned (also known as long-lived) Lambda function component sends status updates to the Lambda manager component.  
*Required*: No  
*Type*: Integer  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`TimeoutInSeconds`  <a name="cfn-greengrassv2-componentversion-lambdaexecutionparameters-timeoutinseconds"></a>
The maximum amount of time in seconds that the Lambda function can process a work item.  
*Required*: No  
*Type*: Integer  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::ComponentVersion LambdaFunctionRecipeSource
<a name="aws-properties-greengrassv2-componentversion-lambdafunctionrecipesource"></a>

Contains information about an AWS Lambda function to import to create a component.

## Syntax
<a name="aws-properties-greengrassv2-componentversion-lambdafunctionrecipesource-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-componentversion-lambdafunctionrecipesource-syntax.json"></a>

```
{
  "[ComponentDependencies](#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentdependencies)" : {Key: Value, ...},
  "[ComponentLambdaParameters](#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentlambdaparameters)" : LambdaExecutionParameters,
  "[ComponentName](#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentname)" : String,
  "[ComponentPlatforms](#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentplatforms)" : [ ComponentPlatform, ... ],
  "[ComponentVersion](#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentversion)" : String,
  "[LambdaArn](#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-lambdaarn)" : String
}
```

### YAML
<a name="aws-properties-greengrassv2-componentversion-lambdafunctionrecipesource-syntax.yaml"></a>

```
  [ComponentDependencies](#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentdependencies): 
    Key: Value
  [ComponentLambdaParameters](#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentlambdaparameters): 
    LambdaExecutionParameters
  [ComponentName](#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentname): String
  [ComponentPlatforms](#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentplatforms): 
    - ComponentPlatform
  [ComponentVersion](#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentversion): String
  [LambdaArn](#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-lambdaarn): String
```

## Properties
<a name="aws-properties-greengrassv2-componentversion-lambdafunctionrecipesource-properties"></a>

`ComponentDependencies`  <a name="cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentdependencies"></a>
The component versions on which this Lambda function component depends.  
*Required*: No  
*Type*: Object of [ComponentDependencyRequirement](aws-properties-greengrassv2-componentversion-componentdependencyrequirement.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ComponentLambdaParameters`  <a name="cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentlambdaparameters"></a>
The system and runtime parameters for the Lambda function as it runs on the AWS IoT Greengrass core device.  
*Required*: No  
*Type*: [LambdaExecutionParameters](aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ComponentName`  <a name="cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentname"></a>
The name of the component.  
Defaults to the name of the Lambda function.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ComponentPlatforms`  <a name="cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentplatforms"></a>
The platforms that the component version supports.  
*Required*: No  
*Type*: Array of [ComponentPlatform](aws-properties-greengrassv2-componentversion-componentplatform.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ComponentVersion`  <a name="cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentversion"></a>
The version of the component.  
Defaults to the version of the Lambda function as a semantic version. For example, if your function version is `3`, the component version becomes `3.0.0`.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`LambdaArn`  <a name="cfn-greengrassv2-componentversion-lambdafunctionrecipesource-lambdaarn"></a>
The ARN of the Lambda function. The ARN must include the version of the function to import. You can't use version aliases like `$LATEST`.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:[^:]*:lambda:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::ComponentVersion LambdaLinuxProcessParams
<a name="aws-properties-greengrassv2-componentversion-lambdalinuxprocessparams"></a>

Contains parameters for a Linux process that contains an AWS Lambda function.

## Syntax
<a name="aws-properties-greengrassv2-componentversion-lambdalinuxprocessparams-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-componentversion-lambdalinuxprocessparams-syntax.json"></a>

```
{
  "[ContainerParams](#cfn-greengrassv2-componentversion-lambdalinuxprocessparams-containerparams)" : LambdaContainerParams,
  "[IsolationMode](#cfn-greengrassv2-componentversion-lambdalinuxprocessparams-isolationmode)" : String
}
```

### YAML
<a name="aws-properties-greengrassv2-componentversion-lambdalinuxprocessparams-syntax.yaml"></a>

```
  [ContainerParams](#cfn-greengrassv2-componentversion-lambdalinuxprocessparams-containerparams): 
    LambdaContainerParams
  [IsolationMode](#cfn-greengrassv2-componentversion-lambdalinuxprocessparams-isolationmode): String
```

## Properties
<a name="aws-properties-greengrassv2-componentversion-lambdalinuxprocessparams-properties"></a>

`ContainerParams`  <a name="cfn-greengrassv2-componentversion-lambdalinuxprocessparams-containerparams"></a>
The parameters for the container in which the Lambda function runs.  
*Required*: No  
*Type*: [LambdaContainerParams](aws-properties-greengrassv2-componentversion-lambdacontainerparams.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`IsolationMode`  <a name="cfn-greengrassv2-componentversion-lambdalinuxprocessparams-isolationmode"></a>
The isolation mode for the process that contains the Lambda function. The process can run in an isolated runtime environment inside the AWS IoT Greengrass container, or as a regular process outside any container.  
Default: `GreengrassContainer`  
*Required*: No  
*Type*: String  
*Allowed values*: `GreengrassContainer | NoContainer`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::ComponentVersion LambdaVolumeMount
<a name="aws-properties-greengrassv2-componentversion-lambdavolumemount"></a>

Contains information about a volume that Linux processes in a container can access. When you define a volume, the AWS IoT Greengrass Core software mounts the source files to the destination inside the container.

## Syntax
<a name="aws-properties-greengrassv2-componentversion-lambdavolumemount-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-componentversion-lambdavolumemount-syntax.json"></a>

```
{
  "[AddGroupOwner](#cfn-greengrassv2-componentversion-lambdavolumemount-addgroupowner)" : Boolean,
  "[DestinationPath](#cfn-greengrassv2-componentversion-lambdavolumemount-destinationpath)" : String,
  "[Permission](#cfn-greengrassv2-componentversion-lambdavolumemount-permission)" : String,
  "[SourcePath](#cfn-greengrassv2-componentversion-lambdavolumemount-sourcepath)" : String
}
```

### YAML
<a name="aws-properties-greengrassv2-componentversion-lambdavolumemount-syntax.yaml"></a>

```
  [AddGroupOwner](#cfn-greengrassv2-componentversion-lambdavolumemount-addgroupowner): Boolean
  [DestinationPath](#cfn-greengrassv2-componentversion-lambdavolumemount-destinationpath): String
  [Permission](#cfn-greengrassv2-componentversion-lambdavolumemount-permission): String
  [SourcePath](#cfn-greengrassv2-componentversion-lambdavolumemount-sourcepath): String
```

## Properties
<a name="aws-properties-greengrassv2-componentversion-lambdavolumemount-properties"></a>

`AddGroupOwner`  <a name="cfn-greengrassv2-componentversion-lambdavolumemount-addgroupowner"></a>
Whether or not to add the AWS IoT Greengrass user group as an owner of the volume.  
Default: `false`  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DestinationPath`  <a name="cfn-greengrassv2-componentversion-lambdavolumemount-destinationpath"></a>
The path to the logical volume in the file system.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Permission`  <a name="cfn-greengrassv2-componentversion-lambdavolumemount-permission"></a>
The permission to access the volume: read/only (`ro`) or read/write (`rw`).  
Default: `ro`  
*Required*: No  
*Type*: String  
*Allowed values*: `ro | rw`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SourcePath`  <a name="cfn-greengrassv2-componentversion-lambdavolumemount-sourcepath"></a>
The path to the physical volume in the file system.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::Deployment
<a name="aws-resource-greengrassv2-deployment"></a>

Creates a continuous deployment for a target, which is a AWS IoT Greengrass core device or group of core devices. When you add a new core device to a group of core devices that has a deployment, AWS IoT Greengrass deploys that group's deployment to the new device.

You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. AWS IoT Greengrass applies the new deployment to the target devices. 

You can only add, update, or delete up to 10 deployments at a time to a single target.

Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment. This operation returns the revision number of the new deployment when you create it.

For more information, see the [Create deployments](https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) in the *AWS IoT Greengrass V2 Developer Guide*.

**Important**  
Deployment resources are deleted when you delete stacks. To keep the deployments in a stack, you must specify `"DeletionPolicy": "Retain"` on each deployment resource in the stack template that you want to keep. For more information, see [DeletionPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).  
You can only delete up to 10 deployment resources at a time. If you delete more than 10 resources, you receive an error.

## Syntax
<a name="aws-resource-greengrassv2-deployment-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-greengrassv2-deployment-syntax.json"></a>

```
{
  "Type" : "AWS::GreengrassV2::Deployment",
  "Properties" : {
      "[Components](#cfn-greengrassv2-deployment-components)" : {Key: Value, ...},
      "[DeploymentName](#cfn-greengrassv2-deployment-deploymentname)" : String,
      "[DeploymentPolicies](#cfn-greengrassv2-deployment-deploymentpolicies)" : DeploymentPolicies,
      "[IotJobConfiguration](#cfn-greengrassv2-deployment-iotjobconfiguration)" : DeploymentIoTJobConfiguration,
      "[ParentTargetArn](#cfn-greengrassv2-deployment-parenttargetarn)" : String,
      "[Tags](#cfn-greengrassv2-deployment-tags)" : {Key: Value, ...},
      "[TargetArn](#cfn-greengrassv2-deployment-targetarn)" : String
    }
}
```

### YAML
<a name="aws-resource-greengrassv2-deployment-syntax.yaml"></a>

```
Type: AWS::GreengrassV2::Deployment
Properties:
  [Components](#cfn-greengrassv2-deployment-components): 
    Key: Value
  [DeploymentName](#cfn-greengrassv2-deployment-deploymentname): String
  [DeploymentPolicies](#cfn-greengrassv2-deployment-deploymentpolicies): 
    DeploymentPolicies
  [IotJobConfiguration](#cfn-greengrassv2-deployment-iotjobconfiguration): 
    DeploymentIoTJobConfiguration
  [ParentTargetArn](#cfn-greengrassv2-deployment-parenttargetarn): String
  [Tags](#cfn-greengrassv2-deployment-tags): 
    Key: Value
  [TargetArn](#cfn-greengrassv2-deployment-targetarn): String
```

## Properties
<a name="aws-resource-greengrassv2-deployment-properties"></a>

`Components`  <a name="cfn-greengrassv2-deployment-components"></a>
The components to deploy. 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.  
*Required*: No  
*Type*: Object of [ComponentDeploymentSpecification](aws-properties-greengrassv2-deployment-componentdeploymentspecification.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DeploymentName`  <a name="cfn-greengrassv2-deployment-deploymentname"></a>
The name of the deployment.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DeploymentPolicies`  <a name="cfn-greengrassv2-deployment-deploymentpolicies"></a>
The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.  
*Required*: No  
*Type*: [DeploymentPolicies](aws-properties-greengrassv2-deployment-deploymentpolicies.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`IotJobConfiguration`  <a name="cfn-greengrassv2-deployment-iotjobconfiguration"></a>
The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.  
*Required*: No  
*Type*: [DeploymentIoTJobConfiguration](aws-properties-greengrassv2-deployment-deploymentiotjobconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ParentTargetArn`  <a name="cfn-greengrassv2-deployment-parenttargetarn"></a>
The parent deployment's [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) for a subdeployment.  
*Required*: No  
*Type*: String  
*Pattern*: `arn:[^:]*:iot:[^:]*:[0-9]+:thinggroup/.+`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-greengrassv2-deployment-tags"></a>
Application-specific metadata to attach to the deployment. 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](https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) 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"
}
```
*Required*: No  
*Type*: Object of String  
*Pattern*: `.*`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetArn`  <a name="cfn-greengrassv2-deployment-targetarn"></a>
The ARN of the target AWS IoT thing or thing group.  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:[^:]*:iot:[^:]*:[0-9]+:(thing|thinggroup)/.+`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-greengrassv2-deployment-return-values"></a>

### Ref
<a name="aws-resource-greengrassv2-deployment-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `DeploymentId`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-greengrassv2-deployment-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-greengrassv2-deployment-return-values-fn--getatt-fn--getatt"></a>

`DeploymentId`  <a name="DeploymentId-fn::getatt"></a>
The ID of the deployment.

# AWS::GreengrassV2::Deployment ComponentConfigurationUpdate
<a name="aws-properties-greengrassv2-deployment-componentconfigurationupdate"></a>

Contains information about a deployment's update to a component's configuration on AWS IoT Greengrass core devices. For more information, see [Update component configurations](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html) in the *AWS IoT Greengrass V2 Developer Guide*.

## Syntax
<a name="aws-properties-greengrassv2-deployment-componentconfigurationupdate-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-deployment-componentconfigurationupdate-syntax.json"></a>

```
{
  "[Merge](#cfn-greengrassv2-deployment-componentconfigurationupdate-merge)" : String,
  "[Reset](#cfn-greengrassv2-deployment-componentconfigurationupdate-reset)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-greengrassv2-deployment-componentconfigurationupdate-syntax.yaml"></a>

```
  [Merge](#cfn-greengrassv2-deployment-componentconfigurationupdate-merge): String
  [Reset](#cfn-greengrassv2-deployment-componentconfigurationupdate-reset): 
    - String
```

## Properties
<a name="aws-properties-greengrassv2-deployment-componentconfigurationupdate-properties"></a>

`Merge`  <a name="cfn-greengrassv2-deployment-componentconfigurationupdate-merge"></a>
A serialized JSON string that contains the configuration object to merge to target devices. The core device merges this configuration with the component's existing configuration. If this is the first time a component deploys on a device, the core device merges this configuration with the component's default configuration. This means that the core device keeps it's existing configuration for keys and values that you don't specify in this object. For more information, see [Merge configuration updates](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#merge-configuration-update) in the *AWS IoT Greengrass V2 Developer Guide*.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `10485760`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Reset`  <a name="cfn-greengrassv2-deployment-componentconfigurationupdate-reset"></a>
The list of configuration nodes to reset to default values on target devices. Use JSON pointers to specify each node to reset. JSON pointers start with a forward slash (`/`) and use forward slashes to separate the key for each level in the object. For more information, see the [JSON pointer specification](https://tools.ietf.org/html/rfc6901) and [Reset configuration updates](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#reset-configuration-update) in the *AWS IoT Greengrass V2 Developer Guide*.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::Deployment ComponentDeploymentSpecification
<a name="aws-properties-greengrassv2-deployment-componentdeploymentspecification"></a>

Contains information about a component to deploy.

## Syntax
<a name="aws-properties-greengrassv2-deployment-componentdeploymentspecification-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-deployment-componentdeploymentspecification-syntax.json"></a>

```
{
  "[ComponentVersion](#cfn-greengrassv2-deployment-componentdeploymentspecification-componentversion)" : String,
  "[ConfigurationUpdate](#cfn-greengrassv2-deployment-componentdeploymentspecification-configurationupdate)" : ComponentConfigurationUpdate,
  "[RunWith](#cfn-greengrassv2-deployment-componentdeploymentspecification-runwith)" : ComponentRunWith
}
```

### YAML
<a name="aws-properties-greengrassv2-deployment-componentdeploymentspecification-syntax.yaml"></a>

```
  [ComponentVersion](#cfn-greengrassv2-deployment-componentdeploymentspecification-componentversion): String
  [ConfigurationUpdate](#cfn-greengrassv2-deployment-componentdeploymentspecification-configurationupdate): 
    ComponentConfigurationUpdate
  [RunWith](#cfn-greengrassv2-deployment-componentdeploymentspecification-runwith): 
    ComponentRunWith
```

## Properties
<a name="aws-properties-greengrassv2-deployment-componentdeploymentspecification-properties"></a>

`ComponentVersion`  <a name="cfn-greengrassv2-deployment-componentdeploymentspecification-componentversion"></a>
The version of the component.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ConfigurationUpdate`  <a name="cfn-greengrassv2-deployment-componentdeploymentspecification-configurationupdate"></a>
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](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html).  
*Required*: No  
*Type*: [ComponentConfigurationUpdate](aws-properties-greengrassv2-deployment-componentconfigurationupdate.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RunWith`  <a name="cfn-greengrassv2-deployment-componentdeploymentspecification-runwith"></a>
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](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user) in the *AWS IoT Greengrass V2 Developer Guide*.  
*Required*: No  
*Type*: [ComponentRunWith](aws-properties-greengrassv2-deployment-componentrunwith.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::Deployment ComponentRunWith
<a name="aws-properties-greengrassv2-deployment-componentrunwith"></a>

Contains information system user and group that the AWS IoT Greengrass Core software uses to run component processes on the core device. For more information, see [Configure the user and group that run components](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user) in the *AWS IoT Greengrass V2 Developer Guide*.

## Syntax
<a name="aws-properties-greengrassv2-deployment-componentrunwith-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-deployment-componentrunwith-syntax.json"></a>

```
{
  "[PosixUser](#cfn-greengrassv2-deployment-componentrunwith-posixuser)" : String,
  "[SystemResourceLimits](#cfn-greengrassv2-deployment-componentrunwith-systemresourcelimits)" : SystemResourceLimits,
  "[WindowsUser](#cfn-greengrassv2-deployment-componentrunwith-windowsuser)" : String
}
```

### YAML
<a name="aws-properties-greengrassv2-deployment-componentrunwith-syntax.yaml"></a>

```
  [PosixUser](#cfn-greengrassv2-deployment-componentrunwith-posixuser): String
  [SystemResourceLimits](#cfn-greengrassv2-deployment-componentrunwith-systemresourcelimits): 
    SystemResourceLimits
  [WindowsUser](#cfn-greengrassv2-deployment-componentrunwith-windowsuser): String
```

## Properties
<a name="aws-properties-greengrassv2-deployment-componentrunwith-properties"></a>

`PosixUser`  <a name="cfn-greengrassv2-deployment-componentrunwith-posixuser"></a>
The POSIX system user and (optional) group to use to run this component. Specify the user and group separated by a colon (`:`) in the following format: `user:group`. The group is optional. If you don't specify a group, the AWS IoT Greengrass Core software uses the primary user for the group.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SystemResourceLimits`  <a name="cfn-greengrassv2-deployment-componentrunwith-systemresourcelimits"></a>
The system resource limits to apply to this component's process on the core device. AWS IoT Greengrass supports this feature only on Linux core devices.  
If you omit this parameter, the AWS IoT Greengrass Core software uses the default system resource limits that you configure on the AWS IoT Greengrass nucleus component. For more information, see [ Configure system resource limits for components ](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits).  
*Required*: No  
*Type*: [SystemResourceLimits](aws-properties-greengrassv2-deployment-systemresourcelimits.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`WindowsUser`  <a name="cfn-greengrassv2-deployment-componentrunwith-windowsuser"></a>
The Windows user to use to run this component on Windows core devices. The user must exist on each Windows core device, and its name and password must be in the LocalSystem account's Credentials Manager instance.  
If you omit this parameter, the AWS IoT Greengrass Core software uses the default Windows user that you configure on the AWS IoT Greengrass nucleus component. For more information, see [Configure the user and group that run components](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user).  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::Deployment DeploymentComponentUpdatePolicy
<a name="aws-properties-greengrassv2-deployment-deploymentcomponentupdatepolicy"></a>

Contains information about a deployment's policy that defines when components are safe to update.

Each component on a device can report whether or not it's ready to update. After a component and its dependencies are ready, they can apply the update in the deployment. You can configure whether or not the deployment notifies components of an update and waits for a response. You specify the amount of time each component has to respond to the update notification.

## Syntax
<a name="aws-properties-greengrassv2-deployment-deploymentcomponentupdatepolicy-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-deployment-deploymentcomponentupdatepolicy-syntax.json"></a>

```
{
  "[Action](#cfn-greengrassv2-deployment-deploymentcomponentupdatepolicy-action)" : String,
  "[TimeoutInSeconds](#cfn-greengrassv2-deployment-deploymentcomponentupdatepolicy-timeoutinseconds)" : Integer
}
```

### YAML
<a name="aws-properties-greengrassv2-deployment-deploymentcomponentupdatepolicy-syntax.yaml"></a>

```
  [Action](#cfn-greengrassv2-deployment-deploymentcomponentupdatepolicy-action): String
  [TimeoutInSeconds](#cfn-greengrassv2-deployment-deploymentcomponentupdatepolicy-timeoutinseconds): Integer
```

## Properties
<a name="aws-properties-greengrassv2-deployment-deploymentcomponentupdatepolicy-properties"></a>

`Action`  <a name="cfn-greengrassv2-deployment-deploymentcomponentupdatepolicy-action"></a>
Whether or not to notify components and wait for components to become safe to update. Choose from the following options:  
+ `NOTIFY_COMPONENTS` – The deployment notifies each component before it stops and updates that component. Components can use the [SubscribeToComponentUpdates](https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetocomponentupdates) IPC operation to receive these notifications. Then, components can respond with the [DeferComponentUpdate](https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-defercomponentupdate) IPC operation. For more information, see the [Create deployments](https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) in the *AWS IoT Greengrass V2 Developer Guide*.
+ `SKIP_NOTIFY_COMPONENTS` – The deployment doesn't notify components or wait for them to be safe to update.
Default: `NOTIFY_COMPONENTS`  
*Required*: No  
*Type*: String  
*Allowed values*: `NOTIFY_COMPONENTS | SKIP_NOTIFY_COMPONENTS`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`TimeoutInSeconds`  <a name="cfn-greengrassv2-deployment-deploymentcomponentupdatepolicy-timeoutinseconds"></a>
The amount of time in seconds that each component on a device has to report that it's safe to update. If the component waits for longer than this timeout, then the deployment proceeds on the device.  
Default: `60`  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `2147483647`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::Deployment DeploymentConfigurationValidationPolicy
<a name="aws-properties-greengrassv2-deployment-deploymentconfigurationvalidationpolicy"></a>

Contains information about how long a component on a core device can validate its configuration updates before it times out. Components can use the [SubscribeToValidateConfigurationUpdates](https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetovalidateconfigurationupdates) IPC operation to receive notifications when a deployment specifies a configuration update. Then, components can respond with the [SendConfigurationValidityReport](https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-sendconfigurationvalidityreport) IPC operation. For more information, see the [Create deployments](https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) in the *AWS IoT Greengrass V2 Developer Guide*.

## Syntax
<a name="aws-properties-greengrassv2-deployment-deploymentconfigurationvalidationpolicy-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-deployment-deploymentconfigurationvalidationpolicy-syntax.json"></a>

```
{
  "[TimeoutInSeconds](#cfn-greengrassv2-deployment-deploymentconfigurationvalidationpolicy-timeoutinseconds)" : Integer
}
```

### YAML
<a name="aws-properties-greengrassv2-deployment-deploymentconfigurationvalidationpolicy-syntax.yaml"></a>

```
  [TimeoutInSeconds](#cfn-greengrassv2-deployment-deploymentconfigurationvalidationpolicy-timeoutinseconds): Integer
```

## Properties
<a name="aws-properties-greengrassv2-deployment-deploymentconfigurationvalidationpolicy-properties"></a>

`TimeoutInSeconds`  <a name="cfn-greengrassv2-deployment-deploymentconfigurationvalidationpolicy-timeoutinseconds"></a>
The amount of time in seconds that a component can validate its configuration updates. If the validation time exceeds this timeout, then the deployment proceeds for the device.  
Default: `30`  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `2147483647`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::Deployment DeploymentIoTJobConfiguration
<a name="aws-properties-greengrassv2-deployment-deploymentiotjobconfiguration"></a>

Contains information about an AWS IoT job configuration.

## Syntax
<a name="aws-properties-greengrassv2-deployment-deploymentiotjobconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-deployment-deploymentiotjobconfiguration-syntax.json"></a>

```
{
  "[AbortConfig](#cfn-greengrassv2-deployment-deploymentiotjobconfiguration-abortconfig)" : IoTJobAbortConfig,
  "[JobExecutionsRolloutConfig](#cfn-greengrassv2-deployment-deploymentiotjobconfiguration-jobexecutionsrolloutconfig)" : IoTJobExecutionsRolloutConfig,
  "[TimeoutConfig](#cfn-greengrassv2-deployment-deploymentiotjobconfiguration-timeoutconfig)" : IoTJobTimeoutConfig
}
```

### YAML
<a name="aws-properties-greengrassv2-deployment-deploymentiotjobconfiguration-syntax.yaml"></a>

```
  [AbortConfig](#cfn-greengrassv2-deployment-deploymentiotjobconfiguration-abortconfig): 
    IoTJobAbortConfig
  [JobExecutionsRolloutConfig](#cfn-greengrassv2-deployment-deploymentiotjobconfiguration-jobexecutionsrolloutconfig): 
    IoTJobExecutionsRolloutConfig
  [TimeoutConfig](#cfn-greengrassv2-deployment-deploymentiotjobconfiguration-timeoutconfig): 
    IoTJobTimeoutConfig
```

## Properties
<a name="aws-properties-greengrassv2-deployment-deploymentiotjobconfiguration-properties"></a>

`AbortConfig`  <a name="cfn-greengrassv2-deployment-deploymentiotjobconfiguration-abortconfig"></a>
The stop configuration for the job. This configuration defines when and how to stop a job rollout.  
*Required*: No  
*Type*: [IoTJobAbortConfig](aws-properties-greengrassv2-deployment-iotjobabortconfig.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`JobExecutionsRolloutConfig`  <a name="cfn-greengrassv2-deployment-deploymentiotjobconfiguration-jobexecutionsrolloutconfig"></a>
The rollout configuration for the job. This configuration defines the rate at which the job rolls out to the fleet of target devices.  
*Required*: No  
*Type*: [IoTJobExecutionsRolloutConfig](aws-properties-greengrassv2-deployment-iotjobexecutionsrolloutconfig.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`TimeoutConfig`  <a name="cfn-greengrassv2-deployment-deploymentiotjobconfiguration-timeoutconfig"></a>
The timeout configuration for the job. This configuration defines the amount of time each device has to complete the job.  
*Required*: No  
*Type*: [IoTJobTimeoutConfig](aws-properties-greengrassv2-deployment-iotjobtimeoutconfig.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::Deployment DeploymentPolicies
<a name="aws-properties-greengrassv2-deployment-deploymentpolicies"></a>

Contains information about policies that define how a deployment updates components and handles failure.

## Syntax
<a name="aws-properties-greengrassv2-deployment-deploymentpolicies-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-deployment-deploymentpolicies-syntax.json"></a>

```
{
  "[ComponentUpdatePolicy](#cfn-greengrassv2-deployment-deploymentpolicies-componentupdatepolicy)" : DeploymentComponentUpdatePolicy,
  "[ConfigurationValidationPolicy](#cfn-greengrassv2-deployment-deploymentpolicies-configurationvalidationpolicy)" : DeploymentConfigurationValidationPolicy,
  "[FailureHandlingPolicy](#cfn-greengrassv2-deployment-deploymentpolicies-failurehandlingpolicy)" : String
}
```

### YAML
<a name="aws-properties-greengrassv2-deployment-deploymentpolicies-syntax.yaml"></a>

```
  [ComponentUpdatePolicy](#cfn-greengrassv2-deployment-deploymentpolicies-componentupdatepolicy): 
    DeploymentComponentUpdatePolicy
  [ConfigurationValidationPolicy](#cfn-greengrassv2-deployment-deploymentpolicies-configurationvalidationpolicy): 
    DeploymentConfigurationValidationPolicy
  [FailureHandlingPolicy](#cfn-greengrassv2-deployment-deploymentpolicies-failurehandlingpolicy): String
```

## Properties
<a name="aws-properties-greengrassv2-deployment-deploymentpolicies-properties"></a>

`ComponentUpdatePolicy`  <a name="cfn-greengrassv2-deployment-deploymentpolicies-componentupdatepolicy"></a>
The component update policy for the configuration deployment. This policy defines when it's safe to deploy the configuration to devices.  
*Required*: No  
*Type*: [DeploymentComponentUpdatePolicy](aws-properties-greengrassv2-deployment-deploymentcomponentupdatepolicy.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ConfigurationValidationPolicy`  <a name="cfn-greengrassv2-deployment-deploymentpolicies-configurationvalidationpolicy"></a>
The configuration validation policy for the configuration deployment. This policy defines how long each component has to validate its configure updates.  
*Required*: No  
*Type*: [DeploymentConfigurationValidationPolicy](aws-properties-greengrassv2-deployment-deploymentconfigurationvalidationpolicy.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`FailureHandlingPolicy`  <a name="cfn-greengrassv2-deployment-deploymentpolicies-failurehandlingpolicy"></a>
The failure handling policy for the configuration deployment. This policy defines what to do if the deployment fails.  
Default: `ROLLBACK`  
*Required*: No  
*Type*: String  
*Allowed values*: `ROLLBACK | DO_NOTHING`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::Deployment IoTJobAbortConfig
<a name="aws-properties-greengrassv2-deployment-iotjobabortconfig"></a>

Contains a list of criteria that define when and how to cancel a configuration deployment.

## Syntax
<a name="aws-properties-greengrassv2-deployment-iotjobabortconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-deployment-iotjobabortconfig-syntax.json"></a>

```
{
  "[CriteriaList](#cfn-greengrassv2-deployment-iotjobabortconfig-criterialist)" : [ IoTJobAbortCriteria, ... ]
}
```

### YAML
<a name="aws-properties-greengrassv2-deployment-iotjobabortconfig-syntax.yaml"></a>

```
  [CriteriaList](#cfn-greengrassv2-deployment-iotjobabortconfig-criterialist): 
    - IoTJobAbortCriteria
```

## Properties
<a name="aws-properties-greengrassv2-deployment-iotjobabortconfig-properties"></a>

`CriteriaList`  <a name="cfn-greengrassv2-deployment-iotjobabortconfig-criterialist"></a>
The list of criteria that define when and how to cancel the configuration deployment.  
*Required*: Yes  
*Type*: Array of [IoTJobAbortCriteria](aws-properties-greengrassv2-deployment-iotjobabortcriteria.md)  
*Minimum*: `1`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::Deployment IoTJobAbortCriteria
<a name="aws-properties-greengrassv2-deployment-iotjobabortcriteria"></a>

Contains criteria that define when and how to cancel a job.

The deployment stops if the following conditions are true:

1. The number of things that receive the deployment exceeds the `minNumberOfExecutedThings`.

1. The percentage of failures with type `failureType` exceeds the `thresholdPercentage`.

## Syntax
<a name="aws-properties-greengrassv2-deployment-iotjobabortcriteria-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-deployment-iotjobabortcriteria-syntax.json"></a>

```
{
  "[Action](#cfn-greengrassv2-deployment-iotjobabortcriteria-action)" : String,
  "[FailureType](#cfn-greengrassv2-deployment-iotjobabortcriteria-failuretype)" : String,
  "[MinNumberOfExecutedThings](#cfn-greengrassv2-deployment-iotjobabortcriteria-minnumberofexecutedthings)" : Integer,
  "[ThresholdPercentage](#cfn-greengrassv2-deployment-iotjobabortcriteria-thresholdpercentage)" : Number
}
```

### YAML
<a name="aws-properties-greengrassv2-deployment-iotjobabortcriteria-syntax.yaml"></a>

```
  [Action](#cfn-greengrassv2-deployment-iotjobabortcriteria-action): String
  [FailureType](#cfn-greengrassv2-deployment-iotjobabortcriteria-failuretype): String
  [MinNumberOfExecutedThings](#cfn-greengrassv2-deployment-iotjobabortcriteria-minnumberofexecutedthings): Integer
  [ThresholdPercentage](#cfn-greengrassv2-deployment-iotjobabortcriteria-thresholdpercentage): Number
```

## Properties
<a name="aws-properties-greengrassv2-deployment-iotjobabortcriteria-properties"></a>

`Action`  <a name="cfn-greengrassv2-deployment-iotjobabortcriteria-action"></a>
The action to perform when the criteria are met.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `CANCEL`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`FailureType`  <a name="cfn-greengrassv2-deployment-iotjobabortcriteria-failuretype"></a>
The type of job deployment failure that can cancel a job.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `FAILED | REJECTED | TIMED_OUT | ALL`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MinNumberOfExecutedThings`  <a name="cfn-greengrassv2-deployment-iotjobabortcriteria-minnumberofexecutedthings"></a>
The minimum number of things that receive the configuration before the job can cancel.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `2147483647`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ThresholdPercentage`  <a name="cfn-greengrassv2-deployment-iotjobabortcriteria-thresholdpercentage"></a>
The minimum percentage of `failureType` failures that occur before the job can cancel.  
This parameter supports up to two digits after the decimal (for example, you can specify `10.9` or `10.99`, but not `10.999`).  
*Required*: Yes  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `100`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::Deployment IoTJobExecutionsRolloutConfig
<a name="aws-properties-greengrassv2-deployment-iotjobexecutionsrolloutconfig"></a>

Contains information about the rollout configuration for a job. This configuration defines the rate at which the job deploys a configuration to a fleet of target devices.

## Syntax
<a name="aws-properties-greengrassv2-deployment-iotjobexecutionsrolloutconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-deployment-iotjobexecutionsrolloutconfig-syntax.json"></a>

```
{
  "[ExponentialRate](#cfn-greengrassv2-deployment-iotjobexecutionsrolloutconfig-exponentialrate)" : IoTJobExponentialRolloutRate,
  "[MaximumPerMinute](#cfn-greengrassv2-deployment-iotjobexecutionsrolloutconfig-maximumperminute)" : Integer
}
```

### YAML
<a name="aws-properties-greengrassv2-deployment-iotjobexecutionsrolloutconfig-syntax.yaml"></a>

```
  [ExponentialRate](#cfn-greengrassv2-deployment-iotjobexecutionsrolloutconfig-exponentialrate): 
    IoTJobExponentialRolloutRate
  [MaximumPerMinute](#cfn-greengrassv2-deployment-iotjobexecutionsrolloutconfig-maximumperminute): Integer
```

## Properties
<a name="aws-properties-greengrassv2-deployment-iotjobexecutionsrolloutconfig-properties"></a>

`ExponentialRate`  <a name="cfn-greengrassv2-deployment-iotjobexecutionsrolloutconfig-exponentialrate"></a>
The exponential rate to increase the job rollout rate.  
*Required*: No  
*Type*: [IoTJobExponentialRolloutRate](aws-properties-greengrassv2-deployment-iotjobexponentialrolloutrate.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MaximumPerMinute`  <a name="cfn-greengrassv2-deployment-iotjobexecutionsrolloutconfig-maximumperminute"></a>
The maximum number of devices that receive a pending job notification, per minute.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `1000`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::Deployment IoTJobExponentialRolloutRate
<a name="aws-properties-greengrassv2-deployment-iotjobexponentialrolloutrate"></a>

Contains information about an exponential rollout rate for a configuration deployment job.

## Syntax
<a name="aws-properties-greengrassv2-deployment-iotjobexponentialrolloutrate-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-deployment-iotjobexponentialrolloutrate-syntax.json"></a>

```
{
  "[BaseRatePerMinute](#cfn-greengrassv2-deployment-iotjobexponentialrolloutrate-baserateperminute)" : Integer,
  "[IncrementFactor](#cfn-greengrassv2-deployment-iotjobexponentialrolloutrate-incrementfactor)" : Number,
  "[RateIncreaseCriteria](#cfn-greengrassv2-deployment-iotjobexponentialrolloutrate-rateincreasecriteria)" : IoTJobRateIncreaseCriteria
}
```

### YAML
<a name="aws-properties-greengrassv2-deployment-iotjobexponentialrolloutrate-syntax.yaml"></a>

```
  [BaseRatePerMinute](#cfn-greengrassv2-deployment-iotjobexponentialrolloutrate-baserateperminute): Integer
  [IncrementFactor](#cfn-greengrassv2-deployment-iotjobexponentialrolloutrate-incrementfactor): Number
  [RateIncreaseCriteria](#cfn-greengrassv2-deployment-iotjobexponentialrolloutrate-rateincreasecriteria): 
    IoTJobRateIncreaseCriteria
```

## Properties
<a name="aws-properties-greengrassv2-deployment-iotjobexponentialrolloutrate-properties"></a>

`BaseRatePerMinute`  <a name="cfn-greengrassv2-deployment-iotjobexponentialrolloutrate-baserateperminute"></a>
The minimum number of devices that receive a pending job notification, per minute, when the job starts. This parameter defines the initial rollout rate of the job.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `1000`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`IncrementFactor`  <a name="cfn-greengrassv2-deployment-iotjobexponentialrolloutrate-incrementfactor"></a>
The exponential factor to increase the rollout rate for the job.  
This parameter supports up to one digit after the decimal (for example, you can specify `1.5`, but not `1.55`).  
*Required*: Yes  
*Type*: Number  
*Minimum*: `1`  
*Maximum*: `5`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RateIncreaseCriteria`  <a name="cfn-greengrassv2-deployment-iotjobexponentialrolloutrate-rateincreasecriteria"></a>
The criteria to increase the rollout rate for the job.  
*Required*: Yes  
*Type*: [IoTJobRateIncreaseCriteria](aws-properties-greengrassv2-deployment-iotjobrateincreasecriteria.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::Deployment IoTJobRateIncreaseCriteria
<a name="aws-properties-greengrassv2-deployment-iotjobrateincreasecriteria"></a>

Contains information about criteria to meet before a job increases its rollout rate. Specify either `numberOfNotifiedThings` or `numberOfSucceededThings`.

## Syntax
<a name="aws-properties-greengrassv2-deployment-iotjobrateincreasecriteria-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-deployment-iotjobrateincreasecriteria-syntax.json"></a>

```
{
  "[NumberOfNotifiedThings](#cfn-greengrassv2-deployment-iotjobrateincreasecriteria-numberofnotifiedthings)" : Integer,
  "[NumberOfSucceededThings](#cfn-greengrassv2-deployment-iotjobrateincreasecriteria-numberofsucceededthings)" : Integer
}
```

### YAML
<a name="aws-properties-greengrassv2-deployment-iotjobrateincreasecriteria-syntax.yaml"></a>

```
  [NumberOfNotifiedThings](#cfn-greengrassv2-deployment-iotjobrateincreasecriteria-numberofnotifiedthings): Integer
  [NumberOfSucceededThings](#cfn-greengrassv2-deployment-iotjobrateincreasecriteria-numberofsucceededthings): Integer
```

## Properties
<a name="aws-properties-greengrassv2-deployment-iotjobrateincreasecriteria-properties"></a>

`NumberOfNotifiedThings`  <a name="cfn-greengrassv2-deployment-iotjobrateincreasecriteria-numberofnotifiedthings"></a>
The number of devices to receive the job notification before the rollout rate increases.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `2147483647`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`NumberOfSucceededThings`  <a name="cfn-greengrassv2-deployment-iotjobrateincreasecriteria-numberofsucceededthings"></a>
The number of devices to successfully run the configuration job before the rollout rate increases.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `2147483647`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::Deployment IoTJobTimeoutConfig
<a name="aws-properties-greengrassv2-deployment-iotjobtimeoutconfig"></a>

Contains information about the timeout configuration for a job.

## Syntax
<a name="aws-properties-greengrassv2-deployment-iotjobtimeoutconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-deployment-iotjobtimeoutconfig-syntax.json"></a>

```
{
  "[InProgressTimeoutInMinutes](#cfn-greengrassv2-deployment-iotjobtimeoutconfig-inprogresstimeoutinminutes)" : Integer
}
```

### YAML
<a name="aws-properties-greengrassv2-deployment-iotjobtimeoutconfig-syntax.yaml"></a>

```
  [InProgressTimeoutInMinutes](#cfn-greengrassv2-deployment-iotjobtimeoutconfig-inprogresstimeoutinminutes): Integer
```

## Properties
<a name="aws-properties-greengrassv2-deployment-iotjobtimeoutconfig-properties"></a>

`InProgressTimeoutInMinutes`  <a name="cfn-greengrassv2-deployment-iotjobtimeoutconfig-inprogresstimeoutinminutes"></a>
The amount of time, in minutes, that devices have to complete the job. The timer starts when the job status is set to `IN_PROGRESS`. If the job status doesn't change to a terminal state before the time expires, then the job status is set to `TIMED_OUT`.  
The timeout interval must be between 1 minute and 7 days (10080 minutes).  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `2147483647`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::GreengrassV2::Deployment SystemResourceLimits
<a name="aws-properties-greengrassv2-deployment-systemresourcelimits"></a>

Contains information about system resource limits that the software applies to a component's processes.

## Syntax
<a name="aws-properties-greengrassv2-deployment-systemresourcelimits-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-greengrassv2-deployment-systemresourcelimits-syntax.json"></a>

```
{
  "[Cpus](#cfn-greengrassv2-deployment-systemresourcelimits-cpus)" : Number,
  "[Memory](#cfn-greengrassv2-deployment-systemresourcelimits-memory)" : Integer
}
```

### YAML
<a name="aws-properties-greengrassv2-deployment-systemresourcelimits-syntax.yaml"></a>

```
  [Cpus](#cfn-greengrassv2-deployment-systemresourcelimits-cpus): Number
  [Memory](#cfn-greengrassv2-deployment-systemresourcelimits-memory): Integer
```

## Properties
<a name="aws-properties-greengrassv2-deployment-systemresourcelimits-properties"></a>

`Cpus`  <a name="cfn-greengrassv2-deployment-systemresourcelimits-cpus"></a>
The maximum amount of CPU time that a component's processes can use on the core device. A core device's total CPU time is equivalent to the device's number of CPU cores. For example, on a core device with 4 CPU cores, you can set this value to 2 to limit the component's processes to 50 percent usage of each CPU core. On a device with 1 CPU core, you can set this value to 0.25 to limit the component's processes to 25 percent usage of the CPU. If you set this value to a number greater than the number of CPU cores, the AWS IoT Greengrass Core software doesn't limit the component's CPU usage.  
*Required*: No  
*Type*: Number  
*Minimum*: `0`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Memory`  <a name="cfn-greengrassv2-deployment-systemresourcelimits-memory"></a>
The maximum amount of RAM, expressed in kilobytes, that a component's processes can use on the core device. For more information, see [Configure system resource limits for components](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits).  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `9223372036854771712`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)