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.

# AWS::IoTWireless::TaskDefinition LoRaWANGatewayVersion
<a name="aws-properties-iotwireless-taskdefinition-lorawangatewayversion"></a>

LoRaWANGatewayVersion object.

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

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

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

```
{
  "[Model](#cfn-iotwireless-taskdefinition-lorawangatewayversion-model)" : String,
  "[PackageVersion](#cfn-iotwireless-taskdefinition-lorawangatewayversion-packageversion)" : String,
  "[Station](#cfn-iotwireless-taskdefinition-lorawangatewayversion-station)" : String
}
```

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

```
  [Model](#cfn-iotwireless-taskdefinition-lorawangatewayversion-model): String
  [PackageVersion](#cfn-iotwireless-taskdefinition-lorawangatewayversion-packageversion): String
  [Station](#cfn-iotwireless-taskdefinition-lorawangatewayversion-station): String
```

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

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

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

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

# AWS::IoTWireless::TaskDefinition LoRaWANUpdateGatewayTaskCreate
<a name="aws-properties-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate"></a>

The signature used to verify the update firmware.

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

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

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

```
{
  "[CurrentVersion](#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate-currentversion)" : LoRaWANGatewayVersion,
  "[SigKeyCrc](#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate-sigkeycrc)" : Integer,
  "[UpdateSignature](#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate-updatesignature)" : String,
  "[UpdateVersion](#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate-updateversion)" : LoRaWANGatewayVersion
}
```

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

```
  [CurrentVersion](#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate-currentversion): 
    LoRaWANGatewayVersion
  [SigKeyCrc](#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate-sigkeycrc): Integer
  [UpdateSignature](#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate-updatesignature): String
  [UpdateVersion](#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate-updateversion): 
    LoRaWANGatewayVersion
```

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

`CurrentVersion`  <a name="cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate-currentversion"></a>
The version of the gateways that should receive the update.  
*Required*: No  
*Type*: [LoRaWANGatewayVersion](aws-properties-iotwireless-taskdefinition-lorawangatewayversion.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SigKeyCrc`  <a name="cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate-sigkeycrc"></a>
The CRC of the signature private key to check.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UpdateSignature`  <a name="cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate-updatesignature"></a>
The signature used to verify the update firmware.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `4096`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UpdateVersion`  <a name="cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate-updateversion"></a>
The firmware version to update the gateway to.  
*Required*: No  
*Type*: [LoRaWANGatewayVersion](aws-properties-iotwireless-taskdefinition-lorawangatewayversion.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IoTWireless::TaskDefinition LoRaWANUpdateGatewayTaskEntry
<a name="aws-properties-iotwireless-taskdefinition-lorawanupdategatewaytaskentry"></a>

LoRaWANUpdateGatewayTaskEntry object.

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

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

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

```
{
  "[CurrentVersion](#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskentry-currentversion)" : LoRaWANGatewayVersion,
  "[UpdateVersion](#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskentry-updateversion)" : LoRaWANGatewayVersion
}
```

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

```
  [CurrentVersion](#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskentry-currentversion): 
    LoRaWANGatewayVersion
  [UpdateVersion](#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskentry-updateversion): 
    LoRaWANGatewayVersion
```

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

`CurrentVersion`  <a name="cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskentry-currentversion"></a>
The version of the gateways that should receive the update.  
*Required*: No  
*Type*: [LoRaWANGatewayVersion](aws-properties-iotwireless-taskdefinition-lorawangatewayversion.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UpdateVersion`  <a name="cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskentry-updateversion"></a>
The firmware version to update the gateway to.  
*Required*: No  
*Type*: [LoRaWANGatewayVersion](aws-properties-iotwireless-taskdefinition-lorawangatewayversion.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IoTWireless::TaskDefinition Tag
<a name="aws-properties-iotwireless-taskdefinition-tag"></a>

The tags to attach to the wireless gateway task definition. Tags are metadata that you can use to manage a resource.

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

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

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

```
{
  "[Key](#cfn-iotwireless-taskdefinition-tag-key)" : String,
  "[Value](#cfn-iotwireless-taskdefinition-tag-value)" : String
}
```

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

```
  [Key](#cfn-iotwireless-taskdefinition-tag-key): String
  [Value](#cfn-iotwireless-taskdefinition-tag-value): String
```

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

`Key`  <a name="cfn-iotwireless-taskdefinition-tag-key"></a>
The tag's key value.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `127`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-iotwireless-taskdefinition-tag-value"></a>
The tag's value.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IoTWireless::TaskDefinition UpdateWirelessGatewayTaskCreate
<a name="aws-properties-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate"></a>

UpdateWirelessGatewayTaskCreate object.

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

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

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

```
{
  "[LoRaWAN](#cfn-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate-lorawan)" : LoRaWANUpdateGatewayTaskCreate,
  "[UpdateDataRole](#cfn-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate-updatedatarole)" : String,
  "[UpdateDataSource](#cfn-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate-updatedatasource)" : String
}
```

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

```
  [LoRaWAN](#cfn-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate-lorawan): 
    LoRaWANUpdateGatewayTaskCreate
  [UpdateDataRole](#cfn-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate-updatedatarole): String
  [UpdateDataSource](#cfn-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate-updatedatasource): String
```

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

`LoRaWAN`  <a name="cfn-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate-lorawan"></a>
The properties that relate to the LoRaWAN wireless gateway.  
*Required*: No  
*Type*: [LoRaWANUpdateGatewayTaskCreate](aws-properties-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UpdateDataRole`  <a name="cfn-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate-updatedatarole"></a>
The IAM role used to read data from the S3 bucket.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UpdateDataSource`  <a name="cfn-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate-updatedatasource"></a>
The link to the S3 bucket.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `4096`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)