AWS::IoTWireless::TaskDefinition - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::IoTWireless::TaskDefinition

Creates a gateway task definition.

Syntax

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

JSON

{
  "Type" : "AWS::IoTWireless::TaskDefinition",
  "Properties" : {
      "AutoCreateTasks" : Boolean,
      "LoRaWANUpdateGatewayTaskEntry" : LoRaWANUpdateGatewayTaskEntry,
      "Name" : String,
      "Tags" : [ Tag, ... ],
      "TaskDefinitionType" : String,
      "Update" : UpdateWirelessGatewayTaskCreate
    }
}

YAML

Type: AWS::IoTWireless::TaskDefinition
Properties:
  AutoCreateTasks: Boolean
  LoRaWANUpdateGatewayTaskEntry: 
    LoRaWANUpdateGatewayTaskEntry
  Name: String
  Tags: 
    - Tag
  TaskDefinitionType: String
  Update: 
    UpdateWirelessGatewayTaskCreate

Properties

AutoCreateTasks

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

LoRaWANUpdateGatewayTaskEntry

LoRaWANUpdateGatewayTaskEntry object.

Required: No

Type: LoRaWANUpdateGatewayTaskEntry

Update requires: No interruption

Name

The name of the new resource.

Required: No

Type: String

Minimum: 1

Maximum: 256

Update requires: No interruption

Tags

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

Maximum: 200

Update requires: No interruption

TaskDefinitionType

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

Update

Information about the gateways to update.

Required: No

Type: UpdateWirelessGatewayTaskCreate

Update requires: No interruption

Return values

Ref

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

Fn::GetAtt

Arn

The Amazon Resource Name of the resource.

Id

The ID of the new wireless gateway task definition.