Class: AWSCDK::SES::CfnDedicatedIPPoolProps

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

Overview

Properties for defining a CfnDedicatedIpPool.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(pool_name: nil, scaling_mode: nil, tags: nil) ⇒ CfnDedicatedIPPoolProps

Returns a new instance of CfnDedicatedIPPoolProps.

Parameters:

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

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

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

    The type of scaling mode.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    An object that defines the tags (keys and values) that you want to associate with the pool.



12
13
14
15
16
17
18
19
 
# File 'ses/cfn_dedicated_ip_pool_props.rb', line 12

def initialize(pool_name: nil, scaling_mode: nil, tags: nil)
  @pool_name = pool_name
  Jsii::Type.check_type(@pool_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "poolName") unless @pool_name.nil?
  @scaling_mode = scaling_mode
  Jsii::Type.check_type(@scaling_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scalingMode") unless @scaling_mode.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#pool_name ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



25
26
27
 
# File 'ses/cfn_dedicated_ip_pool_props.rb', line 25

def pool_name
  @pool_name
end

#scaling_mode ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



39
40
41
 
# File 'ses/cfn_dedicated_ip_pool_props.rb', line 39

def scaling_mode
  @scaling_mode
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

An object that defines the tags (keys and values) that you want to associate with the pool.

Returns:

See Also:



44
45
46
 
# File 'ses/cfn_dedicated_ip_pool_props.rb', line 44

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



46
47
48
49
50
51
52
 
# File 'ses/cfn_dedicated_ip_pool_props.rb', line 46

def self.jsii_properties
  {
    :pool_name => "poolName",
    :scaling_mode => "scalingMode",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



54
55
56
57
58
59
60
61
62
 
# File 'ses/cfn_dedicated_ip_pool_props.rb', line 54

def to_jsii
  result = {}
  result.merge!({
    "poolName" => @pool_name,
    "scalingMode" => @scaling_mode,
    "tags" => @tags,
  })
  result.compact
end