AWS::NetworkManager::GlobalNetwork - AWS CloudFormation

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" : { "Description" : String, "Tags" : [ Tag, ... ] } }

YAML

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

Properties

Description

A description of the global network.

Length Constraints: Maximum length of 256 characters.

Required: No

Type: String

Update requires: No interruption

Tags

The tags for the global network.

Required: No

Type: List 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