AWS::NetworkManager::SiteToSiteVpnAttachment - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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

AWS::NetworkManager::SiteToSiteVpnAttachment

Creates an Amazon Web Services site-to-site VPN 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::SiteToSiteVpnAttachment",
  "Properties" : {
      "CoreNetworkId" : String,
      "NetworkFunctionGroupName" : String,
      "ProposedNetworkFunctionGroupChange" : ProposedNetworkFunctionGroupChange,
      "ProposedSegmentChange" : ProposedSegmentChange,
      "Tags" : [ Tag, ... ],
      "VpnConnectionArn" : String
    }
}

Properties

CoreNetworkId

Property description not available.

Required: Yes

Type: String

Update requires: Replacement

NetworkFunctionGroupName

The name of the network function group.

Required: No

Type: String

Pattern: [\s\S]*

Minimum: 0

Maximum: 256

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

Tags

The tags associated with the Site-to-Site VPN attachment.

Required: No

Type: Array of Tag

Update requires: No interruption

VpnConnectionArn

The ARN of the site-to-site VPN attachment.

Required: Yes

Type: String

Pattern: ^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:vpn-connection\/vpn-[0-9a-f]{8,17}$

Minimum: 0

Maximum: 500

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-05467e74104d33861" }.

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 site-to-site VPN attachment.

AttachmentPolicyRuleNumber

The policy rule number associated with the attachment.

AttachmentType

The type of attachment. This will be SITE_TO_SITE_VPN.

CoreNetworkArn

The ARN of the core network.

CreatedAt

The timestamp when the site-to-site VPN attachment was created.

EdgeLocation

The Region where the core network edge is located.

LastModificationErrors

Property description not available.

OwnerAccountId

The ID of the site-to-site VPN attachment owner.

ResourceArn

The resource ARN for the site-to-site VPN attachment.

SegmentName

The name of the site-to-site VPN attachment's segment.

State

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

UpdatedAt

The timestamp when the site-to-site VPN attachment was last updated.