Oracle Cloud Infrastructure v2.12.0 published on Friday, Oct 11, 2024 by Pulumi
oci.Email.getDkims
Explore with Pulumi AI
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: testEmailDomain.id,
id: dkimId,
name: dkimName,
state: dkimState,
});
import pulumi
import pulumi_oci as oci
test_dkims = oci.Email.get_dkims(email_domain_id=test_email_domain["id"],
id=dkim_id,
name=dkim_name,
state=dkim_state)
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.GetDkims(ctx, &email.GetDkimsArgs{
EmailDomainId: testEmailDomain.Id,
Id: pulumi.StringRef(dkimId),
Name: pulumi.StringRef(dkimName),
State: pulumi.StringRef(dkimState),
}, 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 = testEmailDomain.Id,
Id = dkimId,
Name = dkimName,
State = dkimState,
});
});
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(testEmailDomain.id())
.id(dkimId)
.name(dkimName)
.state(dkimState)
.build());
}
}
variables:
testDkims:
fn::invoke:
Function: oci:Email:getDkims
Arguments:
emailDomainId: ${testEmailDomain.id}
id: ${dkimId}
name: ${dkimName}
state: ${dkimState}
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:
- Email
Domain stringId - The OCID of the email domain to which this DKIM belongs.
- Filters
List<Get
Dkims Filter> - 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 stringId - The OCID of the email domain to which this DKIM belongs.
- Filters
[]Get
Dkims Filter - 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 StringId - The OCID of the email domain to which this DKIM belongs.
- filters
List<Get
Dkims Filter> - 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 stringId - The OCID of the email domain to which this DKIM belongs.
- filters
Get
Dkims Filter[] - 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_ strid - The OCID of the email domain to which this DKIM belongs.
- filters
Sequence[email.
Get Dkims Filter] - 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.
- email
Domain StringId - 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:
- Dkim
Collections List<GetDkims Dkim Collection> - The list of dkim_collection.
- Email
Domain stringId - The OCID of the email domain that this DKIM belongs to.
- Filters
List<Get
Dkims Filter> - 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 []GetDkims Dkim Collection - The list of dkim_collection.
- Email
Domain stringId - The OCID of the email domain that this DKIM belongs to.
- Filters
[]Get
Dkims Filter - 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 List<GetDkims Dkim Collection> - The list of dkim_collection.
- email
Domain StringId - The OCID of the email domain that this DKIM belongs to.
- filters
List<Get
Dkims Filter> - 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 GetDkims Dkim Collection[] - The list of dkim_collection.
- email
Domain stringId - The OCID of the email domain that this DKIM belongs to.
- filters
Get
Dkims Filter[] - 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.Get Dkims Dkim Collection] - The list of dkim_collection.
- email_
domain_ strid - The OCID of the email domain that this DKIM belongs to.
- filters
Sequence[email.
Get Dkims Filter] - 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.
- dkim
Collections List<Property Map> - The list of dkim_collection.
- email
Domain StringId - 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
- Cname
Record stringValue - The DNS CNAME record value to provision to the DKIM DNS subdomain, when using the CNAME method for DKIM setup (preferred).
- Compartment
Id string - The OCID of the compartment that contains this DKIM.
- 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.
- Dns
Subdomain stringName - 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 stringId - The OCID of the email domain to which this DKIM belongs.
- 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
- A filter to only return resources that match the given id exactly.
- Lifecycle
Details 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.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created 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
- Time
Updated 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".
- Txt
Record stringValue - 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 stringValue - The DNS CNAME record value to provision to the DKIM DNS subdomain, when using the CNAME method for DKIM setup (preferred).
- Compartment
Id string - The OCID of the compartment that contains this DKIM.
- 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.
- Dns
Subdomain stringName - 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 stringId - The OCID of the email domain to which this DKIM belongs.
- 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
- A filter to only return resources that match the given id exactly.
- Lifecycle
Details 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.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created 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
- Time
Updated 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".
- Txt
Record stringValue - 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 StringValue - The DNS CNAME record value to provision to the DKIM DNS subdomain, when using the CNAME method for DKIM setup (preferred).
- compartment
Id String - The OCID of the compartment that contains this DKIM.
- 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.
- dns
Subdomain StringName - 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 StringId - The OCID of the email domain to which this DKIM belongs.
- 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
- A filter to only return resources that match the given id exactly.
- lifecycle
Details 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.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created 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
- time
Updated 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".
- txt
Record StringValue - 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 stringValue - The DNS CNAME record value to provision to the DKIM DNS subdomain, when using the CNAME method for DKIM setup (preferred).
- compartment
Id string - The OCID of the compartment that contains this DKIM.
- {[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.
- dns
Subdomain stringName - 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 stringId - The OCID of the email domain to which this DKIM belongs.
- {[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
- A filter to only return resources that match the given id exactly.
- lifecycle
Details 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.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created 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
- time
Updated 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".
- txt
Record stringValue - 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_ strvalue - 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.
- 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.
- dns_
subdomain_ strname - 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_ strid - The OCID of the email domain to which this DKIM belongs.
- 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
- 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.
- 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_ strvalue - 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 StringValue - The DNS CNAME record value to provision to the DKIM DNS subdomain, when using the CNAME method for DKIM setup (preferred).
- compartment
Id String - The OCID of the compartment that contains this DKIM.
- 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.
- dns
Subdomain StringName - 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 StringId - The OCID of the email domain to which this DKIM belongs.
- 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
- A filter to only return resources that match the given id exactly.
- lifecycle
Details 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.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created 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
- time
Updated 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".
- txt
Record StringValue - 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
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.