Package software.amazon.awscdk.services.ses

Class CfnDedicatedIpPool

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.ses.CfnDedicatedIpPool
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:41.371Z") @Stability(Stable) public class CfnDedicatedIpPool extends CfnResource implements IInspectable
A CloudFormation 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 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();

  • 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 Construct scope, @NotNull String id, @Nullable CfnDedicatedIpPoolProps props)
      Create a new AWS::SES::DedicatedIpPool.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnDedicatedIpPool

      @Stability(Stable) public CfnDedicatedIpPool(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::SES::DedicatedIpPool.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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.

      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.

      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.

    • setScalingMode

      @Stability(Stable) public void setScalingMode(@Nullable String value)
      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.

      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.