aws_customer_gateway device name attribute

[mikereinhold]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

When creating more than one customer gateway with the same public IP and BGP ASN, the second resource creation does not actually create a new resource but instead imports the first resource created and that customer gateway ID can be found for both aws_customer_gateways in the Terraform state.

This behavior mimics the action in the console: creating a second customer gateway with the same public IP and BGP ASN will not create a new resource, but instead will return the id of the pre-existing customer gateway.

The way to get around this in the console is to provide a Device identifier, which will provide uniqueness within AWS:

At this point in time, the aws_customer_gateway resource does not allow setting the device-name field as exposed by the AWS API for create-customer-gateway:

Adding the device name attribute to the aws_customer_gateway resource would allow the Terraform user to avoid this accidental import of a pre-existing resource and explicitly declare that the two customer gateways are supposed to be unique by specifying a device name.

Having multiple customer gateways with the same BGP ASN and Public IP is a common scenario when you have redundant routers behind a NAT and need to distinguish between them separately in the AWS console.

New or Affected Resource(s)

• aws_customer_gateway

Potential Terraform Configuration

resource "aws_customer_gateway" "first" {
  bgp_asn    = 65000
  ip_address = "172.83.124.10"
  type       = "ipsec.1"

  device = "first"
}

resource "aws_customer_gateway" "second" {
  bgp_asn    = 65000
  ip_address = "172.83.124.10"
  type       = "ipsec.1"

  device = "second"
}

References

• https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/customer_gateway
• https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-customer-gateway.html

[bflad]

Support for device_name in the aws_customer_gateway resource and data source has been merged and will release with version 3.28.0 of the Terraform AWS Provider, later today. Thank you to @shuheiktgw for the implementation. 👍

[ghost]

This has been released in version 3.28.0 of the Terraform AWS provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template for triage. Thanks!

[ghost]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!