AWS::EC2::IPAM

EC2 IPAM

Resource Schema of AWS::EC2::IPAM Type

Properties

7 configurable properties. Click a row to see details.

Filter:

Property	Type	Flags
`DefaultResourceDiscoveryOrganizationalUnitExclusions`	`Array<IpamOrganizationalUnitExclusion>`
`Description`	`string`
`EnablePrivateGua`	`boolean`
`MeteredAccount`	`string`
`OperatingRegions`	`Array<IpamOperatingRegion>`
`Tags`	`Array<Tag>`
`Tier`	`string`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`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.
`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.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::EC2::IPAM

Resources:
  MyResource:
    Type: AWS::EC2::IPAM
    Properties:
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

ec2:CreateIpamiam:CreateServiceLinkedRoleec2:CreateTagsec2:DescribeIpamsec2:DescribeIpamResourceDiscoveriesec2:ModifyIpamResourceDiscovery

read

ec2:DescribeIpamsec2:DescribeIpamResourceDiscoveries

update

ec2:ModifyIpamec2:CreateTagsec2:DeleteTagsec2:DescribeIpamsec2:DescribeIpamResourceDiscoveriesec2:ModifyIpamResourceDiscovery

delete

ec2:DeleteIpamec2:DeleteTagsec2:DescribeIpams

list

ec2:DescribeIpams

Get the EC2 Cheat Sheet

Everything you need to know about EC2 on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceEC2

Properties15

Required0

TaggingSupported

Primary IDIpamId

Supported Operations

CreateReadUpdateDeleteList

Related Resources

External Links

AWS Documentation