

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::WirelessGateway
<a name="aws-resource-iotwireless-wirelessgateway"></a>

Provisions a wireless gateway.

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

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

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

```
{
  "Type" : "AWS::IoTWireless::WirelessGateway",
  "Properties" : {
      "[Description](#cfn-iotwireless-wirelessgateway-description)" : String,
      "[LastUplinkReceivedAt](#cfn-iotwireless-wirelessgateway-lastuplinkreceivedat)" : String,
      "[LoRaWAN](#cfn-iotwireless-wirelessgateway-lorawan)" : LoRaWANGateway,
      "[Name](#cfn-iotwireless-wirelessgateway-name)" : String,
      "[Tags](#cfn-iotwireless-wirelessgateway-tags)" : [ Tag, ... ],
      "[ThingArn](#cfn-iotwireless-wirelessgateway-thingarn)" : String,
      "[ThingName](#cfn-iotwireless-wirelessgateway-thingname)" : String
    }
}
```

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

```
Type: AWS::IoTWireless::WirelessGateway
Properties:
  [Description](#cfn-iotwireless-wirelessgateway-description): String
  [LastUplinkReceivedAt](#cfn-iotwireless-wirelessgateway-lastuplinkreceivedat): String
  [LoRaWAN](#cfn-iotwireless-wirelessgateway-lorawan): 
    LoRaWANGateway
  [Name](#cfn-iotwireless-wirelessgateway-name): String
  [Tags](#cfn-iotwireless-wirelessgateway-tags): 
    - Tag
  [ThingArn](#cfn-iotwireless-wirelessgateway-thingarn): String
  [ThingName](#cfn-iotwireless-wirelessgateway-thingname): String
```

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

`Description`  <a name="cfn-iotwireless-wirelessgateway-description"></a>
The description of the new resource. The maximum length is 2048 characters.  
*Required*: No  
*Type*: String  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LastUplinkReceivedAt`  <a name="cfn-iotwireless-wirelessgateway-lastuplinkreceivedat"></a>
The date and time when the most recent uplink was received.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LoRaWAN`  <a name="cfn-iotwireless-wirelessgateway-lorawan"></a>
The gateway configuration information to use to create the wireless gateway.  
*Required*: Yes  
*Type*: [LoRaWANGateway](aws-properties-iotwireless-wirelessgateway-lorawangateway.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-wirelessgateway-name"></a>
The name of the new resource.  
*Required*: No  
*Type*: String  
*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-wirelessgateway-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-wirelessgateway-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)

`ThingArn`  <a name="cfn-iotwireless-wirelessgateway-thingarn"></a>
The ARN of the thing to associate with the wireless gateway.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ThingName`  <a name="cfn-iotwireless-wirelessgateway-thingname"></a>
The name of the thing associated with the wireless gateway. The value is empty if a thing isn't associated with the gateway.  
*Required*: No  
*Type*: String  
*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-wirelessgateway-return-values"></a>

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

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

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

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

`Arn`  <a name="Arn-fn::getatt"></a>
The ARN of the wireless gateway created.

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

# AWS::IoTWireless::WirelessGateway LoRaWANGateway
<a name="aws-properties-iotwireless-wirelessgateway-lorawangateway"></a>

LoRaWAN wireless gateway object.

## Syntax
<a name="aws-properties-iotwireless-wirelessgateway-lorawangateway-syntax"></a>

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

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

```
{
  "[GatewayEui](#cfn-iotwireless-wirelessgateway-lorawangateway-gatewayeui)" : String,
  "[RfRegion](#cfn-iotwireless-wirelessgateway-lorawangateway-rfregion)" : String
}
```

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

```
  [GatewayEui](#cfn-iotwireless-wirelessgateway-lorawangateway-gatewayeui): String
  [RfRegion](#cfn-iotwireless-wirelessgateway-lorawangateway-rfregion): String
```

## Properties
<a name="aws-properties-iotwireless-wirelessgateway-lorawangateway-properties"></a>

`GatewayEui`  <a name="cfn-iotwireless-wirelessgateway-lorawangateway-gatewayeui"></a>
The gateway's EUI value.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(([0-9A-Fa-f]{2}-){7}|([0-9A-Fa-f]{2}:){7}|([0-9A-Fa-f]{2}\s){7}|([0-9A-Fa-f]{2}){7})([0-9A-Fa-f]{2})$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RfRegion`  <a name="cfn-iotwireless-wirelessgateway-lorawangateway-rfregion"></a>
The frequency band (RFRegion) value.  
*Required*: Yes  
*Type*: String  
*Maximum*: `64`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

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

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

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

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

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

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

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

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

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