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::PinpointEmail::DedicatedIpPool
<a name="aws-resource-pinpointemail-dedicatedippool"></a>

A request to create a new dedicated IP pool.

## Syntax
<a name="aws-resource-pinpointemail-dedicatedippool-syntax"></a>

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

### JSON
<a name="aws-resource-pinpointemail-dedicatedippool-syntax.json"></a>

```
{
  "Type" : "AWS::PinpointEmail::DedicatedIpPool",
  "Properties" : {
      "[PoolName](#cfn-pinpointemail-dedicatedippool-poolname)" : String,
      "[Tags](#cfn-pinpointemail-dedicatedippool-tags)" : [ Tags, ... ]
    }
}
```

### YAML
<a name="aws-resource-pinpointemail-dedicatedippool-syntax.yaml"></a>

```
Type: AWS::PinpointEmail::DedicatedIpPool
Properties:
  [PoolName](#cfn-pinpointemail-dedicatedippool-poolname): String
  [Tags](#cfn-pinpointemail-dedicatedippool-tags): 
    - Tags
```

## Properties
<a name="aws-resource-pinpointemail-dedicatedippool-properties"></a>

`PoolName`  <a name="cfn-pinpointemail-dedicatedippool-poolname"></a>
The name of the dedicated IP pool.  
*Required*: No  
*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-pinpointemail-dedicatedippool-tags"></a>
An object that defines the tags (keys and values) that you want to associate with the dedicated IP pool.  
*Required*: No  
*Type*: [Array](aws-properties-pinpointemail-dedicatedippool-tags.md) of [Tags](aws-properties-pinpointemail-dedicatedippool-tags.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-pinpointemail-dedicatedippool-return-values"></a>

### Ref
<a name="aws-resource-pinpointemail-dedicatedippool-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:

 `{ "Ref": "myDedicatedIpPool" }` 

For the Amazon Pinpoint dedicated IP pool `myDedicatedIpPool`, Ref returns the name of the IP pool.

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-pinpointemail-dedicatedippool-return-values-fn--getatt"></a>

# AWS::PinpointEmail::DedicatedIpPool Tags
<a name="aws-properties-pinpointemail-dedicatedippool-tags"></a>

An object that defines the tags (keys and values) that you want to associate with the dedicated IP pool.

## Syntax
<a name="aws-properties-pinpointemail-dedicatedippool-tags-syntax"></a>

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

### JSON
<a name="aws-properties-pinpointemail-dedicatedippool-tags-syntax.json"></a>

```
{
  "[Key](#cfn-pinpointemail-dedicatedippool-tags-key)" : String,
  "[Value](#cfn-pinpointemail-dedicatedippool-tags-value)" : String
}
```

### YAML
<a name="aws-properties-pinpointemail-dedicatedippool-tags-syntax.yaml"></a>

```
  [Key](#cfn-pinpointemail-dedicatedippool-tags-key): String
  [Value](#cfn-pinpointemail-dedicatedippool-tags-value): String
```

## Properties
<a name="aws-properties-pinpointemail-dedicatedippool-tags-properties"></a>

`Key`  <a name="cfn-pinpointemail-dedicatedippool-tags-key"></a>
One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.  
If you specify tags for the dedicated IP pool, then this value is required.  
*Required*: Conditional  
*Type*: String  
*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-pinpointemail-dedicatedippool-tags-value"></a>
The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.  
*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)