CreateEmailIpPoolDetails

class oci.email.models.CreateEmailIpPoolDetails(**kwargs)

Bases: object

The configuration details required to create a new IpPool which will be used to route emails.

Methods:

__init__(**kwargs)

Initializes a new CreateEmailIpPoolDetails object with values from keyword arguments.

Attributes:

compartment_id

[Required] Gets the compartment_id of this CreateEmailIpPoolDetails.

defined_tags

Gets the defined_tags of this CreateEmailIpPoolDetails.

description

Gets the description of this CreateEmailIpPoolDetails.

freeform_tags

Gets the freeform_tags of this CreateEmailIpPoolDetails.

last_ip_drain_period_in_hours

Gets the last_ip_drain_period_in_hours of this CreateEmailIpPoolDetails.

name

[Required] Gets the name of this CreateEmailIpPoolDetails.

outbound_ips

[Required] Gets the outbound_ips of this CreateEmailIpPoolDetails.

__init__(**kwargs)

Initializes a new CreateEmailIpPoolDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • name (str) – The value to assign to the name property of this CreateEmailIpPoolDetails.

  • compartment_id (str) – The value to assign to the compartment_id property of this CreateEmailIpPoolDetails.

  • description (str) – The value to assign to the description property of this CreateEmailIpPoolDetails.

  • outbound_ips (list[str]) – The value to assign to the outbound_ips property of this CreateEmailIpPoolDetails.

  • last_ip_drain_period_in_hours (int) – The value to assign to the last_ip_drain_period_in_hours property of this CreateEmailIpPoolDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateEmailIpPoolDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateEmailIpPoolDetails.

property compartment_id

[Required] Gets the compartment_id of this CreateEmailIpPoolDetails. The OCID of the compartment for this IpPool.

Returns

The compartment_id of this CreateEmailIpPoolDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateEmailIpPoolDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this CreateEmailIpPoolDetails.

Return type

dict(str, dict(str, object))

property description

Gets the description of this CreateEmailIpPoolDetails. The description of the IpPool. Avoid entering confidential information.

Returns

The description of this CreateEmailIpPoolDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateEmailIpPoolDetails. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns

The freeform_tags of this CreateEmailIpPoolDetails.

Return type

dict(str, str)

property last_ip_drain_period_in_hours

Gets the last_ip_drain_period_in_hours of this CreateEmailIpPoolDetails. Last IP will be unassigned from the IP Pool after the period of time (in hours) specified by this parameter. Default is 24 hours.

Returns

The last_ip_drain_period_in_hours of this CreateEmailIpPoolDetails.

Return type

int

property name

[Required] Gets the name of this CreateEmailIpPoolDetails. The name of the IpPool. The name must be unique within a region. The name is case sensitive and supported characters include alphanumeric, hyphens (“-“) and underscore (“_”) characters.

Example: green_pool-1

Returns

The name of this CreateEmailIpPoolDetails.

Return type

str

property outbound_ips

[Required] Gets the outbound_ips of this CreateEmailIpPoolDetails. A list of outbound public IPs for assignment to the IpPool. These IPs must be in the AVAILABLE state to be eligible for assignment.

Returns

The outbound_ips of this CreateEmailIpPoolDetails.

Return type

list[str]