Package software.amazon.awscdk.services.ses

Class CfnDedicatedIpPool

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ses.CfnDedicatedIpPool

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-02T15:58:33.671Z")
@Stability(Stable)
public class CfnDedicatedIpPool
extends CfnResource
implements IInspectable

Create a new pool of dedicated IP addresses.

A pool can include one or more dedicated IP addresses that are associated with your AWS 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.

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ses.*;
 CfnDedicatedIpPool cfnDedicatedIpPool = CfnDedicatedIpPool.Builder.create(this, "MyCfnDedicatedIpPool")
         .poolName("poolName")
         .scalingMode("scalingMode")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-dedicatedippool.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnDedicatedIpPool.Builder	A fluent builder for CfnDedicatedIpPool.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDedicatedIpPool(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDedicatedIpPool(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDedicatedIpPool(software.constructs.Construct scope, String id)
	CfnDedicatedIpPool(software.constructs.Construct scope, String id, CfnDedicatedIpPoolProps props)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
String	getPoolName()	The name of the dedicated IP pool that the IP address is associated with.
String	getScalingMode()	The type of scaling mode.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setPoolName(String value)	The name of the dedicated IP pool that the IP address is associated with.
void	setScalingMode(String value)	The type of scaling mode.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDedicatedIpPool

protected CfnDedicatedIpPool(software.amazon.jsii.JsiiObjectRef objRef)

CfnDedicatedIpPool

protected CfnDedicatedIpPool(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDedicatedIpPool

@Stability(Stable)
public CfnDedicatedIpPool(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnDedicatedIpPoolProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnDedicatedIpPool

@Stability(Stable)
public CfnDedicatedIpPool(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getPoolName

@Stability(Stable)
@Nullable
public String getPoolName()

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

setPoolName

@Stability(Stable)
public void setPoolName(@Nullable
 String value)

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

getScalingMode

@Stability(Stable)
@Nullable
public String getScalingMode()

The type of scaling mode.

setScalingMode

@Stability(Stable)
public void setScalingMode(@Nullable
 String value)

The type of scaling mode.