create_direct_connect_gateway_association_proposal¶

DirectConnect.Client.create_direct_connect_gateway_association_proposal(**kwargs)¶

Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.

You can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.create_direct_connect_gateway_association_proposal(
    directConnectGatewayId='string',
    directConnectGatewayOwnerAccount='string',
    gatewayId='string',
    addAllowedPrefixesToDirectConnectGateway=[
        {
            'cidr': 'string'
        },
    ],
    removeAllowedPrefixesToDirectConnectGateway=[
        {
            'cidr': 'string'
        },
    ]
)

Parameters

directConnectGatewayId (string) --
[REQUIRED]

The ID of the Direct Connect gateway.
directConnectGatewayOwnerAccount (string) --
[REQUIRED]

The ID of the Amazon Web Services account that owns the Direct Connect gateway.
gatewayId (string) --
[REQUIRED]

The ID of the virtual private gateway or transit gateway.
addAllowedPrefixesToDirectConnectGateway (list) --
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
- (dict) --
  Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
  - cidr (string) --
    The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
removeAllowedPrefixesToDirectConnectGateway (list) --
The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.
- (dict) --
  Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
  - cidr (string) --
    The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

Return type

dict

Returns

Response Syntax

{
    'directConnectGatewayAssociationProposal': {
        'proposalId': 'string',
        'directConnectGatewayId': 'string',
        'directConnectGatewayOwnerAccount': 'string',
        'proposalState': 'requested'|'accepted'|'deleted',
        'associatedGateway': {
            'id': 'string',
            'type': 'virtualPrivateGateway'|'transitGateway',
            'ownerAccount': 'string',
            'region': 'string'
        },
        'existingAllowedPrefixesToDirectConnectGateway': [
            {
                'cidr': 'string'
            },
        ],
        'requestedAllowedPrefixesToDirectConnectGateway': [
            {
                'cidr': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- directConnectGatewayAssociationProposal (dict) --
  
  Information about the Direct Connect gateway proposal.
  - proposalId (string) --
    
    The ID of the association proposal.
  - directConnectGatewayId (string) --
    
    The ID of the Direct Connect gateway.
  - directConnectGatewayOwnerAccount (string) --
    
    The ID of the Amazon Web Services account that owns the Direct Connect gateway.
  - proposalState (string) --
    
    The state of the proposal. The following are possible values:
    - accepted : The proposal has been accepted. The Direct Connect gateway association is available to use in this state.
    - deleted : The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.
    - requested : The proposal has been requested. The Direct Connect gateway association cannot be used in this state.
  - associatedGateway (dict) --
    
    Information about the associated gateway.
    - id (string) --
      
      The ID of the associated gateway.
    - type (string) --
      
      The type of associated gateway.
    - ownerAccount (string) --
      
      The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.
    - region (string) --
      
      The Region where the associated gateway is located.
  - existingAllowedPrefixesToDirectConnectGateway (list) --
    
    The existing Amazon VPC prefixes advertised to the Direct Connect gateway.
    - (dict) --
      
      Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
      - cidr (string) --
        
        The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
  - requestedAllowedPrefixesToDirectConnectGateway (list) --
    
    The Amazon VPC prefixes to advertise to the Direct Connect gateway.
    - (dict) --
      
      Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
      - cidr (string) --
        
        The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

Exceptions

DirectConnect.Client.exceptions.DirectConnectServerException
DirectConnect.Client.exceptions.DirectConnectClientException

Table Of Contents

create_direct_connect_gateway_association_proposal¶