AWS::SES::DedicatedIpPool - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::SES::DedicatedIpPool

Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Web Services account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, the message is sent from one of the addresses in the associated pool.

Important

You can't delete dedicated IP pools that have a STANDARD scaling mode with one or more dedicated IP addresses. This constraint doesn't apply to dedicated IP pools that have a MANAGED scaling mode.

Syntax

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

JSON

{
  "Type" : "AWS::SES::DedicatedIpPool",
  "Properties" : {
      "PoolName" : String,
      "ScalingMode" : String
    }
}

YAML

Type: AWS::SES::DedicatedIpPool
Properties:
  PoolName: String
  ScalingMode: String

Properties

PoolName

The name of the dedicated IP pool that the IP address is associated with.

Required: No

Type: String

Pattern: ^[a-z0-9_-]{0,64}$

Update requires: Replacement

ScalingMode

The type of scaling mode.

The following options are available:

  • STANDARD - The customer controls which IPs are part of the dedicated IP pool.

  • MANAGED - The reputation and number of IPs are automatically managed by Amazon SES.

The STANDARD option is selected by default if no value is specified.

Note

Updating ScalingMode doesn't require a replacement if you're updating its value from STANDARD to MANAGED. However, updating ScalingMode from MANAGED to STANDARD is not supported.

Required: No

Type: String

Pattern: ^(STANDARD|MANAGED)$

Update requires: Some interruptions

Return values

Ref

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

For more information about using the Ref function, see Ref.