Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Dkim

The properties that define a DKIM.

Enumerations

Properties

Functions

Properties

Optional cnameRecordValue

cnameRecordValue: undefined | string

The DNS CNAME record value to provision to the DKIM DNS subdomain, when using the CNAME method for DKIM setup (preferred).

Optional compartmentId

compartmentId: undefined | string

The OCID of the compartment that contains this DKIM.

Optional definedTags

definedTags: undefined | object

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

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional description

description: undefined | string

The description of the DKIM. Avoid entering confidential information.

Optional dnsSubdomainName

dnsSubdomainName: undefined | string

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.

emailDomainId

emailDomainId: string

The OCID of the email domain that this DKIM belongs to.

Optional freeformTags

freeformTags: undefined | object

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: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the DKIM.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource.

Optional lifecycleState

lifecycleState: LifecycleState

The current state of the DKIM.

name

name: string

The DKIM selector. If the same domain is managed in more than one region, each region must use different selectors.

Optional systemTags

systemTags: undefined | object

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

Optional timeCreated

timeCreated: Date

The time the DKIM was created. Times are expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ".

Example: {@code 2021-02-12T22:47:12.613Z}

Optional timeUpdated

timeUpdated: Date

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".

Optional txtRecordValue

txtRecordValue: undefined | string

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.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Dkim): object

getJsonObj

  • getJsonObj(obj: Dkim): object