AWS::NetworkManager::VpcAttachment
Creates a VPC attachment on an edge location of a core network.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::NetworkManager::VpcAttachment", "Properties" : { "CoreNetworkId" :
String
, "Options" :VpcOptions
, "ProposedSegmentChange" :ProposedSegmentChange
, "SubnetArns" :[ String, ... ]
, "Tags" :[
, "VpcArn" :Tag
, ... ]String
} }
YAML
Type: AWS::NetworkManager::VpcAttachment Properties: CoreNetworkId:
String
Options:VpcOptions
ProposedSegmentChange:ProposedSegmentChange
SubnetArns:- String
Tags:-
VpcArn:Tag
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
ProposedSegmentChange
Property description not available.
Required: No
Type: ProposedSegmentChange
Update requires: No interruption
SubnetArns
-
The subnet ARNs.
Required: Yes
Type: List of String
Update requires: No interruption
-
The tags associated with the VPC attachment.
Required: No
Type: List 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.
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.