1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Email
  5. getDkims
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

oci.Email.getDkims

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

    This data source provides the list of Dkims in Oracle Cloud Infrastructure Email service.

    Lists DKIMs for an email domain.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testDkims = oci.Email.getDkims({
        emailDomainId: oci_email_email_domain.test_email_domain.id,
        id: _var.dkim_id,
        name: _var.dkim_name,
        state: _var.dkim_state,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_dkims = oci.Email.get_dkims(email_domain_id=oci_email_email_domain["test_email_domain"]["id"],
        id=var["dkim_id"],
        name=var["dkim_name"],
        state=var["dkim_state"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Email"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Email.GetDkims(ctx, &email.GetDkimsArgs{
    			EmailDomainId: oci_email_email_domain.Test_email_domain.Id,
    			Id:            pulumi.StringRef(_var.Dkim_id),
    			Name:          pulumi.StringRef(_var.Dkim_name),
    			State:         pulumi.StringRef(_var.Dkim_state),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testDkims = Oci.Email.GetDkims.Invoke(new()
        {
            EmailDomainId = oci_email_email_domain.Test_email_domain.Id,
            Id = @var.Dkim_id,
            Name = @var.Dkim_name,
            State = @var.Dkim_state,
        });
    
    });
    
    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.GetDkimsArgs;
    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 testDkims = EmailFunctions.getDkims(GetDkimsArgs.builder()
                .emailDomainId(oci_email_email_domain.test_email_domain().id())
                .id(var_.dkim_id())
                .name(var_.dkim_name())
                .state(var_.dkim_state())
                .build());
    
        }
    }
    
    variables:
      testDkims:
        fn::invoke:
          Function: oci:Email:getDkims
          Arguments:
            emailDomainId: ${oci_email_email_domain.test_email_domain.id}
            id: ${var.dkim_id}
            name: ${var.dkim_name}
            state: ${var.dkim_state}
    

    Using getDkims

    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 getDkims(args: GetDkimsArgs, opts?: InvokeOptions): Promise<GetDkimsResult>
    function getDkimsOutput(args: GetDkimsOutputArgs, opts?: InvokeOptions): Output<GetDkimsResult>
    def get_dkims(email_domain_id: Optional[str] = None,
                  filters: Optional[Sequence[_email.GetDkimsFilter]] = None,
                  id: Optional[str] = None,
                  name: Optional[str] = None,
                  state: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetDkimsResult
    def get_dkims_output(email_domain_id: Optional[pulumi.Input[str]] = None,
                  filters: Optional[pulumi.Input[Sequence[pulumi.Input[_email.GetDkimsFilterArgs]]]] = None,
                  id: Optional[pulumi.Input[str]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  state: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetDkimsResult]
    func GetDkims(ctx *Context, args *GetDkimsArgs, opts ...InvokeOption) (*GetDkimsResult, error)
    func GetDkimsOutput(ctx *Context, args *GetDkimsOutputArgs, opts ...InvokeOption) GetDkimsResultOutput

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

    public static class GetDkims 
    {
        public static Task<GetDkimsResult> InvokeAsync(GetDkimsArgs args, InvokeOptions? opts = null)
        public static Output<GetDkimsResult> Invoke(GetDkimsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDkimsResult> getDkims(GetDkimsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Email/getDkims:getDkims
      arguments:
        # arguments dictionary

    The following arguments are supported:

    EmailDomainId string
    The OCID of the email domain to which this DKIM belongs.
    Filters List<GetDkimsFilter>
    Id string
    A filter to only return resources that match the given id exactly.
    Name string
    A filter to only return resources that match the given name exactly.
    State string
    Filter returned list by specified lifecycle state. This parameter is case-insensitive.
    EmailDomainId string
    The OCID of the email domain to which this DKIM belongs.
    Filters []GetDkimsFilter
    Id string
    A filter to only return resources that match the given id exactly.
    Name string
    A filter to only return resources that match the given name exactly.
    State string
    Filter returned list by specified lifecycle state. This parameter is case-insensitive.
    emailDomainId String
    The OCID of the email domain to which this DKIM belongs.
    filters List<GetDkimsFilter>
    id String
    A filter to only return resources that match the given id exactly.
    name String
    A filter to only return resources that match the given name exactly.
    state String
    Filter returned list by specified lifecycle state. This parameter is case-insensitive.
    emailDomainId string
    The OCID of the email domain to which this DKIM belongs.
    filters GetDkimsFilter[]
    id string
    A filter to only return resources that match the given id exactly.
    name string
    A filter to only return resources that match the given name exactly.
    state string
    Filter returned list by specified lifecycle state. This parameter is case-insensitive.
    email_domain_id str
    The OCID of the email domain to which this DKIM belongs.
    filters Sequence[email.GetDkimsFilter]
    id str
    A filter to only return resources that match the given id exactly.
    name str
    A filter to only return resources that match the given name exactly.
    state str
    Filter returned list by specified lifecycle state. This parameter is case-insensitive.
    emailDomainId String
    The OCID of the email domain to which this DKIM belongs.
    filters List<Property Map>
    id String
    A filter to only return resources that match the given id exactly.
    name String
    A filter to only return resources that match the given name exactly.
    state String
    Filter returned list by specified lifecycle state. This parameter is case-insensitive.

    getDkims Result

    The following output properties are available:

    DkimCollections List<GetDkimsDkimCollection>
    The list of dkim_collection.
    EmailDomainId string
    The OCID of the email domain that this DKIM belongs to.
    Filters List<GetDkimsFilter>
    Id string
    The OCID of the DKIM.
    Name string
    The DKIM selector. If the same domain is managed in more than one region, each region must use different selectors.
    State string
    The current state of the DKIM.
    DkimCollections []GetDkimsDkimCollection
    The list of dkim_collection.
    EmailDomainId string
    The OCID of the email domain that this DKIM belongs to.
    Filters []GetDkimsFilter
    Id string
    The OCID of the DKIM.
    Name string
    The DKIM selector. If the same domain is managed in more than one region, each region must use different selectors.
    State string
    The current state of the DKIM.
    dkimCollections List<GetDkimsDkimCollection>
    The list of dkim_collection.
    emailDomainId String
    The OCID of the email domain that this DKIM belongs to.
    filters List<GetDkimsFilter>
    id String
    The OCID of the DKIM.
    name String
    The DKIM selector. If the same domain is managed in more than one region, each region must use different selectors.
    state String
    The current state of the DKIM.
    dkimCollections GetDkimsDkimCollection[]
    The list of dkim_collection.
    emailDomainId string
    The OCID of the email domain that this DKIM belongs to.
    filters GetDkimsFilter[]
    id string
    The OCID of the DKIM.
    name string
    The DKIM selector. If the same domain is managed in more than one region, each region must use different selectors.
    state string
    The current state of the DKIM.
    dkim_collections Sequence[email.GetDkimsDkimCollection]
    The list of dkim_collection.
    email_domain_id str
    The OCID of the email domain that this DKIM belongs to.
    filters Sequence[email.GetDkimsFilter]
    id str
    The OCID of the DKIM.
    name str
    The DKIM selector. If the same domain is managed in more than one region, each region must use different selectors.
    state str
    The current state of the DKIM.
    dkimCollections List<Property Map>
    The list of dkim_collection.
    emailDomainId String
    The OCID of the email domain that this DKIM belongs to.
    filters List<Property Map>
    id String
    The OCID of the DKIM.
    name String
    The DKIM selector. If the same domain is managed in more than one region, each region must use different selectors.
    state String
    The current state of the DKIM.

    Supporting Types

    GetDkimsDkimCollection

    GetDkimsDkimCollectionItem

    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, object>
    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.
    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 to which this DKIM belongs.
    FreeformTags Dictionary<string, 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: {"Department": "Finance"}
    Id string
    A filter to only return resources that match the given id exactly.
    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
    A filter to only return resources that match the given name exactly.
    State string
    Filter returned list by specified lifecycle state. This parameter is case-insensitive.
    SystemTags Dictionary<string, object>
    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]interface{}
    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.
    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 to which this DKIM belongs.
    FreeformTags map[string]interface{}
    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
    A filter to only return resources that match the given id exactly.
    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
    A filter to only return resources that match the given name exactly.
    State string
    Filter returned list by specified lifecycle state. This parameter is case-insensitive.
    SystemTags map[string]interface{}
    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,Object>
    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.
    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 to which this DKIM belongs.
    freeformTags Map<String,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: {"Department": "Finance"}
    id String
    A filter to only return resources that match the given id exactly.
    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
    A filter to only return resources that match the given name exactly.
    state String
    Filter returned list by specified lifecycle state. This parameter is case-insensitive.
    systemTags Map<String,Object>
    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]: any}
    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.
    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 to which this DKIM belongs.
    freeformTags {[key: string]: any}
    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
    A filter to only return resources that match the given id exactly.
    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
    A filter to only return resources that match the given name exactly.
    state string
    Filter returned list by specified lifecycle state. This parameter is case-insensitive.
    systemTags {[key: string]: any}
    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, Any]
    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.
    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 to which this DKIM belongs.
    freeform_tags Mapping[str, Any]
    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
    A filter to only return resources that match the given id exactly.
    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
    A filter to only return resources that match the given name exactly.
    state str
    Filter returned list by specified lifecycle state. This parameter is case-insensitive.
    system_tags Mapping[str, Any]
    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<Any>
    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.
    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 to which this DKIM belongs.
    freeformTags Map<Any>
    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
    A filter to only return resources that match the given id exactly.
    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
    A filter to only return resources that match the given name exactly.
    state String
    Filter returned list by specified lifecycle state. This parameter is case-insensitive.
    systemTags Map<Any>
    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.

    GetDkimsFilter

    Name string
    A filter to only return resources that match the given name exactly.
    Values List<string>
    Regex bool
    Name string
    A filter to only return resources that match the given name exactly.
    Values []string
    Regex bool
    name String
    A filter to only return resources that match the given name exactly.
    values List<String>
    regex Boolean
    name string
    A filter to only return resources that match the given name exactly.
    values string[]
    regex boolean
    name str
    A filter to only return resources that match the given name exactly.
    values Sequence[str]
    regex bool
    name String
    A filter to only return resources that match the given name exactly.
    values List<String>
    regex Boolean

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi