aws-cdk-lib.aws_ses.DedicatedIpPool

class DedicatedIpPool (construct)

LanguageType name
.NETAmazon.CDK.AWS.SES.DedicatedIpPool
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsses#DedicatedIpPool
Javasoftware.amazon.awscdk.services.ses.DedicatedIpPool
Pythonaws_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');

Initializer

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

Parameters

  • scope Construct
  • id string
  • props DedicatedIpPoolProps

Construct Props

NameTypeDescription
dedicatedIpPoolName?stringA name for the dedicated IP pool.

dedicatedIpPoolName?

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

A name for the dedicated IP pool.

Properties

NameTypeDescription
dedicatedIpPoolNamestringThe name of the dedicated IP pool.
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
stackStackThe 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

NameDescription
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.