Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Email
  5. getDkim
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci

oci.Email.getDkim

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci

This data source provides details about a specific Dkim resource in Oracle Cloud Infrastructure Email service.

Retrieves the specified DKIM.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDkim = oci.Email.getDkim({
    dkimId: testDkimOciEmailDkim.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_dkim = oci.Email.get_dkim(dkim_id=test_dkim_oci_email_dkim["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/email"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := email.GetDkim(ctx, &email.GetDkimArgs{
			DkimId: testDkimOciEmailDkim.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testDkim = Oci.Email.GetDkim.Invoke(new()
    {
        DkimId = testDkimOciEmailDkim.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Email.EmailFunctions;
import com.pulumi.oci.Email.inputs.GetDkimArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testDkim = EmailFunctions.getDkim(GetDkimArgs.builder()
            .dkimId(testDkimOciEmailDkim.id())
            .build());

    }
}
Copy
variables:
  testDkim:
    fn::invoke:
      function: oci:Email:getDkim
      arguments:
        dkimId: ${testDkimOciEmailDkim.id}
Copy

Using getDkim

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDkim(args: GetDkimArgs, opts?: InvokeOptions): Promise<GetDkimResult>
function getDkimOutput(args: GetDkimOutputArgs, opts?: InvokeOptions): Output<GetDkimResult>
Copy
def get_dkim(dkim_id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetDkimResult
def get_dkim_output(dkim_id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetDkimResult]
Copy
func GetDkim(ctx *Context, args *GetDkimArgs, opts ...InvokeOption) (*GetDkimResult, error)
func GetDkimOutput(ctx *Context, args *GetDkimOutputArgs, opts ...InvokeOption) GetDkimResultOutput
Copy

> Note: This function is named GetDkim in the Go SDK.

public static class GetDkim 
{
    public static Task<GetDkimResult> InvokeAsync(GetDkimArgs args, InvokeOptions? opts = null)
    public static Output<GetDkimResult> Invoke(GetDkimInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDkimResult> getDkim(GetDkimArgs args, InvokeOptions options)
public static Output<GetDkimResult> getDkim(GetDkimArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Email/getDkim:getDkim
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DkimId This property is required. string
The OCID of this DKIM.
DkimId This property is required. string
The OCID of this DKIM.
dkimId This property is required. String
The OCID of this DKIM.
dkimId This property is required. string
The OCID of this DKIM.
dkim_id This property is required. str
The OCID of this DKIM.
dkimId This property is required. String
The OCID of this DKIM.

getDkim Result

The following output properties are available:

CnameRecordValue string
The DNS CNAME record value to provision to the DKIM DNS subdomain, when using the CNAME method for DKIM setup (preferred).
CompartmentId string
The OCID of the compartment that contains this DKIM.
DefinedTags Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string
The description of the DKIM. Avoid entering confidential information.
DkimId string
DnsSubdomainName 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 string
The OCID of the email domain that this DKIM belongs to.
FreeformTags Dictionary<string, string>
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"}
Id string
The OCID of the DKIM.
IsImported bool
Indicates whether the DKIM was imported.
KeyLength int
Length of the RSA key used in the DKIM.
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource.
Name string
The DKIM selector. If the same domain is managed in more than one region, each region must use different selectors.
PrivateKey string
State string
The current state of the DKIM.
SystemTags Dictionary<string, string>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
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
TimeUpdated string
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".
TxtRecordValue 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.
CnameRecordValue string
The DNS CNAME record value to provision to the DKIM DNS subdomain, when using the CNAME method for DKIM setup (preferred).
CompartmentId string
The OCID of the compartment that contains this DKIM.
DefinedTags map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string
The description of the DKIM. Avoid entering confidential information.
DkimId string
DnsSubdomainName 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 string
The OCID of the email domain that this DKIM belongs to.
FreeformTags map[string]string
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"}
Id string
The OCID of the DKIM.
IsImported bool
Indicates whether the DKIM was imported.
KeyLength int
Length of the RSA key used in the DKIM.
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource.
Name string
The DKIM selector. If the same domain is managed in more than one region, each region must use different selectors.
PrivateKey string
State string
The current state of the DKIM.
SystemTags map[string]string
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
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
TimeUpdated string
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".
TxtRecordValue 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.
cnameRecordValue String
The DNS CNAME record value to provision to the DKIM DNS subdomain, when using the CNAME method for DKIM setup (preferred).
compartmentId String
The OCID of the compartment that contains this DKIM.
definedTags Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String
The description of the DKIM. Avoid entering confidential information.
dkimId String
dnsSubdomainName 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 String
The OCID of the email domain that this DKIM belongs to.
freeformTags Map<String,String>
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"}
id String
The OCID of the DKIM.
isImported Boolean
Indicates whether the DKIM was imported.
keyLength Integer
Length of the RSA key used in the DKIM.
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource.
name String
The DKIM selector. If the same domain is managed in more than one region, each region must use different selectors.
privateKey String
state String
The current state of the DKIM.
systemTags Map<String,String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
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
timeUpdated String
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".
txtRecordValue 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.
cnameRecordValue string
The DNS CNAME record value to provision to the DKIM DNS subdomain, when using the CNAME method for DKIM setup (preferred).
compartmentId string
The OCID of the compartment that contains this DKIM.
definedTags {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description string
The description of the DKIM. Avoid entering confidential information.
dkimId string
dnsSubdomainName 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 string
The OCID of the email domain that this DKIM belongs to.
freeformTags {[key: string]: string}
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"}
id string
The OCID of the DKIM.
isImported boolean
Indicates whether the DKIM was imported.
keyLength number
Length of the RSA key used in the DKIM.
lifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource.
name string
The DKIM selector. If the same domain is managed in more than one region, each region must use different selectors.
privateKey string
state string
The current state of the DKIM.
systemTags {[key: string]: string}
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string
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
timeUpdated string
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".
txtRecordValue 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.
cname_record_value str
The DNS CNAME record value to provision to the DKIM DNS subdomain, when using the CNAME method for DKIM setup (preferred).
compartment_id str
The OCID of the compartment that contains this DKIM.
defined_tags Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description str
The description of the DKIM. Avoid entering confidential information.
dkim_id str
dns_subdomain_name str
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.
email_domain_id str
The OCID of the email domain that this DKIM belongs to.
freeform_tags Mapping[str, str]
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"}
id str
The OCID of the DKIM.
is_imported bool
Indicates whether the DKIM was imported.
key_length int
Length of the RSA key used in the DKIM.
lifecycle_details str
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource.
name str
The DKIM selector. If the same domain is managed in more than one region, each region must use different selectors.
private_key str
state str
The current state of the DKIM.
system_tags Mapping[str, str]
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str
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
time_updated str
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".
txt_record_value str
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.
cnameRecordValue String
The DNS CNAME record value to provision to the DKIM DNS subdomain, when using the CNAME method for DKIM setup (preferred).
compartmentId String
The OCID of the compartment that contains this DKIM.
definedTags Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String
The description of the DKIM. Avoid entering confidential information.
dkimId String
dnsSubdomainName 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 String
The OCID of the email domain that this DKIM belongs to.
freeformTags Map<String>
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"}
id String
The OCID of the DKIM.
isImported Boolean
Indicates whether the DKIM was imported.
keyLength Number
Length of the RSA key used in the DKIM.
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource.
name String
The DKIM selector. If the same domain is managed in more than one region, each region must use different selectors.
privateKey String
state String
The current state of the DKIM.
systemTags Map<String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
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
timeUpdated String
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".
txtRecordValue 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.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci