ipam_resource_discoveries

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

Overview

Name	ipam_resource_discoveries
Type	Resource
Id	aws.ec2.ipam_resource_discoveries

Fields

The following fields are returned by SELECT queries:

describe_ipam_resource_discoveries

Name	Datatype	Description
description	string	The resource discovery description.
ipam_resource_discovery_arn	string	The resource discovery Amazon Resource Name (ARN).
ipam_resource_discovery_id	string	The resource discovery ID.
ipam_resource_discovery_region	string	The resource discovery Region.
is_default	boolean	Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.
operating_regions	string	The operating Regions for the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
organizational_unit_exclusions	string	If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion.
owner_id	string	The ID of the owner.
state	string	The lifecycle state of the resource discovery. 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 Web Services 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 Web Services account that created the resource discovery and was isolated has been 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_discoveries	select	region	DryRun, IpamResourceDiscoveryId, NextToken, MaxResults, Filter	Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
create_ipam_resource_discovery	insert	region	DryRun, Description, OperatingRegion, TagSpecification, ClientToken	Creates an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
associate_ipam_resource_discovery	update	IpamId, IpamResourceDiscoveryId, region	DryRun, TagSpecification, ClientToken	Associates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
disassociate_ipam_resource_discovery	update	IpamResourceDiscoveryAssociationId, region	DryRun	Disassociates a resource discovery from an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
modify_ipam_resource_discovery	update	IpamResourceDiscoveryId, region	DryRun, Description, AddOperatingRegion, RemoveOperatingRegion, AddOrganizationalUnitExclusion, RemoveOrganizationalUnitExclusion	Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
delete_ipam_resource_discovery	delete	IpamResourceDiscoveryId, region	DryRun	Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

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
IpamId	string	An IPAM ID.
IpamResourceDiscoveryAssociationId	string	A resource discovery association ID.
IpamResourceDiscoveryId	string	The IPAM resource discovery ID.
region	string	AWS region (default: us-east-1)
AddOperatingRegion	array	Add operating Regions to the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
AddOrganizationalUnitExclusion	array	Add an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide. The resulting set of exclusions must not result in "overlap", meaning two or more OU exclusions must not exclude the same OU. For more information and examples, see the Amazon Web Services CLI request process in Add or remove OU exclusions in the Amazon VPC User Guide.
ClientToken	string	A client token.
Description	string	A resource discovery description.
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 filters.
IpamResourceDiscoveryId	array	The IPAM resource discovery IDs.
MaxResults	integer	The maximum number of resource discoveries to return in one page of results.
NextToken	string	The token for the next page of results.
OperatingRegion	array	Operating Regions for the IPAM resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
RemoveOperatingRegion	array	Remove operating Regions.
RemoveOrganizationalUnitExclusion	array	Remove an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide. The resulting set of exclusions must not result in "overlap", meaning two or more OU exclusions must not exclude the same OU. For more information and examples, see the Amazon Web Services CLI request process in Add or remove OU exclusions in the Amazon VPC User Guide.
TagSpecification	array	Tag specifications.

SELECT examples

describe_ipam_resource_discoveries

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

SELECT
description,
ipam_resource_discovery_arn,
ipam_resource_discovery_id,
ipam_resource_discovery_region,
is_default,
operating_regions,
organizational_unit_exclusions,
owner_id,
state,
tags
FROM aws.ec2.ipam_resource_discoveries
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND IpamResourceDiscoveryId = '{{ IpamResourceDiscoveryId }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND Filter = '{{ Filter }}'
;

INSERT examples

create_ipam_resource_discovery

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

INSERT INTO aws.ec2.ipam_resource_discoveries (
region,
DryRun,
Description,
OperatingRegion,
TagSpecification,
ClientToken
)
SELECT 
'{{ region }}',
'{{ DryRun }}',
'{{ Description }}',
'{{ OperatingRegion }}',
'{{ TagSpecification }}',
'{{ ClientToken }}'
RETURNING
description,
ipam_resource_discovery_arn,
ipam_resource_discovery_id,
ipam_resource_discovery_region,
is_default,
operating_regions,
organizational_unit_exclusions,
owner_id,
state,
tags
;

Manifest

# Description fields are for documentation purposes
- name: ipam_resource_discoveries
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the ipam_resource_discoveries resource.
  - name: DryRun
    value: {{ DryRun }}
    description: 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.
    description: 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.
  - name: Description
    value: "{{ Description }}"
    description: A description for the IPAM resource discovery.
    description: A description for the IPAM resource discovery.
  - name: OperatingRegion
    value: "{{ OperatingRegion }}"
    description: Operating Regions for the IPAM resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
    description: Operating Regions for the IPAM resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: Tag specifications for the IPAM resource discovery.
    description: Tag specifications for the IPAM resource discovery.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: A client token for the IPAM resource discovery.
    description: A client token for the IPAM resource discovery.

UPDATE examples

associate_ipam_resource_discovery

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

UPDATE aws.ec2.ipam_resource_discoveries
SET 
-- No updatable properties
WHERE 
IpamId = '{{ IpamId }}' --required
AND IpamResourceDiscoveryId = '{{ IpamResourceDiscoveryId }}' --required
AND region = '{{ region }}' --required
AND DryRun = {{ DryRun}}
AND TagSpecification = '{{ TagSpecification}}'
AND ClientToken = '{{ ClientToken}}'
RETURNING
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;

disassociate_ipam_resource_discovery

Disassociates a resource discovery from an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

UPDATE aws.ec2.ipam_resource_discoveries
SET 
-- No updatable properties
WHERE 
IpamResourceDiscoveryAssociationId = '{{ IpamResourceDiscoveryAssociationId }}' --required
AND region = '{{ region }}' --required
AND DryRun = {{ DryRun}}
RETURNING
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;

modify_ipam_resource_discovery

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

UPDATE aws.ec2.ipam_resource_discoveries
SET 
-- No updatable properties
WHERE 
IpamResourceDiscoveryId = '{{ IpamResourceDiscoveryId }}' --required
AND region = '{{ region }}' --required
AND DryRun = {{ DryRun}}
AND Description = '{{ Description}}'
AND AddOperatingRegion = '{{ AddOperatingRegion}}'
AND RemoveOperatingRegion = '{{ RemoveOperatingRegion}}'
AND AddOrganizationalUnitExclusion = '{{ AddOrganizationalUnitExclusion}}'
AND RemoveOrganizationalUnitExclusion = '{{ RemoveOrganizationalUnitExclusion}}'
RETURNING
description,
ipam_resource_discovery_arn,
ipam_resource_discovery_id,
ipam_resource_discovery_region,
is_default,
operating_regions,
organizational_unit_exclusions,
owner_id,
state,
tags;

DELETE examples

delete_ipam_resource_discovery

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

DELETE FROM aws.ec2.ipam_resource_discoveries
WHERE IpamResourceDiscoveryId = '{{ IpamResourceDiscoveryId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;