Skip to content

Resource: awsVpcIpamResourceDiscovery

Provides an IPAM Resource Discovery resource. IPAM Resource Discoveries are resources meant for multi-organization customers. If you wish to use a single IPAM across multiple orgs, a resource discovery can be created and shared from a subordinate organization to the management organizations IPAM delegated admin account. For a full deployment example, see awsVpcIpamResourceDiscoveryAssociation resource.

Example Usage

Basic usage:

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
const dataAwsRegionCurrent = new aws.dataAwsRegion.DataAwsRegion(
  this,
  "current",
  {}
);
new aws.vpcIpamResourceDiscovery.VpcIpamResourceDiscovery(this, "main", {
  description: "My IPAM Resource Discovery",
  operatingRegions: [
    {
      regionName: dataAwsRegionCurrent.name,
    },
  ],
  tags: {
    Test: "Main",
  },
});

Argument Reference

The following arguments are supported:

  • description - (Optional) A description for the IPAM Resource Discovery.
  • operatingRegions - (Required) Determines which regions the Resource Discovery will enable IPAM features for usage and monitoring. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM Resource Discovery. You can only create VPCs from a pool whose locale matches the VPC's Region. You specify a region using the region_name parameter. You must set your provider block region as an operating_region.
  • tags - (Optional) A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

operatingRegions

  • regionName - (Required) The name of the Region you want to add to the IPAM.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • arn - Amazon Resource Name (ARN) of IPAM Resource Discovery
  • id - The ID of the IPAM Resource Discovery
  • isDefault - A boolean to identify if the Resource Discovery is the accounts default resource discovery
  • ownerId - The account ID for the account that manages the Resource Discovery
  • ipamResourceDiscoveryRegion - The home region of the Resource Discovery
  • tagsAll - A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

Import

IPAMs can be imported using the ipamResourceDiscoveryId, e.g.

$ terraform import aws_vpc_ipam_resource_discovery.example ipam-res-disco-0178368ad2146a492