class DedicatedIpPool (construct)

Language	Type name
.NET	Amazon.CDK.AWS.SES.DedicatedIpPool
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsses#DedicatedIpPool
Java	software.amazon.awscdk.services.ses.DedicatedIpPool
Python	aws_cdk.aws_ses.DedicatedIpPool
TypeScript (source)	aws-cdk-lib » aws_ses » DedicatedIpPool

Implements IConstruct, IDependable, IResource, IDedicatedIpPool

A dedicated IP pool.

Example

new ses.DedicatedIpPool(this, 'Pool', {
  dedicatedIpPoolName: 'mypool',
  scalingMode: ses.ScalingMode.STANDARD,
});

Initializer

new DedicatedIpPool(scope: Construct, id: string, props?: DedicatedIpPoolProps)

Parameters

• scope Construct
• id string
• props DedicatedIpPoolProps

Construct Props

Name	Type	Description
dedicatedIpPoolName?	string	A name for the dedicated IP pool.
scalingMode?	ScalingMode	The type of scailing mode to use for this IP pool.

---

dedicatedIpPoolName?

Type: string (optional, default: a CloudFormation generated name)

A name for the dedicated IP pool.

The name must adhere to specific constraints: it can only include lowercase letters (a-z), numbers (0-9), underscores (_), and hyphens (-), and must not exceed 64 characters in length.

---

scalingMode?

Type: ScalingMode (optional, default: ScalingMode.STANDARD)

The type of scailing mode to use for this IP pool.

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.

Properties

Name	Type	Description
dedicatedIpPoolName	string	The name of the dedicated IP pool.
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.

---

dedicatedIpPoolName

Type: string

The name of the dedicated IP pool.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.
static fromDedicatedIpPoolName(scope, id, dedicatedIpPoolName)	Use an existing dedicated IP pool.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromDedicatedIpPoolName(scope, id, dedicatedIpPoolName)

public static fromDedicatedIpPoolName(scope: Construct, id: string, dedicatedIpPoolName: string): IDedicatedIpPool

Parameters

• scope Construct
• id string
• dedicatedIpPoolName string

Returns

• IDedicatedIpPool

Use an existing dedicated IP pool.