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.
This module creates following resources.
aws_vpc_ipam_resource_discovery
| Name |
Source |
Version |
| resource_group |
tedilabs/misc/aws//modules/resource-group |
~> 0.12.0 |
| share |
tedilabs/organization/aws//modules/ram-share |
~> 0.5.0 |
| Name |
Description |
Type |
Default |
Required |
| name |
(Required) The name of the IPAM resource discovery. |
string |
n/a |
yes |
| description |
(Optional) A description for the IPAM resource discovery. |
string |
"Managed by Terraform." |
no |
| module_tags_enabled |
(Optional) Whether to create AWS Resource Tags for the module informations. |
bool |
true |
no |
| operating_regions |
(Optional) A set of operating regions for the IPAM resource discovery. Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions. The current region is required to include. |
set(string) |
[] |
no |
| region |
(Optional) The region in which to create the module resources. If not provided, the module resources will be created in the provider's configured region. |
string |
null |
no |
| resource_group |
(Optional) A configurations of Resource Group for this module. resource_group as defined below.
(Optional) enabled - Whether to create Resource Group to find and group AWS resources which are created by this module. Defaults to true.
(Optional) name - The name of Resource Group. A Resource Group name can have a maximum of 127 characters, including letters, numbers, hyphens, dots, and underscores. The name cannot start with AWS or aws. If not provided, a name will be generated using the module name and instance name.
(Optional) description - The description of Resource Group. Defaults to Managed by Terraform.. |
object({
enabled = optional(bool, true)
name = optional(string, "")
description = optional(string, "Managed by Terraform.")
}) |
{} |
no |
| shares |
(Optional) A list of resource shares via RAM (Resource Access Manager). |
list(object({
name = optional(string)
permissions = optional(set(string), ["AWSRAMPermissionIpamResourceDiscovery"])
external_principals_allowed = optional(bool, false)
principals = optional(set(string), [])
tags = optional(map(string), {})
})) |
[] |
no |
| tags |
(Optional) A map of tags to add to all resources. |
map(string) |
{} |
no |
| Name |
Description |
| arn |
The ARN of the IPAM resource discovery. |
| description |
The description of the IPAM resource discovery. |
| home_region |
The home region of the Resource Discovery. |
| id |
The ID of the IPAM resource discovery. |
| is_default |
Whether the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM. |
| name |
The name of the IPAM resource discovery. |
| operating_regions |
A set of operating regions for the IPAM resource discovery. |
| owner_id |
The account ID for the account that manages the Resource Discovery. |
| region |
The AWS region this module resources resides in. |
| resource_group |
The resource group created to manage resources in this module. |
| sharing |
The configuration for sharing of the IPAM resource discovery.
status - An indication of whether the IPAM resource discovery is shared with other AWS accounts, or was shared with the current account by another AWS account. Sharing is configured through AWS Resource Access Manager (AWS RAM). Values are NOT_SHARED, SHARED_BY_ME or SHARED_WITH_ME.
shares - The list of resource shares via RAM (Resource Access Manager). |