Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

awscc.ec2.ipam

CloudFormation Type: AWS::EC2::IPAM

Resource Schema of AWS::EC2::IPAM Type

Example

awscc.ec2.ipam {
  description = "Example IPAM"
  tier        = free

  operating_region {
    region_name = "ap-northeast-1"
  }

  tags = {
    Environment = "example"
  }
}

Argument Reference

default_resource_discovery_organizational_unit_exclusions

A set of organizational unit (OU) exclusions for the default resource discovery, created with this IPAM.

description

  • Type: String
  • Required: No

enable_private_gua

  • Type: Bool
  • Required: No

Enable provisioning of GUA space in private pools.

metered_account

A metered account is an account that is charged for active IP addresses managed in IPAM

operating_regions

The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring

tags

  • Type: Map
  • Required: No

An array of key-value pairs to apply to this resource.

tier

The tier of the IPAM.

Enum Values

metered_account (MeteredAccount)

ValueDSL Identifier
ipam-ownerawscc.ec2.ipam.MeteredAccount.ipam_owner
resource-ownerawscc.ec2.ipam.MeteredAccount.resource_owner

Shorthand formats: ipam_owner or MeteredAccount.ipam_owner

tier (Tier)

ValueDSL Identifier
freeawscc.ec2.ipam.Tier.free
advancedawscc.ec2.ipam.Tier.advanced

Shorthand formats: free or Tier.free

Struct Definitions

IpamOperatingRegion

FieldTypeRequiredDescription
region_nameRegionYesThe name of the region.

IpamOrganizationalUnitExclusion

FieldTypeRequiredDescription
organizations_entity_pathString(len: 1..)YesAn 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 ‘/*’.

Attribute Reference

arn

  • Type: Arn

default_resource_discovery_association_id

  • Type: String

default_resource_discovery_id

  • Type: String

ipam_id

  • Type: IpamId

private_default_scope_id

  • Type: String

public_default_scope_id

  • Type: String(len: ..=255)

resource_discovery_association_count

  • Type: Int

scope_count

  • Type: Int