AWS::EC2::IPAMScope

EC2 IPAMScope

Resource Schema of AWS::EC2::IPAMScope Type

Properties

4 configurable properties. 1 required. Click a row to see details.

Filter:

Property	Type	Flags
`IpamId`	`string`	RequiredCreate-only
`Description`	`string`
`ExternalAuthorityConfiguration`	`IpamScopeExternalAuthorityConfiguration`
`Tags`	`Array<Tag>`

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 scope.
`IpamArn`	`string`	The Amazon Resource Name (ARN) of the IPAM this scope is a part of.
`IpamScopeId`	`string`	Id of the IPAM scope.
`IpamScopeType`	`string`	Determines whether this scope contains publicly routable space or space for a private network
`IsDefault`	`boolean`	Is this one of the default scopes created with the IPAM.
`PoolCount`	`integer`	The number of pools that currently exist in this scope.

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::IPAMScope

Resources:
  MyResource:
    Type: AWS::EC2::IPAMScope
    Properties:
      IpamId: "my-ipamid"
      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:CreateIpamScopeec2:DescribeIpamScopesec2:CreateTags

read

ec2:DescribeIpamScopes

update

ec2:ModifyIpamScopeec2:DescribeIpamScopesec2:CreateTagsec2:DeleteTags

delete

ec2:DeleteIpamScopeec2:DescribeIpamScopesec2:DeleteTags

list

ec2:DescribeIpamScopes

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

Properties10

Required1

TaggingSupported

Primary IDIpamScopeId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

IpamId

Related Resources

External Links

AWS Documentation