AWS::NetworkManager::VpcAttachment - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::NetworkManager::VpcAttachment

Creates a VPC attachment on an edge location of a core network.

Syntax

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

JSON

{
  "Type" : "AWS::NetworkManager::VpcAttachment",
  "Properties" : {
      "CoreNetworkId" : String,
      "Options" : VpcOptions,
      "ProposedNetworkFunctionGroupChange" : ProposedNetworkFunctionGroupChange,
      "ProposedSegmentChange" : ProposedSegmentChange,
      "SubnetArns" : [ String, ... ],
      "Tags" : [ Tag, ... ],
      "VpcArn" : String
    }
}

Properties

CoreNetworkId

The core network ID.

Required: Yes

Type: String

Update requires: Replacement

Options

Options for creating the VPC attachment.

Required: No

Type: VpcOptions

Update requires: No interruption

ProposedNetworkFunctionGroupChange

Describes proposed changes to a network function group.

Required: No

Type: ProposedNetworkFunctionGroupChange

Update requires: No interruption

ProposedSegmentChange

Describes a proposed segment change. In some cases, the segment change must first be evaluated and accepted.

Required: No

Type: ProposedSegmentChange

Update requires: No interruption

SubnetArns

The subnet ARNs.

Required: Yes

Type: Array of String

Update requires: No interruption

Tags

The tags associated with the VPC attachment.

Required: No

Type: Array of Tag

Update requires: No interruption

VpcArn

The ARN of the VPC attachment.

Required: Yes

Type: String

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the AttachmentId. For example, { "Ref: "attachment-00067e74104d33769" }.

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.

AttachmentId

The ID of the VPC attachment.

AttachmentPolicyRuleNumber

The policy rule number associated with the attachment.

AttachmentType

The type of attachment. This will be VPC.

CoreNetworkArn

The ARN of the core network.

CreatedAt

The timestamp when the VPC attachment was created.

EdgeLocation

The Region where the core network edge is located.

LastModificationErrors

Property description not available.

NetworkFunctionGroupName

The name of the network function group.

OwnerAccountId

The ID of the VPC attachment owner.

ResourceArn

The resource ARN for the VPC attachment.

SegmentName

The name of the attachment's segment.

State

The state of the attachment. This can be: REJECTED | PENDING_ATTACHMENT_ACCEPTANCE | CREATING | FAILED | AVAILABLE | UPDATING | PENDING_NETWORK_UPDATE | PENDING_TAG_ACCEPTANCE | DELETING.

UpdatedAt

The timestamp when the VPC attachment was last updated.