Class: AWSCDK::SES::DedicatedIPPoolProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ses/dedicated_ip_pool_props.rb

Overview

Properties for a dedicated IP pool.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dedicated_ip_pool_name: nil, scaling_mode: nil) ⇒ DedicatedIPPoolProps

Returns a new instance of DedicatedIPPoolProps.

Parameters:

  • dedicated_ip_pool_name (String, nil) (defaults to: nil) —

    A name for the dedicated IP pool.

  • scaling_mode (AWSCDK::SES::ScalingMode, nil) (defaults to: nil) —

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



9
10
11
12
13
14
 
# File 'ses/dedicated_ip_pool_props.rb', line 9

def initialize(dedicated_ip_pool_name: nil, scaling_mode: nil)
  @dedicated_ip_pool_name = dedicated_ip_pool_name
  Jsii::Type.check_type(@dedicated_ip_pool_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dedicatedIpPoolName") unless @dedicated_ip_pool_name.nil?
  @scaling_mode = scaling_mode
  Jsii::Type.check_type(@scaling_mode, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VzLlNjYWxpbmdNb2RlIn0=")), "scalingMode") unless @scaling_mode.nil?
end

Instance Attribute Details

#dedicated_ip_pool_name ⇒ String? (readonly)

Note:

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.

Returns:

  • (String, nil) 


24
25
26
 
# File 'ses/dedicated_ip_pool_props.rb', line 24

def dedicated_ip_pool_name
  @dedicated_ip_pool_name
end

#scaling_mode ⇒ AWSCDK::SES::ScalingMode? (readonly)

Note:

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.

Returns:



32
33
34
 
# File 'ses/dedicated_ip_pool_props.rb', line 32

def scaling_mode
  @scaling_mode
end

Class Method Details

.jsii_properties ⇒ Object 



34
35
36
37
38
39
 
# File 'ses/dedicated_ip_pool_props.rb', line 34

def self.jsii_properties
  {
    :dedicated_ip_pool_name => "dedicatedIpPoolName",
    :scaling_mode => "scalingMode",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



41
42
43
44
45
46
47
48
 
# File 'ses/dedicated_ip_pool_props.rb', line 41

def to_jsii
  result = {}
  result.merge!({
    "dedicatedIpPoolName" => @dedicated_ip_pool_name,
    "scalingMode" => @scaling_mode,
  })
  result.compact
end