NetworkManager / Client / create_connect_attachment
create_connect_attachment#
- NetworkManager.Client.create_connect_attachment(**kwargs)#
Creates a core network Connect attachment from a specified core network attachment.
A core network Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a core network and an appliance. A core network Connect attachment uses an existing VPC attachment as the underlying transport mechanism.
See also: AWS API Documentation
Request Syntax
response = client.create_connect_attachment( CoreNetworkId='string', EdgeLocation='string', TransportAttachmentId='string', Options={ 'Protocol': 'GRE' }, Tags=[ { 'Key': 'string', 'Value': 'string' }, ], ClientToken='string' )
- Parameters:
CoreNetworkId (string) –
[REQUIRED]
The ID of a core network where you want to create the attachment.
EdgeLocation (string) –
[REQUIRED]
The Region where the edge is located.
TransportAttachmentId (string) –
[REQUIRED]
The ID of the attachment between the two connections.
Options (dict) –
[REQUIRED]
Options for creating an attachment.
Protocol (string) –
The protocol used for the attachment connection.
Tags (list) –
The list of key-value 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
{ 'ConnectAttachment': { '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) }, 'TransportAttachmentId': 'string', 'Options': { 'Protocol': 'GRE' } } }
Response Structure
(dict) –
ConnectAttachment (dict) –
The response to a Connect attachment request.
Attachment (dict) –
The attachment details.
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.
TransportAttachmentId (string) –
The ID of the transport attachment.
Options (dict) –
Options for connecting an attachment.
Protocol (string) –
The protocol used for the attachment connection.
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