AWS::NetworkManager::GlobalNetwork

Creates a new, empty global network.

Syntax

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

JSON

{
  "Type" : "AWS::NetworkManager::GlobalNetwork",
  "Properties" : {
      "CreatedAt" : String,
      "Description" : String,
      "State" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::NetworkManager::GlobalNetwork
Properties:
  CreatedAt: String
  Description: String
  State: String
  Tags: 
    - Tag

Properties

CreatedAt

The date and time that the global network was created.

Required: No

Type: String

Update requires: No interruption

Description

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

State

The state of the global network.

Required: No

Type: String

Allowed values: PENDING | AVAILABLE | DELETING | UPDATING

Update requires: No interruption

Tags

The tags for the global network.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

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 Ref.

Fn::GetAtt

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 Fn::GetAtt.

Arn

The ARN of the global network. For example, arn:aws:networkmanager::123456789012:global-network/global-network-01231231231231231.

Id

The ID of the global network. For example, global-network-01231231231231231.

Examples

Global Network

The following example creates a global network.

JSON

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

YAML

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