AWS Native

v0.29.0 published on Thursday, Sep 8, 2022 by Pulumi

getIPAM

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)
// 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.

Description string
IpamId string

Id of the IPAM.

OperatingRegions List<Pulumi.AwsNative.EC2.Outputs.IPAMIpamOperatingRegion>

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.

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.

Description string
IpamId string

Id of the IPAM.

OperatingRegions []IPAMIpamOperatingRegion

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.

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.

description String
ipamId String

Id of the IPAM.

operatingRegions List<IPAMIpamOperatingRegion>

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.

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.

description string
ipamId string

Id of the IPAM.

operatingRegions IPAMIpamOperatingRegion[]

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.

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.

description str
ipam_id str

Id of the IPAM.

operating_regions Sequence[IPAMIpamOperatingRegion]

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.

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.

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.

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

IPAMIpamOperatingRegion

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
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0