Class: Aws::PinpointEmail::Types::DedicatedIp

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

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ipString

An IP address that is reserved for use by your Amazon Pinpoint account.

Returns:

  • (String)


639
640
641
642
643
644
645
646
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 639

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

#pool_nameString

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

Returns:

  • (String)


639
640
641
642
643
644
645
646
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 639

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

#warmup_percentageInteger

Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.

Returns:

  • (Integer)


639
640
641
642
643
644
645
646
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 639

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

#warmup_statusString

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.

Returns:

  • (String)


639
640
641
642
643
644
645
646
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 639

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