This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::EC2::IPAMScope
<a name="aws-resource-ec2-ipamscope"></a>

In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

For more information, see [How IPAM works](https://docs.aws.amazon.com//vpc/latest/ipam/how-it-works-ipam.html) in the *Amazon VPC IPAM User Guide*.

## Syntax
<a name="aws-resource-ec2-ipamscope-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-ec2-ipamscope-syntax.json"></a>

```
{
  "Type" : "AWS::EC2::IPAMScope",
  "Properties" : {
      "[Description](#cfn-ec2-ipamscope-description)" : String,
      "[ExternalAuthorityConfiguration](#cfn-ec2-ipamscope-externalauthorityconfiguration)" : IpamScopeExternalAuthorityConfiguration,
      "[IpamId](#cfn-ec2-ipamscope-ipamid)" : String,
      "[Tags](#cfn-ec2-ipamscope-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-ec2-ipamscope-syntax.yaml"></a>

```
Type: AWS::EC2::IPAMScope
Properties:
  [Description](#cfn-ec2-ipamscope-description): String
  [ExternalAuthorityConfiguration](#cfn-ec2-ipamscope-externalauthorityconfiguration): 
    IpamScopeExternalAuthorityConfiguration
  [IpamId](#cfn-ec2-ipamscope-ipamid): String
  [Tags](#cfn-ec2-ipamscope-tags): 
    - Tag
```

## Properties
<a name="aws-resource-ec2-ipamscope-properties"></a>

`Description`  <a name="cfn-ec2-ipamscope-description"></a>
The description of the scope.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExternalAuthorityConfiguration`  <a name="cfn-ec2-ipamscope-externalauthorityconfiguration"></a>
The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.  
For more information, see [Integrate VPC IPAM with Infoblox infrastructure](https://docs.aws.amazon.com/vpc/latest/ipam/integrate-infoblox-ipam.html) in the *Amazon VPC IPAM User Guide*.  
*Required*: No  
*Type*: [IpamScopeExternalAuthorityConfiguration](aws-properties-ec2-ipamscope-ipamscopeexternalauthorityconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IpamId`  <a name="cfn-ec2-ipamscope-ipamid"></a>
The ID of the IPAM for which you're creating this scope.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-ec2-ipamscope-tags"></a>
The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-ec2-ipamscope-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-ec2-ipamscope-return-values"></a>

### Ref
<a name="aws-resource-ec2-ipamscope-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the IPAM scope ID.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-ec2-ipamscope-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-ec2-ipamscope-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The ARN of the scope.

`IpamArn`  <a name="IpamArn-fn::getatt"></a>
The ARN of an IPAM.

`IpamScopeId`  <a name="IpamScopeId-fn::getatt"></a>
The ID of an IPAM scope.

`IpamScopeType`  <a name="IpamScopeType-fn::getatt"></a>
The type of the scope.

`IsDefault`  <a name="IsDefault-fn::getatt"></a>
Defines if the scope is the default scope or not.

`PoolCount`  <a name="PoolCount-fn::getatt"></a>
The number of pools in a scope.

# AWS::EC2::IPAMScope IpamScopeExternalAuthorityConfiguration
<a name="aws-properties-ec2-ipamscope-ipamscopeexternalauthorityconfiguration"></a>

The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.

In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to AWS while using Amazon VPC IPAM to manage subnets within those ranges.

## Syntax
<a name="aws-properties-ec2-ipamscope-ipamscopeexternalauthorityconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-ec2-ipamscope-ipamscopeexternalauthorityconfiguration-syntax.json"></a>

```
{
  "[ExternalResourceIdentifier](#cfn-ec2-ipamscope-ipamscopeexternalauthorityconfiguration-externalresourceidentifier)" : String,
  "[IpamScopeExternalAuthorityType](#cfn-ec2-ipamscope-ipamscopeexternalauthorityconfiguration-ipamscopeexternalauthoritytype)" : String
}
```

### YAML
<a name="aws-properties-ec2-ipamscope-ipamscopeexternalauthorityconfiguration-syntax.yaml"></a>

```
  [ExternalResourceIdentifier](#cfn-ec2-ipamscope-ipamscopeexternalauthorityconfiguration-externalresourceidentifier): String
  [IpamScopeExternalAuthorityType](#cfn-ec2-ipamscope-ipamscopeexternalauthorityconfiguration-ipamscopeexternalauthoritytype): String
```

## Properties
<a name="aws-properties-ec2-ipamscope-ipamscopeexternalauthorityconfiguration-properties"></a>

`ExternalResourceIdentifier`  <a name="cfn-ec2-ipamscope-ipamscopeexternalauthorityconfiguration-externalresourceidentifier"></a>
The identifier for the external resource managing this scope. For Infoblox integrations, this is the Infoblox resource identifier in the format `<version>.identity.account.<entity_realm>.<entity_id>`.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IpamScopeExternalAuthorityType`  <a name="cfn-ec2-ipamscope-ipamscopeexternalauthorityconfiguration-ipamscopeexternalauthoritytype"></a>
The type of external authority managing this scope. Currently supports `Infoblox` for integration with Infoblox Universal DDI.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `infoblox`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EC2::IPAMScope Tag
<a name="aws-properties-ec2-ipamscope-tag"></a>

Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).

## Syntax
<a name="aws-properties-ec2-ipamscope-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-ec2-ipamscope-tag-syntax.json"></a>

```
{
  "[Key](#cfn-ec2-ipamscope-tag-key)" : String,
  "[Value](#cfn-ec2-ipamscope-tag-value)" : String
}
```

### YAML
<a name="aws-properties-ec2-ipamscope-tag-syntax.yaml"></a>

```
  [Key](#cfn-ec2-ipamscope-tag-key): String
  [Value](#cfn-ec2-ipamscope-tag-value): String
```

## Properties
<a name="aws-properties-ec2-ipamscope-tag-properties"></a>

`Key`  <a name="cfn-ec2-ipamscope-tag-key"></a>
The tag key.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-ec2-ipamscope-tag-value"></a>
The tag value.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Examples
<a name="aws-properties-ec2-ipamscope-tag--examples"></a>

### 
<a name="aws-properties-ec2-ipamscope-tag--examples--"></a>

This example specifies two tags for the IPAM scope.

#### JSON
<a name="aws-properties-ec2-ipamscope-tag--examples----json"></a>

```
"Tags" : [
   {
      "Key" : "key1",
      "Value" : "value1"
   },
   {
      "Key" : "key2",
      "Value" : "value2"
   }
]
```

#### YAML
<a name="aws-properties-ec2-ipamscope-tag--examples----yaml"></a>

```
Tags: 
  - Key: "key1"
    Value: "value1"
  - Key: "key2"
    Value: "value2"
```