We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.0.1 published on Tuesday, Oct 1, 2024 by Pulumi
aws-native.ec2.getIpam
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.0.1 published on Tuesday, Oct 1, 2024 by Pulumi
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:
- Ipam
Id string - Id of the IPAM.
- Ipam
Id string - Id of the IPAM.
- ipam
Id String - Id of the IPAM.
- ipam
Id string - Id of the IPAM.
- ipam_
id str - Id of the IPAM.
- ipam
Id String - Id of the IPAM.
getIpam Result
The following output properties are available:
- Arn string
- The Amazon Resource Name (ARN) of the IPAM.
- Default
Resource stringDiscovery Association Id - The Id of the default association to the default resource discovery, created with this IPAM.
- Default
Resource stringDiscovery Id - The Id of the default resource discovery, created with this IPAM.
- Description string
- The description for the IPAM.
- Enable
Private boolGua - Enable provisioning of GUA space in private pools.
- Ipam
Id string - Id of the IPAM.
- Operating
Regions List<Pulumi.Aws Native. Ec2. Outputs. Ipam Operating Region> - The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
- Private
Default stringScope Id - The Id of the default scope for publicly routable IP space, created with this IPAM.
- Public
Default stringScope Id - The Id of the default scope for publicly routable IP space, created with this IPAM.
- Resource
Discovery intAssociation Count - The count of resource discoveries associated with this IPAM.
- Scope
Count int - The number of scopes that currently exist in this IPAM.
- List<Pulumi.
Aws Native. Outputs. Tag> - An array of key-value pairs to apply to this resource.
- Tier
Pulumi.
Aws Native. Ec2. Ipam Tier - The tier of the IPAM.
- Arn string
- The Amazon Resource Name (ARN) of the IPAM.
- Default
Resource stringDiscovery Association Id - The Id of the default association to the default resource discovery, created with this IPAM.
- Default
Resource stringDiscovery Id - The Id of the default resource discovery, created with this IPAM.
- Description string
- The description for the IPAM.
- Enable
Private boolGua - Enable provisioning of GUA space in private pools.
- Ipam
Id string - Id of the IPAM.
- Operating
Regions []IpamOperating Region - The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
- Private
Default stringScope Id - The Id of the default scope for publicly routable IP space, created with this IPAM.
- Public
Default stringScope Id - The Id of the default scope for publicly routable IP space, created with this IPAM.
- Resource
Discovery intAssociation Count - The count of resource discoveries associated with this IPAM.
- Scope
Count int - The number of scopes that currently exist in this IPAM.
- Tag
- An array of key-value pairs to apply to this resource.
- Tier
Ipam
Tier - The tier of the IPAM.
- arn String
- The Amazon Resource Name (ARN) of the IPAM.
- default
Resource StringDiscovery Association Id - The Id of the default association to the default resource discovery, created with this IPAM.
- default
Resource StringDiscovery Id - The Id of the default resource discovery, created with this IPAM.
- description String
- The description for the IPAM.
- enable
Private BooleanGua - Enable provisioning of GUA space in private pools.
- ipam
Id String - Id of the IPAM.
- operating
Regions List<IpamOperating Region> - The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
- private
Default StringScope Id - The Id of the default scope for publicly routable IP space, created with this IPAM.
- public
Default StringScope Id - The Id of the default scope for publicly routable IP space, created with this IPAM.
- resource
Discovery IntegerAssociation Count - The count of resource discoveries associated with this IPAM.
- scope
Count Integer - The number of scopes that currently exist in this IPAM.
- List<Tag>
- An array of key-value pairs to apply to this resource.
- tier
Ipam
Tier - The tier of the IPAM.
- arn string
- The Amazon Resource Name (ARN) of the IPAM.
- default
Resource stringDiscovery Association Id - The Id of the default association to the default resource discovery, created with this IPAM.
- default
Resource stringDiscovery Id - The Id of the default resource discovery, created with this IPAM.
- description string
- The description for the IPAM.
- enable
Private booleanGua - Enable provisioning of GUA space in private pools.
- ipam
Id string - Id of the IPAM.
- operating
Regions IpamOperating Region[] - The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
- private
Default stringScope Id - The Id of the default scope for publicly routable IP space, created with this IPAM.
- public
Default stringScope Id - The Id of the default scope for publicly routable IP space, created with this IPAM.
- resource
Discovery numberAssociation Count - The count of resource discoveries associated with this IPAM.
- scope
Count number - The number of scopes that currently exist in this IPAM.
- Tag[]
- An array of key-value pairs to apply to this resource.
- tier
Ipam
Tier - The tier of the IPAM.
- arn str
- The Amazon Resource Name (ARN) of the IPAM.
- default_
resource_ strdiscovery_ association_ id - The Id of the default association to the default resource discovery, created with this IPAM.
- default_
resource_ strdiscovery_ id - The Id of the default resource discovery, created with this IPAM.
- description str
- The description for the IPAM.
- enable_
private_ boolgua - Enable provisioning of GUA space in private pools.
- ipam_
id str - Id of the IPAM.
- operating_
regions Sequence[IpamOperating Region] - The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
- private_
default_ strscope_ id - The Id of the default scope for publicly routable IP space, created with this IPAM.
- public_
default_ strscope_ id - The Id of the default scope for publicly routable IP space, created with this IPAM.
- resource_
discovery_ intassociation_ count - The count of resource discoveries associated with this IPAM.
- scope_
count int - The number of scopes that currently exist in this IPAM.
- Sequence[root_Tag]
- An array of key-value pairs to apply to this resource.
- tier
Ipam
Tier - The tier of the IPAM.
- arn String
- The Amazon Resource Name (ARN) of the IPAM.
- default
Resource StringDiscovery Association Id - The Id of the default association to the default resource discovery, created with this IPAM.
- default
Resource StringDiscovery Id - The Id of the default resource discovery, created with this IPAM.
- description String
- The description for the IPAM.
- enable
Private BooleanGua - Enable provisioning of GUA space in private pools.
- ipam
Id String - Id of the IPAM.
- operating
Regions List<Property Map> - The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
- private
Default StringScope Id - The Id of the default scope for publicly routable IP space, created with this IPAM.
- public
Default StringScope Id - The Id of the default scope for publicly routable IP space, created with this IPAM.
- resource
Discovery NumberAssociation Count - The count of resource discoveries associated with this IPAM.
- scope
Count Number - The number of scopes that currently exist in this IPAM.
- 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
- Region
Name string - The name of the region.
- Region
Name string - The name of the region.
- region
Name String - The name of the region.
- region
Name string - The name of the region.
- region_
name str - The name of the region.
- region
Name String - The name of the region.
IpamTier
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.0.1 published on Tuesday, Oct 1, 2024 by Pulumi