

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::IoTWireless::TaskDefinition
<a name="aws-resource-iotwireless-taskdefinition"></a>

Creates a gateway task definition.

## Syntax
<a name="aws-resource-iotwireless-taskdefinition-syntax"></a>

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

### JSON
<a name="aws-resource-iotwireless-taskdefinition-syntax.json"></a>

```
{
  "Type" : "AWS::IoTWireless::TaskDefinition",
  "Properties" : {
      "[AutoCreateTasks](#cfn-iotwireless-taskdefinition-autocreatetasks)" : Boolean,
      "[LoRaWANUpdateGatewayTaskEntry](#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskentry)" : LoRaWANUpdateGatewayTaskEntry,
      "[Name](#cfn-iotwireless-taskdefinition-name)" : String,
      "[Tags](#cfn-iotwireless-taskdefinition-tags)" : [ Tag, ... ],
      "[TaskDefinitionType](#cfn-iotwireless-taskdefinition-taskdefinitiontype)" : String,
      "[Update](#cfn-iotwireless-taskdefinition-update)" : UpdateWirelessGatewayTaskCreate
    }
}
```

### YAML
<a name="aws-resource-iotwireless-taskdefinition-syntax.yaml"></a>

```
Type: AWS::IoTWireless::TaskDefinition
Properties:
  [AutoCreateTasks](#cfn-iotwireless-taskdefinition-autocreatetasks): Boolean
  [LoRaWANUpdateGatewayTaskEntry](#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskentry): 
    LoRaWANUpdateGatewayTaskEntry
  [Name](#cfn-iotwireless-taskdefinition-name): String
  [Tags](#cfn-iotwireless-taskdefinition-tags): 
    - Tag
  [TaskDefinitionType](#cfn-iotwireless-taskdefinition-taskdefinitiontype): String
  [Update](#cfn-iotwireless-taskdefinition-update): 
    UpdateWirelessGatewayTaskCreate
```

## Properties
<a name="aws-resource-iotwireless-taskdefinition-properties"></a>

`AutoCreateTasks`  <a name="cfn-iotwireless-taskdefinition-autocreatetasks"></a>
Whether to automatically create tasks using this task definition for all gateways with the specified current version. If `false`, the task must be created by calling `CreateWirelessGatewayTask`.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LoRaWANUpdateGatewayTaskEntry`  <a name="cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskentry"></a>
LoRaWANUpdateGatewayTaskEntry object.  
*Required*: No  
*Type*: [LoRaWANUpdateGatewayTaskEntry](aws-properties-iotwireless-taskdefinition-lorawanupdategatewaytaskentry.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-iotwireless-taskdefinition-name"></a>
The name of the new resource.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-iotwireless-taskdefinition-tags"></a>
The tags are an array of key-value pairs to attach to the specified resource. Tags can have a minimum of 0 and a maximum of 50 items.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-iotwireless-taskdefinition-tag.md)  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TaskDefinitionType`  <a name="cfn-iotwireless-taskdefinition-taskdefinitiontype"></a>
A filter to list only the wireless gateway task definitions that use this task definition type.  
*Required*: No  
*Type*: String  
*Allowed values*: `UPDATE`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Update`  <a name="cfn-iotwireless-taskdefinition-update"></a>
Information about the gateways to update.  
*Required*: No  
*Type*: [UpdateWirelessGatewayTaskCreate](aws-properties-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate.md)  
*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-iotwireless-taskdefinition-return-values"></a>

### Ref
<a name="aws-resource-iotwireless-taskdefinition-return-values-ref"></a>

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

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

#### 
<a name="aws-resource-iotwireless-taskdefinition-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name of the resource.

`Id`  <a name="Id-fn::getatt"></a>
The ID of the new wireless gateway task definition.