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::IoT::BillingGroup
<a name="aws-resource-iot-billinggroup"></a>

Creates a new billing group.

Requires permission to access the [CreateBillingGroup](https://docs.aws.amazon.com//service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

## Syntax
<a name="aws-resource-iot-billinggroup-syntax"></a>

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

### JSON
<a name="aws-resource-iot-billinggroup-syntax.json"></a>

```
{
  "Type" : "AWS::IoT::BillingGroup",
  "Properties" : {
      "[BillingGroupName](#cfn-iot-billinggroup-billinggroupname)" : String,
      "[BillingGroupProperties](#cfn-iot-billinggroup-billinggroupproperties)" : BillingGroupProperties,
      "[Tags](#cfn-iot-billinggroup-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-iot-billinggroup-syntax.yaml"></a>

```
Type: AWS::IoT::BillingGroup
Properties:
  [BillingGroupName](#cfn-iot-billinggroup-billinggroupname): String
  [BillingGroupProperties](#cfn-iot-billinggroup-billinggroupproperties): 
    BillingGroupProperties
  [Tags](#cfn-iot-billinggroup-tags): 
    - Tag
```

## Properties
<a name="aws-resource-iot-billinggroup-properties"></a>

`BillingGroupName`  <a name="cfn-iot-billinggroup-billinggroupname"></a>
The name of the billing group.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z0-9:_-]+`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`BillingGroupProperties`  <a name="cfn-iot-billinggroup-billinggroupproperties"></a>
The properties of the billing group.  
*Required*: No  
*Type*: [BillingGroupProperties](aws-properties-iot-billinggroup-billinggroupproperties.md)  
*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-iot-billinggroup-tags"></a>
Metadata which can be used to manage the billing group.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-iot-billinggroup-tag.md)  
*Maximum*: `50`  
*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-iot-billinggroup-return-values"></a>

### Ref
<a name="aws-resource-iot-billinggroup-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the billing group id.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

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

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-iot-billinggroup-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The ARN of the billing group.

`Id`  <a name="Id-fn::getatt"></a>
The ID of the billing group.

# AWS::IoT::BillingGroup BillingGroupProperties
<a name="aws-properties-iot-billinggroup-billinggroupproperties"></a>

The properties of a billing group.

## Syntax
<a name="aws-properties-iot-billinggroup-billinggroupproperties-syntax"></a>

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

### JSON
<a name="aws-properties-iot-billinggroup-billinggroupproperties-syntax.json"></a>

```
{
  "[BillingGroupDescription](#cfn-iot-billinggroup-billinggroupproperties-billinggroupdescription)" : String
}
```

### YAML
<a name="aws-properties-iot-billinggroup-billinggroupproperties-syntax.yaml"></a>

```
  [BillingGroupDescription](#cfn-iot-billinggroup-billinggroupproperties-billinggroupdescription): String
```

## Properties
<a name="aws-properties-iot-billinggroup-billinggroupproperties-properties"></a>

`BillingGroupDescription`  <a name="cfn-iot-billinggroup-billinggroupproperties-billinggroupdescription"></a>
The description of the billing group.  
*Required*: No  
*Type*: String  
*Pattern*: `[\p{Graph}\x20]*`  
*Maximum*: `2028`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IoT::BillingGroup Tag
<a name="aws-properties-iot-billinggroup-tag"></a>

A set of key/value pairs that are used to manage the resource.

## Syntax
<a name="aws-properties-iot-billinggroup-tag-syntax"></a>

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

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

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

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

```
  [Key](#cfn-iot-billinggroup-tag-key): String
  [Value](#cfn-iot-billinggroup-tag-value): String
```

## Properties
<a name="aws-properties-iot-billinggroup-tag-properties"></a>

`Key`  <a name="cfn-iot-billinggroup-tag-key"></a>
The tag's key.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
*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-iot-billinggroup-tag-value"></a>
The tag's value.  
*Required*: Yes  
*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)