AWS::NetworkManager::CoreNetwork

Describes a core network.

Syntax

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

JSON

{
  "Type" : "AWS::NetworkManager::CoreNetwork",
  "Properties" : {
      "Description" : String,
      "GlobalNetworkId" : String,
      "PolicyDocument" : Json,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::NetworkManager::CoreNetwork
Properties:
  Description: String
  GlobalNetworkId: String
  PolicyDocument: Json
  Tags: 
    - Tag

Properties

Description

The description of a core network.

Required: No

Type: String

Pattern: [\s\S]*

Minimum: 0

Maximum: 256

Update requires: No interruption

GlobalNetworkId

The ID of the global network that your core network is a part of.

Required: Yes

Type: String

Pattern: [\s\S]*

Minimum: 0

Maximum: 50

Update requires: Replacement

PolicyDocument

Describes a core network policy. For more information, see Core network policies.

If you update the policy document, CloudFormation will apply the core network change set generated from the updated policy document, and then set it as the LIVE policy.

Required: No

Type: Json

Update requires: No interruption

Tags

The list of key-value tags associated with a core 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 core network. For example, { "Ref: "core-network-060ea2740fe60fd38" }.

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.

CoreNetworkArn

The ARN of the core network.

CoreNetworkId

The ID of the core network.

CreatedAt

The timestamp when the core network was created.

Edges

The edges.

OwnerAccount

Property description not available.

Segments

The segments.

State

The current state of the core network. These states are: CREATING | UPDATING | AVAILABLE | DELETING.