Class: Aws::SESV2::Types::DedicatedIp

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb

Overview

Contains information about a dedicated IP address that is associated with your Amazon SES account.

To learn more about requesting dedicated IP addresses, see Requesting and Relinquishing Dedicated IP Addresses in the Amazon SES Developer Guide.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ip ⇒ String

An IPv4 address.

Returns:

  • (String) 


1509
1510
1511
1512
1513
1514
1515
1516
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 1509

class DedicatedIp < Struct.new(
  :ip,
  :warmup_status,
  :warmup_percentage,
  :pool_name)
  SENSITIVE = []
  include Aws::Structure
end

#pool_name ⇒ String

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

Returns:

  • (String) 


1509
1510
1511
1512
1513
1514
1515
1516
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 1509

class DedicatedIp < Struct.new(
  :ip,
  :warmup_status,
  :warmup_percentage,
  :pool_name)
  SENSITIVE = []
  include Aws::Structure
end

#warmup_percentage ⇒ Integer

Indicates the progress of your dedicated IP warm-up:

  • 0-100 – For standard dedicated IP addresses, this shows the warm-up completion percentage. A value of 100 means the IP address is fully warmed up and ready for use.

  • -1 – Appears for IP addresses in managed dedicated pools where Amazon SES automatically handles the warm-up process, making the percentage not applicable.

Returns:

  • (Integer) 


1509
1510
1511
1512
1513
1514
1515
1516
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 1509

class DedicatedIp < Struct.new(
  :ip,
  :warmup_status,
  :warmup_percentage,
  :pool_name)
  SENSITIVE = []
  include Aws::Structure
end

#warmup_status ⇒ String

The warm-up status of a dedicated IP address. The status can have one of the following values:

  • IN_PROGRESS – The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.

  • DONE – The dedicated IP warm-up process is complete, and the IP address is ready to use.

  • NOT_APPLICABLE – The warm-up status doesn't apply to this IP address. This status is used for IP addresses in managed dedicated IP pools, where Amazon SES automatically handles the warm-up process.

Returns:

  • (String) 


1509
1510
1511
1512
1513
1514
1515
1516
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 1509

class DedicatedIp < Struct.new(
  :ip,
  :warmup_status,
  :warmup_percentage,
  :pool_name)
  SENSITIVE = []
  include Aws::Structure
end