Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. ec2
  5. getIpamResourceDiscovery

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.ec2.getIpamResourceDiscovery

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Schema of AWS::EC2::IPAMResourceDiscovery Type

Using getIpamResourceDiscovery

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getIpamResourceDiscovery(args: GetIpamResourceDiscoveryArgs, opts?: InvokeOptions): Promise<GetIpamResourceDiscoveryResult>
function getIpamResourceDiscoveryOutput(args: GetIpamResourceDiscoveryOutputArgs, opts?: InvokeOptions): Output<GetIpamResourceDiscoveryResult>
Copy
def get_ipam_resource_discovery(ipam_resource_discovery_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetIpamResourceDiscoveryResult
def get_ipam_resource_discovery_output(ipam_resource_discovery_id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetIpamResourceDiscoveryResult]
Copy
func LookupIpamResourceDiscovery(ctx *Context, args *LookupIpamResourceDiscoveryArgs, opts ...InvokeOption) (*LookupIpamResourceDiscoveryResult, error)
func LookupIpamResourceDiscoveryOutput(ctx *Context, args *LookupIpamResourceDiscoveryOutputArgs, opts ...InvokeOption) LookupIpamResourceDiscoveryResultOutput
Copy

> Note: This function is named LookupIpamResourceDiscovery in the Go SDK.

public static class GetIpamResourceDiscovery 
{
    public static Task<GetIpamResourceDiscoveryResult> InvokeAsync(GetIpamResourceDiscoveryArgs args, InvokeOptions? opts = null)
    public static Output<GetIpamResourceDiscoveryResult> Invoke(GetIpamResourceDiscoveryInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIpamResourceDiscoveryResult> getIpamResourceDiscovery(GetIpamResourceDiscoveryArgs args, InvokeOptions options)
public static Output<GetIpamResourceDiscoveryResult> getIpamResourceDiscovery(GetIpamResourceDiscoveryArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:ec2:getIpamResourceDiscovery
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

IpamResourceDiscoveryId This property is required. string
Id of the IPAM Pool.
IpamResourceDiscoveryId This property is required. string
Id of the IPAM Pool.
ipamResourceDiscoveryId This property is required. String
Id of the IPAM Pool.
ipamResourceDiscoveryId This property is required. string
Id of the IPAM Pool.
ipam_resource_discovery_id This property is required. str
Id of the IPAM Pool.
ipamResourceDiscoveryId This property is required. String
Id of the IPAM Pool.

getIpamResourceDiscovery Result

The following output properties are available:

Description string
The resource discovery description.
IpamResourceDiscoveryArn string
Amazon Resource Name (Arn) for the Resource Discovery.
IpamResourceDiscoveryId string
Id of the IPAM Pool.
IpamResourceDiscoveryRegion string
The region the resource discovery is setup in.
IsDefault bool
Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
OperatingRegions List<Pulumi.AwsNative.Ec2.Outputs.IpamResourceDiscoveryIpamOperatingRegion>
The regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring
OrganizationalUnitExclusions List<Pulumi.AwsNative.Ec2.Outputs.IpamResourceDiscoveryOrganizationalUnitExclusion>
A set of organizational unit (OU) exclusions for this resource.
OwnerId string
Owner Account ID of the Resource Discovery
State string
The state of this Resource Discovery.
Tags List<Pulumi.AwsNative.Outputs.Tag>
An array of key-value pairs to apply to this resource.
Description string
The resource discovery description.
IpamResourceDiscoveryArn string
Amazon Resource Name (Arn) for the Resource Discovery.
IpamResourceDiscoveryId string
Id of the IPAM Pool.
IpamResourceDiscoveryRegion string
The region the resource discovery is setup in.
IsDefault bool
Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
OperatingRegions []IpamResourceDiscoveryIpamOperatingRegion
The regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring
OrganizationalUnitExclusions []IpamResourceDiscoveryOrganizationalUnitExclusion
A set of organizational unit (OU) exclusions for this resource.
OwnerId string
Owner Account ID of the Resource Discovery
State string
The state of this Resource Discovery.
Tags Tag
An array of key-value pairs to apply to this resource.
description String
The resource discovery description.
ipamResourceDiscoveryArn String
Amazon Resource Name (Arn) for the Resource Discovery.
ipamResourceDiscoveryId String
Id of the IPAM Pool.
ipamResourceDiscoveryRegion String
The region the resource discovery is setup in.
isDefault Boolean
Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
operatingRegions List<IpamResourceDiscoveryIpamOperatingRegion>
The regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring
organizationalUnitExclusions List<IpamResourceDiscoveryOrganizationalUnitExclusion>
A set of organizational unit (OU) exclusions for this resource.
ownerId String
Owner Account ID of the Resource Discovery
state String
The state of this Resource Discovery.
tags List<Tag>
An array of key-value pairs to apply to this resource.
description string
The resource discovery description.
ipamResourceDiscoveryArn string
Amazon Resource Name (Arn) for the Resource Discovery.
ipamResourceDiscoveryId string
Id of the IPAM Pool.
ipamResourceDiscoveryRegion string
The region the resource discovery is setup in.
isDefault boolean
Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
operatingRegions IpamResourceDiscoveryIpamOperatingRegion[]
The regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring
organizationalUnitExclusions IpamResourceDiscoveryOrganizationalUnitExclusion[]
A set of organizational unit (OU) exclusions for this resource.
ownerId string
Owner Account ID of the Resource Discovery
state string
The state of this Resource Discovery.
tags Tag[]
An array of key-value pairs to apply to this resource.
description str
The resource discovery description.
ipam_resource_discovery_arn str
Amazon Resource Name (Arn) for the Resource Discovery.
ipam_resource_discovery_id str
Id of the IPAM Pool.
ipam_resource_discovery_region str
The region the resource discovery is setup in.
is_default bool
Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
operating_regions Sequence[IpamResourceDiscoveryIpamOperatingRegion]
The regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring
organizational_unit_exclusions Sequence[IpamResourceDiscoveryOrganizationalUnitExclusion]
A set of organizational unit (OU) exclusions for this resource.
owner_id str
Owner Account ID of the Resource Discovery
state str
The state of this Resource Discovery.
tags Sequence[root_Tag]
An array of key-value pairs to apply to this resource.
description String
The resource discovery description.
ipamResourceDiscoveryArn String
Amazon Resource Name (Arn) for the Resource Discovery.
ipamResourceDiscoveryId String
Id of the IPAM Pool.
ipamResourceDiscoveryRegion String
The region the resource discovery is setup in.
isDefault Boolean
Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
operatingRegions List<Property Map>
The regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring
organizationalUnitExclusions List<Property Map>
A set of organizational unit (OU) exclusions for this resource.
ownerId String
Owner Account ID of the Resource Discovery
state String
The state of this Resource Discovery.
tags List<Property Map>
An array of key-value pairs to apply to this resource.

Supporting Types

IpamResourceDiscoveryIpamOperatingRegion

RegionName This property is required. string
The name of the region.
RegionName This property is required. string
The name of the region.
regionName This property is required. String
The name of the region.
regionName This property is required. string
The name of the region.
region_name This property is required. str
The name of the region.
regionName This property is required. String
The name of the region.

IpamResourceDiscoveryOrganizationalUnitExclusion

OrganizationsEntityPath This property is required. string
An AWS Organizations entity path. Build the path for the OU(s) using AWS Organizations IDs separated by a '/'. Include all child OUs by ending the path with '/*'.
OrganizationsEntityPath This property is required. string
An AWS Organizations entity path. Build the path for the OU(s) using AWS Organizations IDs separated by a '/'. Include all child OUs by ending the path with '/*'.
organizationsEntityPath This property is required. String
An AWS Organizations entity path. Build the path for the OU(s) using AWS Organizations IDs separated by a '/'. Include all child OUs by ending the path with '/*'.
organizationsEntityPath This property is required. string
An AWS Organizations entity path. Build the path for the OU(s) using AWS Organizations IDs separated by a '/'. Include all child OUs by ending the path with '/*'.
organizations_entity_path This property is required. str
An AWS Organizations entity path. Build the path for the OU(s) using AWS Organizations IDs separated by a '/'. Include all child OUs by ending the path with '/*'.
organizationsEntityPath This property is required. String
An AWS Organizations entity path. Build the path for the OU(s) using AWS Organizations IDs separated by a '/'. Include all child OUs by ending the path with '/*'.

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native