create_site_to_site_vpn_attachment¶

NetworkManager.Client.create_site_to_site_vpn_attachment(**kwargs)¶

Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.

Request Syntax

response = client.create_site_to_site_vpn_attachment(
    CoreNetworkId='string',
    VpnConnectionArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)

Parameters

CoreNetworkId (string) --
[REQUIRED]

The ID of a core network where you're creating a site-to-site VPN attachment.
VpnConnectionArn (string) --
[REQUIRED]

The ARN identifying the VPN attachment.
Tags (list) --
The tags associated with the request.
- (dict) --
  Describes a tag.
  - Key (string) --
    The tag key.
    
    Constraints: Maximum length of 128 characters.
  - Value (string) --
    The tag value.
    
    Constraints: Maximum length of 256 characters.
ClientToken (string) --
The client token associated with the request.

This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'SiteToSiteVpnAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
        'VpnConnectionArn': 'string'
    }
}

Response Structure

(dict) --
- SiteToSiteVpnAttachment (dict) --
  
  Details about a site-to-site VPN attachment.
  - Attachment (dict) --
    
    Provides details about a site-to-site VPN attachment.
    - CoreNetworkId (string) --
      
      The ID of a core network.
    - CoreNetworkArn (string) --
      
      The ARN of a core network.
    - AttachmentId (string) --
      
      The ID of the attachment.
    - OwnerAccountId (string) --
      
      The ID of the attachment account owner.
    - AttachmentType (string) --
      
      The type of attachment.
    - State (string) --
      
      The state of the attachment.
    - EdgeLocation (string) --
      
      The Region where the edge is located.
    - ResourceArn (string) --
      
      The attachment resource ARN.
    - AttachmentPolicyRuleNumber (integer) --
      
      The policy rule number associated with the attachment.
    - SegmentName (string) --
      
      The name of the segment attachment.
    - Tags (list) --
      
      The tags associated with the attachment.
      - (dict) --
        
        Describes a tag.
        
        Key (string) --
        
        The tag key.
        
        Constraints: Maximum length of 128 characters.
        
        Value (string) --
        
        The tag value.
        
        Constraints: Maximum length of 256 characters.
    - ProposedSegmentChange (dict) --
      
      The attachment to move from one segment to another.
      - Tags (list) --
        
        The list of key-value tags that changed for the segment.
        
        (dict) --
        
        Describes a tag.
        
        Key (string) --
        
        The tag key.
        
        Constraints: Maximum length of 128 characters.
        
        Value (string) --
        
        The tag value.
        
        Constraints: Maximum length of 256 characters.
      - AttachmentPolicyRuleNumber (integer) --
        
        The rule number in the policy document that applies to this change.
      - SegmentName (string) --
        
        The name of the segment to change.
    - CreatedAt (datetime) --
      
      The timestamp when the attachment was created.
    - UpdatedAt (datetime) --
      
      The timestamp when the attachment was last updated.
  - VpnConnectionArn (string) --
    
    The ARN of the site-to-site VPN attachment.

Exceptions

NetworkManager.Client.exceptions.ValidationException
NetworkManager.Client.exceptions.AccessDeniedException
NetworkManager.Client.exceptions.ResourceNotFoundException
NetworkManager.Client.exceptions.ConflictException
NetworkManager.Client.exceptions.ThrottlingException
NetworkManager.Client.exceptions.InternalServerException

Table Of Contents

create_site_to_site_vpn_attachment¶