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

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

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

Create Ipam Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Ipam(name: string, args?: IpamArgs, opts?: CustomResourceOptions);
@overload
def Ipam(resource_name: str,
         args: Optional[IpamArgs] = None,
         opts: Optional[ResourceOptions] = None)

@overload
def Ipam(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         default_resource_discovery_organizational_unit_exclusions: Optional[Sequence[IpamOrganizationalUnitExclusionArgs]] = None,
         description: Optional[str] = None,
         enable_private_gua: Optional[bool] = None,
         operating_regions: Optional[Sequence[IpamOperatingRegionArgs]] = None,
         tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
         tier: Optional[IpamTier] = None)
func NewIpam(ctx *Context, name string, args *IpamArgs, opts ...ResourceOption) (*Ipam, error)
public Ipam(string name, IpamArgs? args = null, CustomResourceOptions? opts = null)
public Ipam(String name, IpamArgs args)
public Ipam(String name, IpamArgs args, CustomResourceOptions options)

type: aws-native:ec2:Ipam
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args IpamArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args IpamArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args IpamArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args IpamArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IpamArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Ipam Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Ipam resource accepts the following input properties:

DefaultResourceDiscoveryOrganizationalUnitExclusions List<Pulumi.AwsNative.Ec2.Inputs.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.
OperatingRegions List<Pulumi.AwsNative.Ec2.Inputs.IpamOperatingRegion>
The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
Tags List<Pulumi.AwsNative.Inputs.Tag>
An array of key-value pairs to apply to this resource.
Tier Pulumi.AwsNative.Ec2.IpamTier
The tier of the IPAM.
DefaultResourceDiscoveryOrganizationalUnitExclusions []IpamOrganizationalUnitExclusionArgs
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.
OperatingRegions []IpamOperatingRegionArgs
The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
Tags TagArgs
An array of key-value pairs to apply to this resource.
Tier IpamTier
The tier of the 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.
operatingRegions List<IpamOperatingRegion>
The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
tags List<Tag>
An array of key-value pairs to apply to this resource.
tier IpamTier
The tier of the 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.
operatingRegions IpamOperatingRegion[]
The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
tags Tag[]
An array of key-value pairs to apply to this resource.
tier IpamTier
The tier of the IPAM.
default_resource_discovery_organizational_unit_exclusions Sequence[IpamOrganizationalUnitExclusionArgs]
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.
operating_regions Sequence[IpamOperatingRegionArgs]
The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
tags Sequence[TagArgs]
An array of key-value pairs to apply to this resource.
tier IpamTier
The tier of the 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.
operatingRegions List<Property Map>
The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
tags List<Property Map>
An array of key-value pairs to apply to this resource.
tier "free" | "advanced"
The tier of the IPAM.

Outputs

All input properties are implicitly available as output properties. Additionally, the Ipam resource produces the following output properties:

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.
Id string
The provider-assigned unique ID for this managed resource.
IpamId string
Id of the IPAM.
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.
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.
Id string
The provider-assigned unique ID for this managed resource.
IpamId string
Id of the IPAM.
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.
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.
id String
The provider-assigned unique ID for this managed resource.
ipamId String
Id of the IPAM.
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.
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.
id string
The provider-assigned unique ID for this managed resource.
ipamId string
Id of the IPAM.
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.
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.
id str
The provider-assigned unique ID for this managed resource.
ipam_id str
Id of the IPAM.
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.
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.
id String
The provider-assigned unique ID for this managed resource.
ipamId String
Id of the IPAM.
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.

Supporting Types

IpamOperatingRegion
, IpamOperatingRegionArgs

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.

IpamOrganizationalUnitExclusion
, IpamOrganizationalUnitExclusionArgs

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

IpamTier
, IpamTierArgs

Free
free
Advanced
advanced
IpamTierFree
free
IpamTierAdvanced
advanced
Free
free
Advanced
advanced
Free
free
Advanced
advanced
FREE
free
ADVANCED
advanced
"free"
free
"advanced"
advanced

Tag
, TagArgs

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