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

Creates a new service profile.

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

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

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

```
{
  "Type" : "AWS::IoTWireless::ServiceProfile",
  "Properties" : {
      "[LoRaWAN](#cfn-iotwireless-serviceprofile-lorawan)" : LoRaWANServiceProfile,
      "[Name](#cfn-iotwireless-serviceprofile-name)" : String,
      "[Tags](#cfn-iotwireless-serviceprofile-tags)" : [ Tag, ... ]
    }
}
```

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

```
Type: AWS::IoTWireless::ServiceProfile
Properties:
  [LoRaWAN](#cfn-iotwireless-serviceprofile-lorawan): 
    LoRaWANServiceProfile
  [Name](#cfn-iotwireless-serviceprofile-name): String
  [Tags](#cfn-iotwireless-serviceprofile-tags): 
    - Tag
```

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

`LoRaWAN`  <a name="cfn-iotwireless-serviceprofile-lorawan"></a>
LoRaWAN service profile object.  
*Required*: No  
*Type*: [LoRaWANServiceProfile](aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

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

`Tags`  <a name="cfn-iotwireless-serviceprofile-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-serviceprofile-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)

## Return values
<a name="aws-resource-iotwireless-serviceprofile-return-values"></a>

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

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

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

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

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

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

`LoRaWAN.ChannelMask`  <a name="LoRaWAN.ChannelMask-fn::getatt"></a>
The ChannelMask value.

`LoRaWAN.DevStatusReqFreq`  <a name="LoRaWAN.DevStatusReqFreq-fn::getatt"></a>
The DevStatusReqFreq value.

`LoRaWAN.DlBucketSize`  <a name="LoRaWAN.DlBucketSize-fn::getatt"></a>
The DLBucketSize value.

`LoRaWAN.DlRate`  <a name="LoRaWAN.DlRate-fn::getatt"></a>
The DLRate value.

`LoRaWAN.DlRatePolicy`  <a name="LoRaWAN.DlRatePolicy-fn::getatt"></a>
The DLRatePolicy value.

`LoRaWAN.DrMax`  <a name="LoRaWAN.DrMax-fn::getatt"></a>
The DRMax value.

`LoRaWAN.DrMin`  <a name="LoRaWAN.DrMin-fn::getatt"></a>
The DRMin value.

`LoRaWAN.HrAllowed`  <a name="LoRaWAN.HrAllowed-fn::getatt"></a>
The HRAllowed value that describes whether handover roaming is allowed.

`LoRaWAN.MinGwDiversity`  <a name="LoRaWAN.MinGwDiversity-fn::getatt"></a>
The MinGwDiversity value.

`LoRaWAN.NwkGeoLoc`  <a name="LoRaWAN.NwkGeoLoc-fn::getatt"></a>
The NwkGeoLoc value.

`LoRaWAN.ReportDevStatusBattery`  <a name="LoRaWAN.ReportDevStatusBattery-fn::getatt"></a>
The ReportDevStatusBattery value.

`LoRaWAN.ReportDevStatusMargin`  <a name="LoRaWAN.ReportDevStatusMargin-fn::getatt"></a>
The ReportDevStatusMargin value.

`LoRaWAN.TargetPer`  <a name="LoRaWAN.TargetPer-fn::getatt"></a>
The TargetPer value.

`LoRaWAN.UlBucketSize`  <a name="LoRaWAN.UlBucketSize-fn::getatt"></a>
The UlBucketSize value.

`LoRaWAN.UlRate`  <a name="LoRaWAN.UlRate-fn::getatt"></a>
The ULRate value.

`LoRaWAN.UlRatePolicy`  <a name="LoRaWAN.UlRatePolicy-fn::getatt"></a>
The ULRatePolicy value.

# AWS::IoTWireless::ServiceProfile LoRaWANServiceProfile
<a name="aws-properties-iotwireless-serviceprofile-lorawanserviceprofile"></a>

LoRaWANServiceProfile object.

## Syntax
<a name="aws-properties-iotwireless-serviceprofile-lorawanserviceprofile-syntax"></a>

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

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

```
{
  "[AddGwMetadata](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-addgwmetadata)" : Boolean,
  "[ChannelMask](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-channelmask)" : String,
  "[DevStatusReqFreq](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-devstatusreqfreq)" : Integer,
  "[DlBucketSize](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-dlbucketsize)" : Integer,
  "[DlRate](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-dlrate)" : Integer,
  "[DlRatePolicy](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-dlratepolicy)" : String,
  "[DrMax](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-drmax)" : Integer,
  "[DrMin](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-drmin)" : Integer,
  "[HrAllowed](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-hrallowed)" : Boolean,
  "[MinGwDiversity](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-mingwdiversity)" : Integer,
  "[NwkGeoLoc](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-nwkgeoloc)" : Boolean,
  "[PrAllowed](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-prallowed)" : Boolean,
  "[RaAllowed](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-raallowed)" : Boolean,
  "[ReportDevStatusBattery](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-reportdevstatusbattery)" : Boolean,
  "[ReportDevStatusMargin](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-reportdevstatusmargin)" : Boolean,
  "[TargetPer](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-targetper)" : Integer,
  "[UlBucketSize](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-ulbucketsize)" : Integer,
  "[UlRate](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-ulrate)" : Integer,
  "[UlRatePolicy](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-ulratepolicy)" : String
}
```

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

```
  [AddGwMetadata](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-addgwmetadata): Boolean
  [ChannelMask](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-channelmask): String
  [DevStatusReqFreq](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-devstatusreqfreq): Integer
  [DlBucketSize](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-dlbucketsize): Integer
  [DlRate](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-dlrate): Integer
  [DlRatePolicy](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-dlratepolicy): String
  [DrMax](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-drmax): Integer
  [DrMin](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-drmin): Integer
  [HrAllowed](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-hrallowed): Boolean
  [MinGwDiversity](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-mingwdiversity): Integer
  [NwkGeoLoc](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-nwkgeoloc): Boolean
  [PrAllowed](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-prallowed): Boolean
  [RaAllowed](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-raallowed): Boolean
  [ReportDevStatusBattery](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-reportdevstatusbattery): Boolean
  [ReportDevStatusMargin](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-reportdevstatusmargin): Boolean
  [TargetPer](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-targetper): Integer
  [UlBucketSize](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-ulbucketsize): Integer
  [UlRate](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-ulrate): Integer
  [UlRatePolicy](#cfn-iotwireless-serviceprofile-lorawanserviceprofile-ulratepolicy): String
```

## Properties
<a name="aws-properties-iotwireless-serviceprofile-lorawanserviceprofile-properties"></a>

`AddGwMetadata`  <a name="cfn-iotwireless-serviceprofile-lorawanserviceprofile-addgwmetadata"></a>
The AddGWMetaData value.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ChannelMask`  <a name="cfn-iotwireless-serviceprofile-lorawanserviceprofile-channelmask"></a>
The ChannelMask value.  
This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`  
*Required*: No  
*Type*: String  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DevStatusReqFreq`  <a name="cfn-iotwireless-serviceprofile-lorawanserviceprofile-devstatusreqfreq"></a>
The DevStatusReqFreq value.  
This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`  
*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)

