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	awscc.networkmanager.customer_gateway_associations

Fields

get (all properties)

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.

list (identifiers only)

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.
region	string	AWS region.

For more information, see AWS::NetworkManager::CustomerGatewayAssociation.

Methods

Name	Resource	Accessible by	Required Params
create_resource	customer_gateway_associations	INSERT	GlobalNetworkId, CustomerGatewayArn, DeviceId, region
delete_resource	customer_gateway_associations	DELETE	Identifier, region
list_resources	customer_gateway_associations_list_only	SELECT	region
get_resource	customer_gateway_associations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual customer_gateway_association.

SELECT
  region,
  global_network_id,
  customer_gateway_arn,
  device_id,
  link_id
FROM awscc.networkmanager.customer_gateway_associations
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ global_network_id }}|{{ customer_gateway_arn }}';

list (identifiers only)

Lists all customer_gateway_associations in a region.

SELECT
  region,
  global_network_id,
  customer_gateway_arn
FROM awscc.networkmanager.customer_gateway_associations_list_only
WHERE
  region = 'us-east-1';

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 awscc.networkmanager.customer_gateway_associations (
  GlobalNetworkId,
  CustomerGatewayArn,
  DeviceId,
  region
)
SELECT
  '{{ global_network_id }}',
  '{{ customer_gateway_arn }}',
  '{{ device_id }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.networkmanager.customer_gateway_associations (
  GlobalNetworkId,
  CustomerGatewayArn,
  DeviceId,
  LinkId,
  region
)
SELECT
  '{{ global_network_id }}',
  '{{ customer_gateway_arn }}',
  '{{ device_id }}',
  '{{ link_id }}',
  '{{ 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: global_network_id
        value: '{{ global_network_id }}'
      - name: customer_gateway_arn
        value: '{{ customer_gateway_arn }}'
      - name: device_id
        value: '{{ device_id }}'
      - name: link_id
        value: '{{ link_id }}'

DELETE example

/*+ delete */
DELETE FROM awscc.networkmanager.customer_gateway_associations
WHERE
  Identifier = '{{ global_network_id }}|{{ customer_gateway_arn }}' 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