ipam_resource_discovery_associations

Creates, updates, deletes, gets or lists an ipam_resource_discovery_associations resource.

Overview

Name	ipam_resource_discovery_associations
Type	Resource
Id	aws.ec2.ipam_resource_discovery_associations

Fields

The following fields are returned by SELECT queries:

describe_ipam_resource_discovery_associations

Name	Datatype	Description
ipam_arn	string	The IPAM ARN.
ipam_id	string	The IPAM ID.
ipam_region	string	The IPAM home Region.
ipam_resource_discovery_association_arn	string	The resource discovery association Amazon Resource Name (ARN).
ipam_resource_discovery_association_id	string	The resource discovery association ID.
ipam_resource_discovery_id	string	The resource discovery ID.
is_default	boolean	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.
owner_id	string	The Amazon Web Services account ID of the resource discovery owner.
resource_discovery_status	string	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 Amazon Web Services RAM resource share is still intact.
state	string	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 - Amazon Web Services account that created the resource discovery association has been removed and the resource discovery association is being isolated. isolate-complete - Resource discovery isolation is complete. restore-in-progress - Resource discovery is being restored.
tags	string	A tag is a label that you assign to an Amazon Web Services 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 Web Services costs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_ipam_resource_discovery_associations	select	region	DryRun, IpamResourceDiscoveryAssociationId, NextToken, MaxResults, Filter	Describes resource discovery association with an Amazon VPC IPAM. An associated resource discovery is a resource discovery that has been associated with an IPAM..

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
DryRun	boolean	A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filter	array	The resource discovery association filters.
IpamResourceDiscoveryAssociationId	array	The resource discovery association IDs.
MaxResults	integer	The maximum number of resource discovery associations to return in one page of results.
NextToken	string	Specify the pagination token from a previous request to retrieve the next page of results.

SELECT examples

describe_ipam_resource_discovery_associations

Describes resource discovery association with an Amazon VPC IPAM. An associated resource discovery is a resource discovery that has been associated with an IPAM..

SELECT
ipam_arn,
ipam_id,
ipam_region,
ipam_resource_discovery_association_arn,
ipam_resource_discovery_association_id,
ipam_resource_discovery_id,
is_default,
owner_id,
resource_discovery_status,
state,
tags
FROM aws.ec2.ipam_resource_discovery_associations
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND IpamResourceDiscoveryAssociationId = '{{ IpamResourceDiscoveryAssociationId }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND Filter = '{{ Filter }}'
;