Dkim¶
- class oci.email.models.Dkim(**kwargs)¶
Bases:
objectThe properties that define a DKIM.
Attributes:
A constant which can be used with the lifecycle_state property of a Dkim.
A constant which can be used with the lifecycle_state property of a Dkim.
A constant which can be used with the lifecycle_state property of a Dkim.
A constant which can be used with the lifecycle_state property of a Dkim.
A constant which can be used with the lifecycle_state property of a Dkim.
A constant which can be used with the lifecycle_state property of a Dkim.
A constant which can be used with the lifecycle_state property of a Dkim.
A constant which can be used with the lifecycle_state property of a Dkim.
Gets the cname_record_value of this Dkim.
Gets the compartment_id of this Dkim.
Gets the defined_tags of this Dkim.
Gets the description of this Dkim.
Gets the dns_subdomain_name of this Dkim.
[Required] Gets the email_domain_id of this Dkim.
Gets the freeform_tags of this Dkim.
[Required] Gets the id of this Dkim.
Gets the is_imported of this Dkim.
Gets the key_length of this Dkim.
Gets the lifecycle_details of this Dkim.
Gets the lifecycle_state of this Dkim.
[Required] Gets the name of this Dkim.
Gets the system_tags of this Dkim.
Gets the time_created of this Dkim.
Gets the time_updated of this Dkim.
Gets the txt_record_value of this Dkim.
Methods:
__init__(**kwargs)Initializes a new Dkim object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a Dkim. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a Dkim. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a Dkim. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a Dkim. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a Dkim. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a Dkim. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶
A constant which can be used with the lifecycle_state property of a Dkim. This constant has a value of “NEEDS_ATTENTION”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a Dkim. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new Dkim 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 Dkim.
id (str) – The value to assign to the id property of this Dkim.
email_domain_id (str) – The value to assign to the email_domain_id property of this Dkim.
compartment_id (str) – The value to assign to the compartment_id property of this Dkim.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Dkim. Allowed values for this property are: “ACTIVE”, “CREATING”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE”, “NEEDS_ATTENTION”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this Dkim.
description (str) – The value to assign to the description property of this Dkim.
time_created (datetime) – The value to assign to the time_created property of this Dkim.
time_updated (datetime) – The value to assign to the time_updated property of this Dkim.
dns_subdomain_name (str) – The value to assign to the dns_subdomain_name property of this Dkim.
cname_record_value (str) – The value to assign to the cname_record_value property of this Dkim.
txt_record_value (str) – The value to assign to the txt_record_value property of this Dkim.
is_imported (bool) – The value to assign to the is_imported property of this Dkim.
key_length (int) – The value to assign to the key_length property of this Dkim.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Dkim.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Dkim.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Dkim.
- property cname_record_value¶
Gets the cname_record_value of this Dkim. The DNS CNAME record value to provision to the DKIM DNS subdomain, when using the CNAME method for DKIM setup (preferred).
- Returns
The cname_record_value of this Dkim.
- Return type
str
- property compartment_id¶
Gets the compartment_id of this Dkim. The OCID of the compartment that contains this DKIM.
- Returns
The compartment_id of this Dkim.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this Dkim. 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 Dkim.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this Dkim. The description of the DKIM. Avoid entering confidential information.
- Returns
The description of this Dkim.
- Return type
str
- property dns_subdomain_name¶
Gets the dns_subdomain_name of this Dkim. The name of the DNS subdomain that must be provisioned to enable email recipients to verify DKIM signatures. It is usually created with a CNAME record set to the cnameRecordValue.
- Returns
The dns_subdomain_name of this Dkim.
- Return type
str
- property email_domain_id¶
[Required] Gets the email_domain_id of this Dkim. The OCID of the email domain that this DKIM belongs to.
- Returns
The email_domain_id of this Dkim.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this Dkim. 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 Dkim.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this Dkim. The OCID of the DKIM.
- Returns
The id of this Dkim.
- Return type
str
- property is_imported¶
Gets the is_imported of this Dkim. Indicates whether the DKIM was imported.
- Returns
The is_imported of this Dkim.
- Return type
bool
- property key_length¶
Gets the key_length of this Dkim. Length of the RSA key used in the DKIM.
- Returns
The key_length of this Dkim.
- Return type
int
- property lifecycle_details¶
Gets the lifecycle_details of this Dkim. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource.
- Returns
The lifecycle_details of this Dkim.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this Dkim. The current state of the DKIM.
Allowed values for this property are: “ACTIVE”, “CREATING”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE”, “NEEDS_ATTENTION”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this Dkim.
- Return type
str
- property name¶
[Required] Gets the name of this Dkim. The DKIM selector. If the same domain is managed in more than one region, each region must use different selectors.
- Returns
The name of this Dkim.
- Return type
str
- property system_tags¶
Gets the system_tags of this Dkim. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this Dkim.
- Return type
dict(str, dict(str, object))
- property time_created¶
Gets the time_created of this Dkim. The time the DKIM was created. Times are expressed in RFC 3339 timestamp format, “YYYY-MM-ddThh:mmZ”.
Example: 2021-02-12T22:47:12.613Z
- Returns
The time_created of this Dkim.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this Dkim. The time of the last change to the DKIM configuration, due to a state change or an update operation. Times are expressed in RFC 3339 timestamp format, “YYYY-MM-ddThh:mmZ”.
- Returns
The time_updated of this Dkim.
- Return type
datetime
- property txt_record_value¶
Gets the txt_record_value of this Dkim. The DNS TXT record value to provision to the DKIM DNS subdomain in place of using a CNAME record. This is used in cases where a CNAME cannot be used, such as when the cnameRecordValue would exceed the maximum length for a DNS entry. You can also use this if you have an existing procedure to directly provision TXT records for DKIM. Many DNS APIs require you to break this string into segments of fewer than 255 characters.
- Returns
The txt_record_value of this Dkim.
- Return type
str