`DlBucketSize`  <a name="cfn-iotwireless-serviceprofile-lorawanserviceprofile-dlbucketsize"></a>
The DLBucketSize value.  
This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`  
*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)

`DlRate`  <a name="cfn-iotwireless-serviceprofile-lorawanserviceprofile-dlrate"></a>
The DLRate value.  
This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`  
*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)

`DlRatePolicy`  <a name="cfn-iotwireless-serviceprofile-lorawanserviceprofile-dlratepolicy"></a>
The DLRatePolicy value.  
This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`  
*Required*: No  
*Type*: String  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DrMax`  <a name="cfn-iotwireless-serviceprofile-lorawanserviceprofile-drmax"></a>
The DRMax value.  
This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `15`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DrMin`  <a name="cfn-iotwireless-serviceprofile-lorawanserviceprofile-drmin"></a>
The DRMin value.  
This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `15`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`HrAllowed`  <a name="cfn-iotwireless-serviceprofile-lorawanserviceprofile-hrallowed"></a>
The HRAllowed value that describes whether handover roaming is allowed.  
This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MinGwDiversity`  <a name="cfn-iotwireless-serviceprofile-lorawanserviceprofile-mingwdiversity"></a>
The MinGwDiversity value.  
This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`NwkGeoLoc`  <a name="cfn-iotwireless-serviceprofile-lorawanserviceprofile-nwkgeoloc"></a>
The NwkGeoLoc value.  
This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PrAllowed`  <a name="cfn-iotwireless-serviceprofile-lorawanserviceprofile-prallowed"></a>
The PRAllowed value that describes whether passive roaming is allowed.  
This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RaAllowed`  <a name="cfn-iotwireless-serviceprofile-lorawanserviceprofile-raallowed"></a>
The RAAllowed value that describes whether roaming activation is allowed.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ReportDevStatusBattery`  <a name="cfn-iotwireless-serviceprofile-lorawanserviceprofile-reportdevstatusbattery"></a>
The ReportDevStatusBattery value.  
This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ReportDevStatusMargin`  <a name="cfn-iotwireless-serviceprofile-lorawanserviceprofile-reportdevstatusmargin"></a>
The ReportDevStatusMargin value.  
This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`TargetPer`  <a name="cfn-iotwireless-serviceprofile-lorawanserviceprofile-targetper"></a>
The TargetPer value.  
This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `100`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`UlBucketSize`  <a name="cfn-iotwireless-serviceprofile-lorawanserviceprofile-ulbucketsize"></a>
The UlBucketSize value.  
This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`  
*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)

`UlRate`  <a name="cfn-iotwireless-serviceprofile-lorawanserviceprofile-ulrate"></a>
The ULRate value.  
This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`  
*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)

`UlRatePolicy`  <a name="cfn-iotwireless-serviceprofile-lorawanserviceprofile-ulratepolicy"></a>
The ULRatePolicy value.  
This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`  
*Required*: No  
*Type*: String  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

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

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

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

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

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

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

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

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

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

`Key`  <a name="cfn-iotwireless-serviceprofile-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-serviceprofile-tag-value"></a>
The tag's value.  
*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)