AWS::EC2::IPAMResourceDiscovery - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.


To declare this entity in your Amazon CloudFormation template, use the following syntax:


{ "Type" : "AWS::EC2::IPAMResourceDiscovery", "Properties" : { "Description" : String, "OperatingRegions" : [ IpamOperatingRegion, ... ], "Tags" : [ Tag, ... ] } }


Type: AWS::EC2::IPAMResourceDiscovery Properties: Description: String OperatingRegions: - IpamOperatingRegion Tags: - Tag



The resource discovery description.

Required: No

Type: String

Update requires: No interruption


The operating Regions for the resource discovery. Operating Regions are Amazon Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Regions you select as operating Regions.

Required: No

Type: Array of IpamOperatingRegion

Update requires: No interruption


A tag is a label that you assign to an Amazon resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon costs.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values


When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource discovery ID. For example: ipam-res-disco-111122223333.

For more information about using the Ref function, see Ref.


The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.


The resource discovery ARN.


The resource discovery ID.


The resource discovery Region.


Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.


The owner ID.


The resource discovery's state.

  • create-in-progress - Resource discovery is being created.

  • create-complete - Resource discovery creation is complete.

  • create-failed - Resource discovery creation has failed.

  • modify-in-progress - Resource discovery is being modified.

  • modify-complete - Resource discovery modification is complete.

  • modify-failed - Resource discovery modification has failed.

  • delete-in-progress - Resource discovery is being deleted.

  • delete-complete - Resource discovery deletion is complete.

  • delete-failed - Resource discovery deletion has failed.

  • isolate-in-progress - Amazon account that created the resource discovery has been removed and the resource discovery is being isolated.

  • isolate-complete - Resource discovery isolation is complete.

  • restore-in-progress - Amazon account that created the resource discovery and was isolated has been restored.