AWS Native v0.77.0, Sep 20 23

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi

pulumi/pulumi-aws-native

aws-native.ec2.getIpam

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi

pulumi/pulumi-aws-native

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)
// Output-based functions aren't available in Java yet

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.
Description string
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.Ec2.Outputs.IpamTag>: An array of key-value pairs to apply to this resource.

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.
Description string
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 []IpamTag: An array of key-value pairs to apply to this resource.

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.
description String
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<IpamTag>: An array of key-value pairs to apply to this resource.

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.
description string
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 IpamTag[]: An array of key-value pairs to apply to this resource.

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.
description str
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[IpamTag]: An array of key-value pairs to apply to this resource.

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.
description String
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.

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.

IpamTag

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value str: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Package Details

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

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi

pulumi/pulumi-aws-native

aws-native.ec2.getIpam

On this page

On this page

Using getIpam

getIpam Result

Supporting Types

IpamOperatingRegion

IpamTag

Package Details

On this page

On this page