

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::NetworkManager::GlobalNetwork
<a name="aws-resource-networkmanager-globalnetwork"></a>

Creates a new, empty global network.

## Syntax
<a name="aws-resource-networkmanager-globalnetwork-syntax"></a>

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

### JSON
<a name="aws-resource-networkmanager-globalnetwork-syntax.json"></a>

```
{
  "Type" : "AWS::NetworkManager::GlobalNetwork",
  "Properties" : {
      "[CreatedAt](#cfn-networkmanager-globalnetwork-createdat)" : String,
      "[Description](#cfn-networkmanager-globalnetwork-description)" : String,
      "[State](#cfn-networkmanager-globalnetwork-state)" : String,
      "[Tags](#cfn-networkmanager-globalnetwork-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-networkmanager-globalnetwork-syntax.yaml"></a>

```
Type: AWS::NetworkManager::GlobalNetwork
Properties:
  [CreatedAt](#cfn-networkmanager-globalnetwork-createdat): String
  [Description](#cfn-networkmanager-globalnetwork-description): String
  [State](#cfn-networkmanager-globalnetwork-state): String
  [Tags](#cfn-networkmanager-globalnetwork-tags): 
    - Tag
```

## Properties
<a name="aws-resource-networkmanager-globalnetwork-properties"></a>

`CreatedAt`  <a name="cfn-networkmanager-globalnetwork-createdat"></a>
The date and time that the global network was created.  
*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)

`Description`  <a name="cfn-networkmanager-globalnetwork-description"></a>
A description of the global network.  
Constraints: Maximum length of 256 characters.  
*Required*: No  
*Type*: String  
*Pattern*: `[\s\S]*`  
*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)

`State`  <a name="cfn-networkmanager-globalnetwork-state"></a>
The state of the global network.  
*Required*: No  
*Type*: String  
*Allowed values*: `PENDING | AVAILABLE | DELETING | UPDATING`  
*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-networkmanager-globalnetwork-tags"></a>
The tags for the global network.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-networkmanager-globalnetwork-tag.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-networkmanager-globalnetwork-return-values"></a>

### Ref
<a name="aws-resource-networkmanager-globalnetwork-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the global network. For example: `global-network-01231231231231231`.

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-networkmanager-globalnetwork-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-networkmanager-globalnetwork-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The ARN of the global network. For example, `arn:aws:networkmanager::123456789012:global-network/global-network-01231231231231231`.

`Id`  <a name="Id-fn::getatt"></a>
The ID of the global network. For example, `global-network-01231231231231231`.

## Examples
<a name="aws-resource-networkmanager-globalnetwork--examples"></a>



### Global Network
<a name="aws-resource-networkmanager-globalnetwork--examples--Global_Network"></a>

The following example creates a global network.

#### JSON
<a name="aws-resource-networkmanager-globalnetwork--examples--Global_Network--json"></a>

```
{
    "Type": "AWS::NetworkManager::GlobalNetwork",
    "Properties": {
        "Description": "Global network for USA sites",
        "Tags": [
            {
                "Key": "Name",
                "Value": "global-network-usa"
            }
        ]
    }
}
```

#### YAML
<a name="aws-resource-networkmanager-globalnetwork--examples--Global_Network--yaml"></a>

```
Type: 'AWS::NetworkManager::GlobalNetwork'
Properties:
  Description: Global network for USA sites
  Tags:
    - Key: Name
      Value: global-network-usa
```

# AWS::NetworkManager::GlobalNetwork Tag
<a name="aws-properties-networkmanager-globalnetwork-tag"></a>

Describes a tag.

## Syntax
<a name="aws-properties-networkmanager-globalnetwork-tag-syntax"></a>

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

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

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

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

```
  [Key](#cfn-networkmanager-globalnetwork-tag-key): String
  [Value](#cfn-networkmanager-globalnetwork-tag-value): String
```

## Properties
<a name="aws-properties-networkmanager-globalnetwork-tag-properties"></a>

`Key`  <a name="cfn-networkmanager-globalnetwork-tag-key"></a>
The tag key.  
Constraints: Maximum length of 128 characters.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[\s\S]*`  
*Minimum*: `0`  
*Maximum*: `10000000`  
*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-networkmanager-globalnetwork-tag-value"></a>
The tag value.  
Constraints: Maximum length of 256 characters.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[\s\S]*`  
*Minimum*: `0`  
*Maximum*: `10000000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)