AWS Fundamentals Logo
AWS Fundamentals
AWS::NetworkManager::CustomerGatewayAssociation

NetworkManager CustomerGatewayAssociation

The AWS::NetworkManager::CustomerGatewayAssociation type associates a customer gateway with a device and optionally, with a link.

Properties

4 configurable properties. 3 required. Click a row to see details.

Filter:
PropertyTypeFlags
CustomerGatewayArn
string
RequiredCreate-only
DeviceId
string
RequiredCreate-only
GlobalNetworkId
string
RequiredCreate-only
LinkId
string
Create-only

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::NetworkManager::CustomerGatewayAssociation

Resources:
  MyResource:
    Type: AWS::NetworkManager::CustomerGatewayAssociation
    Properties:
      GlobalNetworkId: "my-globalnetworkid"
      CustomerGatewayArn: "arn:aws:service:region:account:resource"
      DeviceId: "my-deviceid"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

networkmanager:GetCustomerGatewayAssociationsnetworkmanager:AssociateCustomerGateway

read

networkmanager:GetCustomerGatewayAssociations

list

networkmanager:GetCustomerGatewayAssociations

delete

networkmanager:DisassociateCustomerGateway

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceNetworkManager
Properties4
Required3
TaggingNot supported
Primary IDGlobalNetworkId

Supported Operations

CreateReadListDelete

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

GlobalNetworkIdCustomerGatewayArnDeviceIdLinkId

External Links