AWS::EC2::IPAMResourceDiscoveryAssociation - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::EC2::IPAMResourceDiscoveryAssociation

An IPAM resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM. IPAM aggregates the resource CIDRs discovered by the associated resource discovery.

Syntax

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

JSON

{
  "Type" : "AWS::EC2::IPAMResourceDiscoveryAssociation",
  "Properties" : {
      "IpamId" : String,
      "IpamResourceDiscoveryId" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::EC2::IPAMResourceDiscoveryAssociation
Properties:
  IpamId: String
  IpamResourceDiscoveryId: String
  Tags: 
    - Tag

Properties

IpamId

The IPAM ID.

Required: Yes

Type: String

Update requires: Replacement

IpamResourceDiscoveryId

The resource discovery ID.

Required: Yes

Type: String

Update requires: Replacement

Tags

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

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

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.

Fn::GetAtt

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.

IpamArn

The IPAM ARN.

IpamRegion

The IPAM home Region.

IpamResourceDiscoveryAssociationArn

The resource discovery association ARN.

IpamResourceDiscoveryAssociationId

The resource discovery association ID.

IsDefault

Defines if the resource discovery is the default. When you create an IPAM, a default resource discovery is created for your IPAM and it's associated with your IPAM.

OwnerId

The owner ID.

ResourceDiscoveryStatus

The resource discovery status.

  • active - Connection or permissions required to read the results of the resource discovery are intact.

  • not-found - Connection or permissions required to read the results of the resource discovery are broken. This may happen if the owner of the resource discovery stopped sharing it or deleted the resource discovery. Verify the resource discovery still exists and the AWS RAM resource share is still intact.

State

The lifecycle state of the association when you associate or disassociate a resource discovery.

  • associate-in-progress - Resource discovery is being associated.

  • associate-complete - Resource discovery association is complete.

  • associate-failed - Resource discovery association has failed.

  • disassociate-in-progress - Resource discovery is being disassociated.

  • disassociate-complete - Resource discovery disassociation is complete.

  • disassociate-failed - Resource discovery disassociation has failed.

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

  • isolate-complete - Resource discovery isolation is complete..

  • restore-in-progress - Resource discovery is being restored.