customer_gateway_associations

Creates, updates, deletes or gets a customer_gateway_association resource or lists customer_gateway_associations in a region

Overview

Name	customer_gateway_associations
Type	Resource
Description	The AWS::NetworkManager::CustomerGatewayAssociation type associates a customer gateway with a device and optionally, with a link.
Id	aws.networkmanager.customer_gateway_associations

Fields

Name	Datatype	Description
global_network_id	string	The ID of the global network.
customer_gateway_arn	string	The Amazon Resource Name (ARN) of the customer gateway.
device_id	string	The ID of the device
link_id	string	The ID of the link
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	GlobalNetworkId, CustomerGatewayArn, DeviceId, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all customer_gateway_associations in a region.

SELECT
region,
global_network_id,
customer_gateway_arn,
device_id,
link_id
FROM aws.networkmanager.customer_gateway_associations
WHERE region = 'us-east-1';

Gets all properties from an individual customer_gateway_association.

SELECT
region,
global_network_id,
customer_gateway_arn,
device_id,
link_id
FROM aws.networkmanager.customer_gateway_associations
WHERE region = 'us-east-1' AND data__Identifier = '<GlobalNetworkId>|<CustomerGatewayArn>';

INSERT example

Use the following StackQL query and manifest file to create a new customer_gateway_association resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.networkmanager.customer_gateway_associations (
 GlobalNetworkId,
 CustomerGatewayArn,
 DeviceId,
 region
)
SELECT 
'{{ GlobalNetworkId }}',
 '{{ CustomerGatewayArn }}',
 '{{ DeviceId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.networkmanager.customer_gateway_associations (
 GlobalNetworkId,
 CustomerGatewayArn,
 DeviceId,
 LinkId,
 region
)
SELECT 
 '{{ GlobalNetworkId }}',
 '{{ CustomerGatewayArn }}',
 '{{ DeviceId }}',
 '{{ LinkId }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: customer_gateway_association
    props:
      - name: GlobalNetworkId
        value: '{{ GlobalNetworkId }}'
      - name: CustomerGatewayArn
        value: '{{ CustomerGatewayArn }}'
      - name: DeviceId
        value: '{{ DeviceId }}'
      - name: LinkId
        value: '{{ LinkId }}'

DELETE example

/*+ delete */
DELETE FROM aws.networkmanager.customer_gateway_associations
WHERE data__Identifier = '<GlobalNetworkId|CustomerGatewayArn>'
AND region = 'us-east-1';

Permissions

To operate on the customer_gateway_associations resource, the following permissions are required:

Create

networkmanager:GetCustomerGatewayAssociations,
networkmanager:AssociateCustomerGateway

Read

networkmanager:GetCustomerGatewayAssociations

List

networkmanager:GetCustomerGatewayAssociations

Delete

networkmanager:DisassociateCustomerGateway