direct_connect_gateway_association_proposals

Creates, updates, deletes, gets or lists a direct_connect_gateway_association_proposals resource.

Overview

Name	direct_connect_gateway_association_proposals
Type	Resource
Id	aws.directconnect.direct_connect_gateway_association_proposals

Fields

The following fields are returned by SELECT queries:

describe_direct_connect_gateway_association_proposals

Name	Datatype	Description
direct_connect_gateway_association_proposals	array	Describes the Direct Connect gateway association proposals.
next_token	string	The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_direct_connect_gateway_association_proposals	select	region		Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.
create_direct_connect_gateway_association_proposal	insert	region, directConnectGatewayId, directConnectGatewayOwnerAccount, gatewayId		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.
delete_direct_connect_gateway_association_proposal	delete	region		Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_direct_connect_gateway_association_proposals

Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.

SELECT
direct_connect_gateway_association_proposals,
next_token
FROM aws.directconnect.direct_connect_gateway_association_proposals
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_direct_connect_gateway_association_proposal

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.

INSERT INTO aws.directconnect.direct_connect_gateway_association_proposals (
directConnectGatewayId,
directConnectGatewayOwnerAccount,
gatewayId,
addAllowedPrefixesToDirectConnectGateway,
removeAllowedPrefixesToDirectConnectGateway,
region
)
SELECT 
'{{ directConnectGatewayId }}' /* required */,
'{{ directConnectGatewayOwnerAccount }}' /* required */,
'{{ gatewayId }}' /* required */,
'{{ addAllowedPrefixesToDirectConnectGateway }}',
'{{ removeAllowedPrefixesToDirectConnectGateway }}',
'{{ region }}'
RETURNING
direct_connect_gateway_association_proposal
;

Manifest

# Description fields are for documentation purposes
- name: direct_connect_gateway_association_proposals
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the direct_connect_gateway_association_proposals resource.
  - name: directConnectGatewayId
    value: "{{ directConnectGatewayId }}"
    description: |
      The ID of the Direct Connect gateway.
  - name: directConnectGatewayOwnerAccount
    value: "{{ directConnectGatewayOwnerAccount }}"
    description: |
      The ID of the Amazon Web Services account that owns the Direct Connect gateway.
  - name: gatewayId
    value: "{{ gatewayId }}"
    description: |
      The ID of the virtual private gateway or transit gateway.
  - name: addAllowedPrefixesToDirectConnectGateway
    description: |
      The Amazon VPC prefixes to advertise to the Direct Connect gateway.
    value:
      - cidr: "{{ cidr }}"
  - name: removeAllowedPrefixesToDirectConnectGateway
    description: |
      The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.
    value:
      - cidr: "{{ cidr }}"

DELETE examples

delete_direct_connect_gateway_association_proposal

Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.

DELETE FROM aws.directconnect.direct_connect_gateway_association_proposals
WHERE region = '{{ region }}' --required
;