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

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.getIpam

Explore with Pulumi AI

aws-native logo

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::IPAM Type

    Using getIpam

    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 getIpam(args: GetIpamArgs, opts?: InvokeOptions): Promise<GetIpamResult>
function getIpamOutput(args: GetIpamOutputArgs, opts?: InvokeOptions): Output<GetIpamResult>
    def get_ipam(ipam_id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetIpamResult
def get_ipam_output(ipam_id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetIpamResult]
    func LookupIpam(ctx *Context, args *LookupIpamArgs, opts ...InvokeOption) (*LookupIpamResult, error)
func LookupIpamOutput(ctx *Context, args *LookupIpamOutputArgs, opts ...InvokeOption) LookupIpamResultOutput

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

    public static class GetIpam 
{
    public static Task<GetIpamResult> InvokeAsync(GetIpamArgs args, InvokeOptions? opts = null)
    public static Output<GetIpamResult> Invoke(GetIpamInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIpamResult> getIpam(GetIpamArgs args, InvokeOptions options)
public static Output<GetIpamResult> getIpam(GetIpamArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:ec2:getIpam
  arguments:
    # arguments dictionary

    The following arguments are supported:

    IpamId string
    Id of the IPAM.
    IpamId string
    Id of the IPAM.
    ipamId String
    Id of the IPAM.
    ipamId string
    Id of the IPAM.
    ipam_id str
    Id of the IPAM.
    ipamId String
    Id of the IPAM.

    getIpam Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the IPAM.
    DefaultResourceDiscoveryAssociationId string
    The Id of the default association to the default resource discovery, created with this IPAM.
    DefaultResourceDiscoveryId string
    The Id of the default resource discovery, created with this IPAM.
    DefaultResourceDiscoveryOrganizationalUnitExclusions List<Pulumi.AwsNative.Ec2.Outputs.IpamOrganizationalUnitExclusion>
    A set of organizational unit (OU) exclusions for the default resource discovery, created with this IPAM.
    Description string
    The description for the IPAM.
    EnablePrivateGua bool
    Enable provisioning of GUA space in private pools.
    IpamId string
    Id of the IPAM.
    OperatingRegions List<Pulumi.AwsNative.Ec2.Outputs.IpamOperatingRegion>
    The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
    PrivateDefaultScopeId string
    The Id of the default scope for publicly routable IP space, created with this IPAM.
    PublicDefaultScopeId string
    The Id of the default scope for publicly routable IP space, created with this IPAM.
    ResourceDiscoveryAssociationCount int
    The count of resource discoveries associated with this IPAM.
    ScopeCount int
    The number of scopes that currently exist in this IPAM.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    Tier Pulumi.AwsNative.Ec2.IpamTier
    The tier of the IPAM.
    Arn string
    The Amazon Resource Name (ARN) of the IPAM.
    DefaultResourceDiscoveryAssociationId string
    The Id of the default association to the default resource discovery, created with this IPAM.
    DefaultResourceDiscoveryId string
    The Id of the default resource discovery, created with this IPAM.
    DefaultResourceDiscoveryOrganizationalUnitExclusions []IpamOrganizationalUnitExclusion
    A set of organizational unit (OU) exclusions for the default resource discovery, created with this IPAM.
    Description string
    The description for the IPAM.
    EnablePrivateGua bool
    Enable provisioning of GUA space in private pools.
    IpamId string
    Id of the IPAM.
    OperatingRegions []IpamOperatingRegion
    The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
    PrivateDefaultScopeId string
    The Id of the default scope for publicly routable IP space, created with this IPAM.
    PublicDefaultScopeId string
    The Id of the default scope for publicly routable IP space, created with this IPAM.
    ResourceDiscoveryAssociationCount int
    The count of resource discoveries associated with this IPAM.
    ScopeCount int
    The number of scopes that currently exist in this IPAM.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    Tier IpamTier
    The tier of the IPAM.
    arn String
    The Amazon Resource Name (ARN) of the IPAM.
    defaultResourceDiscoveryAssociationId String
    The Id of the default association to the default resource discovery, created with this IPAM.
    defaultResourceDiscoveryId String
    The Id of the default resource discovery, created with this IPAM.
    defaultResourceDiscoveryOrganizationalUnitExclusions List<IpamOrganizationalUnitExclusion>
    A set of organizational unit (OU) exclusions for the default resource discovery, created with this IPAM.
    description String
    The description for the IPAM.
    enablePrivateGua Boolean
    Enable provisioning of GUA space in private pools.
    ipamId String
    Id of the IPAM.
    operatingRegions List<IpamOperatingRegion>
    The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
    privateDefaultScopeId String
    The Id of the default scope for publicly routable IP space, created with this IPAM.
    publicDefaultScopeId String
    The Id of the default scope for publicly routable IP space, created with this IPAM.
    resourceDiscoveryAssociationCount Integer
    The count of resource discoveries associated with this IPAM.
    scopeCount Integer
    The number of scopes that currently exist in this IPAM.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    tier IpamTier
    The tier of the IPAM.
    arn string
    The Amazon Resource Name (ARN) of the IPAM.
    defaultResourceDiscoveryAssociationId string
    The Id of the default association to the default resource discovery, created with this IPAM.
    defaultResourceDiscoveryId string
    The Id of the default resource discovery, created with this IPAM.
    defaultResourceDiscoveryOrganizationalUnitExclusions IpamOrganizationalUnitExclusion[]
    A set of organizational unit (OU) exclusions for the default resource discovery, created with this IPAM.
    description string
    The description for the IPAM.
    enablePrivateGua boolean
    Enable provisioning of GUA space in private pools.
    ipamId string
    Id of the IPAM.
    operatingRegions IpamOperatingRegion[]
    The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
    privateDefaultScopeId string
    The Id of the default scope for publicly routable IP space, created with this IPAM.
    publicDefaultScopeId string
    The Id of the default scope for publicly routable IP space, created with this IPAM.
    resourceDiscoveryAssociationCount number
    The count of resource discoveries associated with this IPAM.
    scopeCount number
    The number of scopes that currently exist in this IPAM.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    tier IpamTier
    The tier of the IPAM.
    arn str
    The Amazon Resource Name (ARN) of the IPAM.
    default_resource_discovery_association_id str
    The Id of the default association to the default resource discovery, created with this IPAM.
    default_resource_discovery_id str
    The Id of the default resource discovery, created with this IPAM.
    default_resource_discovery_organizational_unit_exclusions Sequence[IpamOrganizationalUnitExclusion]
    A set of organizational unit (OU) exclusions for the default resource discovery, created with this IPAM.
    description str
    The description for the IPAM.
    enable_private_gua bool
    Enable provisioning of GUA space in private pools.
    ipam_id str
    Id of the IPAM.
    operating_regions Sequence[IpamOperatingRegion]
    The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
    private_default_scope_id str
    The Id of the default scope for publicly routable IP space, created with this IPAM.
    public_default_scope_id str
    The Id of the default scope for publicly routable IP space, created with this IPAM.
    resource_discovery_association_count int
    The count of resource discoveries associated with this IPAM.
    scope_count int
    The number of scopes that currently exist in this IPAM.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    tier IpamTier
    The tier of the IPAM.
    arn String
    The Amazon Resource Name (ARN) of the IPAM.
    defaultResourceDiscoveryAssociationId String
    The Id of the default association to the default resource discovery, created with this IPAM.
    defaultResourceDiscoveryId String
    The Id of the default resource discovery, created with this IPAM.
    defaultResourceDiscoveryOrganizationalUnitExclusions List<Property Map>
    A set of organizational unit (OU) exclusions for the default resource discovery, created with this IPAM.
    description String
    The description for the IPAM.
    enablePrivateGua Boolean
    Enable provisioning of GUA space in private pools.
    ipamId String
    Id of the IPAM.
    operatingRegions List<Property Map>
    The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
    privateDefaultScopeId String
    The Id of the default scope for publicly routable IP space, created with this IPAM.
    publicDefaultScopeId String
    The Id of the default scope for publicly routable IP space, created with this IPAM.
    resourceDiscoveryAssociationCount Number
    The count of resource discoveries associated with this IPAM.
    scopeCount Number
    The number of scopes that currently exist in this IPAM.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    tier "free" | "advanced"
    The tier of the IPAM.

    Supporting Types

    IpamOperatingRegion

    RegionName string
    The name of the region.
    RegionName string
    The name of the region.
    regionName String
    The name of the region.
    regionName string
    The name of the region.
    region_name str
    The name of the region.
    regionName String
    The name of the region.

    IpamOrganizationalUnitExclusion

    OrganizationsEntityPath 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 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 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 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 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 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 '/*'.

    IpamTier

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    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