ipam_resource_discovery

Gets or updates an individual ipam_resource_discovery resource, use ipam_resource_discoveries to retrieve a list of resources or to create or delete a resource.

Overview

Name	ipam_resource_discovery
Type	Resource
Description	Resource Schema of AWS::EC2::IPAMResourceDiscovery Type
Id	aws.ec2.ipam_resource_discovery

Fields

Name	Datatype	Description
ipam_resource_discovery_id	string	Id of the IPAM Pool.
owner_id	string	Owner Account ID of the Resource Discovery
operating_regions	array	The regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring
ipam_resource_discovery_region	string	The region the resource discovery is setup in.
description	string
is_default	boolean	Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
ipam_resource_discovery_arn	string	Amazon Resource Name (Arn) for the Resource Discovery.
state	string	The state of this Resource Discovery.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
get_resource	SELECT	data__Identifier, region

SELECT Example

SELECT
region,
ipam_resource_discovery_id,
owner_id,
operating_regions,
ipam_resource_discovery_region,
description,
is_default,
ipam_resource_discovery_arn,
state,
tags
FROM aws.ec2.ipam_resource_discovery
WHERE region = 'us-east-1' AND data__Identifier = '<IpamResourceDiscoveryId>';

Permissions

To operate on the ipam_resource_discovery resource, the following permissions are required:

Read

ec2:DescribeIpamResourceDiscoveries

Update

ec2:ModifyIpamResourceDiscovery,
ec2:DescribeIpamResourceDiscoveries,
ec2:CreateTags,
ec2:DeleteTags