Added - Support for BYODKIM

Author: aysingha

examples/email/dkim.tf

@@ -1,3 +1,7 @@
+variable "byodkim_name" {
+  default = "test-selector-2"
+}
+
 variable "dkim_name" {
   default = "test-selector-1"
 }
@@ -6,11 +10,26 @@ variable "dkim_description" {
   default = "Test DKIM"
 }
 
-resource "oci_email_dkim" "testdkim" {
+variable "private_key" {
+  default = "MIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDYOJHqR6O6TofL3eUshL+yDN9sTDSDCmSMe5hapcu1Cj6zjXLbPvEUM+SZd2MrBaAfh5HaiM0U3hQgPX//6zAewT95n5K94qnCo1yKBYpt81lnY5PRcePOE0wuFQ8EqqJNbIPFojYLpoyKazB7ulCiA1y6Zk5ZzUolxNslnRwjWtNidC62ureDbDsE28LVhHron7+s5StR5cMTRUxU1nU3KeOluUS2YwJQzvdAQiDn9PHnG0k7p9+Cam0mlNPgPUKIKmFigx+WBrrI5k1yxyYVjbwTQgl7J7bEz0kZZJLN0Tb1UVfIe+yTDz9iZgMDZ0+spo9FA4UEpQiHsr3Cih6XAgMBAAECggEADtEZlq9gFeVJwvuqt7lFFaNyMA6szooIx+O0Vgnkgrx3/X/k7gdLJ/JCaQ3YWttg1KhKo2oae6KYSHlOazAntQPTILeBq8d7kJ33OnIUwWIar04QlBq03KtP3hyNUemLg7i68vEhuPypxtZ/lQr4eZG3agKWveqmeR4bUmGIyxdO6GaXQMoGo8javYylS02X3uW/jTT4cXWcnslBibQ48CeGS7fuxGHHoZgU0qq3JDlO2KZtOjnmMvwqhAlnCgcd0EX1exsddWXhi2R7ONMRXT/0XG16AVFUumqU5c1E3qNpB+/OR7GO1eIxXsIIN/lBBLblIuETV0naoEeIR0cC4QKBgQD/bEe8cqJlICDDBucNLviTXU2xWHbg4rik1l+NxcN5oRuF0klEklCKPeoiruwFuOxjR4v+E5E6OY/X3lEdVbm7sQpX5rU5Ql9Mkuikniq0gji3aG1fgp1S+rltie1IwIvWWJII5SKrl5zk+K/1F2fiYIeS3xDpBXZAEuYkmDlXcQKBgQDYtZ4v1gGqz2avqSurVgIBKuSy5lQW4RCctGHvaaMMqmE5GipCId/2toIxCm/TTnkw2xy5iLN+TRu1ejQlnXyjbv5rWpg6Ud4ZfS+dspBZKQDndcUxBb8AOEEa3mfNnqtf2fpLNiBHHQUQbQ0n+Mvlk0P9RCIF8cakw8vTUbAihwKBgQDRovB5xehtcWIST68BTgTtBk5G+WGQj+SWPfBtLtySDl3FhuNlqWT7IXfygXjr9WvmzAklPrAahrX9qdUPa5Wma9cecBdbaJNJCOZyffJ09tBQECB8nHo9adUZB3Q+GvJquYUaUd4T0bsO3uGkGlLEJRAAxp5dcoMscZZ8gIfHsQKBgQCwlu6cVGtvYSpwIg5vw9pGUUmjboU/T49V4rebfB1diMlI2sVstmXmiLp2c+bD7cJbyXESzw5U8UiPDVHJBRg3pY60tFIv096ELrrKamOuA/e0pQdW9zO5Xh3PY0R7DbzgkqOe/jA3QrKJvBNoaxjbrrFMhGSlK2uPf+1r+bjpqQKBgQDvSKV73DAKgi0SWreJsBxzJ5qXTj5vcFfu4ySYzoCabfyH6sSokhRUHrzT0V3I+oF0N84IqoDX4CxnNmmu4DvZx30geMSlkFEzY2hPktEcO3nyEgBEFd8PVIp3NqL9u3N8rfQIfy8kudoeZWg3+9sjIFkEiX/HghFf4tt7qcGRwg=="
+}
+
+resource "oci_email_dkim" "testbyodkim" {
 	#Required
 	email_domain_id = oci_email_email_domain.test_email_domain.id
 	#Optional
 	description = var.dkim_description
-	name = var.dkim_name
+	name = var.byodkim_name
+        private_key = var.private_key
   depends_on = [oci_email_email_domain.test_email_domain]
 }
+
+resource "oci_email_dkim" "testdkim" {
+        #Required
+        email_domain_id = oci_email_email_domain.test_email_domain.id
+        #Optional
+        description = var.dkim_description
+        name = var.dkim_name
+  depends_on = [oci_email_email_domain.test_email_domain]
+}
+

internal/integrationtest/email_dkim_test.go

@@ -26,6 +26,9 @@ import (
 )
 
 var (
+	ignoreDkimBaseDefinedTagsChangesRepresentation = map[string]interface{}{
+		"ignore_changes": acctest.Representation{RepType: acctest.Required, Create: []string{`defined_tags`}},
+	}
 	EmailDkimRequiredOnlyResource = EmailDkimResourceDependencies +
 		acctest.GenerateResourceFromRepresentationMap("oci_email_dkim", "test_dkim", acctest.Required, acctest.Create, EmailDkimRepresentation)
 
@@ -53,6 +56,8 @@ var (
 		"description":     acctest.Representation{RepType: acctest.Optional, Create: `description`, Update: `description`},
 		"freeform_tags":   acctest.Representation{RepType: acctest.Optional, Create: map[string]string{"Department": "Finance"}, Update: map[string]string{"Department": "Finance"}},
 		"name":            acctest.Representation{RepType: acctest.Optional, Create: `testselector1`},
+		"private_key":     acctest.Representation{RepType: acctest.Optional, Create: `MIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDYOJHqR6O6TofL3eUshL+yDN9sTDSDCmSMe5hapcu1Cj6zjXLbPvEUM+SZd2MrBaAfh5HaiM0U3hQgPX//6zAewT95n5K94qnCo1yKBYpt81lnY5PRcePOE0wuFQ8EqqJNbIPFojYLpoyKazB7ulCiA1y6Zk5ZzUolxNslnRwjWtNidC62ureDbDsE28LVhHron7+s5StR5cMTRUxU1nU3KeOluUS2YwJQzvdAQiDn9PHnG0k7p9+Cam0mlNPgPUKIKmFigx+WBrrI5k1yxyYVjbwTQgl7J7bEz0kZZJLN0Tb1UVfIe+yTDz9iZgMDZ0+spo9FA4UEpQiHsr3Cih6XAgMBAAECggEADtEZlq9gFeVJwvuqt7lFFaNyMA6szooIx+O0Vgnkgrx3/X/k7gdLJ/JCaQ3YWttg1KhKo2oae6KYSHlOazAntQPTILeBq8d7kJ33OnIUwWIar04QlBq03KtP3hyNUemLg7i68vEhuPypxtZ/lQr4eZG3agKWveqmeR4bUmGIyxdO6GaXQMoGo8javYylS02X3uW/jTT4cXWcnslBibQ48CeGS7fuxGHHoZgU0qq3JDlO2KZtOjnmMvwqhAlnCgcd0EX1exsddWXhi2R7ONMRXT/0XG16AVFUumqU5c1E3qNpB+/OR7GO1eIxXsIIN/lBBLblIuETV0naoEeIR0cC4QKBgQD/bEe8cqJlICDDBucNLviTXU2xWHbg4rik1l+NxcN5oRuF0klEklCKPeoiruwFuOxjR4v+E5E6OY/X3lEdVbm7sQpX5rU5Ql9Mkuikniq0gji3aG1fgp1S+rltie1IwIvWWJII5SKrl5zk+K/1F2fiYIeS3xDpBXZAEuYkmDlXcQKBgQDYtZ4v1gGqz2avqSurVgIBKuSy5lQW4RCctGHvaaMMqmE5GipCId/2toIxCm/TTnkw2xy5iLN+TRu1ejQlnXyjbv5rWpg6Ud4ZfS+dspBZKQDndcUxBb8AOEEa3mfNnqtf2fpLNiBHHQUQbQ0n+Mvlk0P9RCIF8cakw8vTUbAihwKBgQDRovB5xehtcWIST68BTgTtBk5G+WGQj+SWPfBtLtySDl3FhuNlqWT7IXfygXjr9WvmzAklPrAahrX9qdUPa5Wma9cecBdbaJNJCOZyffJ09tBQECB8nHo9adUZB3Q+GvJquYUaUd4T0bsO3uGkGlLEJRAAxp5dcoMscZZ8gIfHsQKBgQCwlu6cVGtvYSpwIg5vw9pGUUmjboU/T49V4rebfB1diMlI2sVstmXmiLp2c+bD7cJbyXESzw5U8UiPDVHJBRg3pY60tFIv096ELrrKamOuA/e0pQdW9zO5Xh3PY0R7DbzgkqOe/jA3QrKJvBNoaxjbrrFMhGSlK2uPf+1r+bjpqQKBgQDvSKV73DAKgi0SWreJsBxzJ5qXTj5vcFfu4ySYzoCabfyH6sSokhRUHrzT0V3I+oF0N84IqoDX4CxnNmmu4DvZx30geMSlkFEzY2hPktEcO3nyEgBEFd8PVIp3NqL9u3N8rfQIfy8kudoeZWg3+9sjIFkEiX/HghFf4tt7qcGRwg==`},
+		"lifecycle":       acctest.RepresentationGroup{RepType: acctest.Required, Group: ignoreDkimBaseDefinedTagsChangesRepresentation},
 	}
 
 	EmailDkimResourceDependencies = acctest.GenerateResourceFromRepresentationMap("oci_email_email_domain", "test_email_domain", acctest.Required, acctest.Create, EmailEmailDomainRepresentation) +
@@ -105,6 +110,7 @@ func TestEmailDkimResource_basic(t *testing.T) {
 				resource.TestCheckResourceAttr(resourceName, "freeform_tags.%", "1"),
 				resource.TestCheckResourceAttrSet(resourceName, "id"),
 				resource.TestCheckResourceAttr(resourceName, "name", "testselector1"),
+				resource.TestCheckResourceAttrSet(resourceName, "private_key"),
 
 				func(s *terraform.State) (err error) {
 					resId, err = acctest.FromInstanceState(s, resourceName, "id")
@@ -128,6 +134,7 @@ func TestEmailDkimResource_basic(t *testing.T) {
 				resource.TestCheckResourceAttr(resourceName, "freeform_tags.%", "1"),
 				resource.TestCheckResourceAttrSet(resourceName, "id"),
 				resource.TestCheckResourceAttr(resourceName, "name", "testselector1"),
+				resource.TestCheckResourceAttrSet(resourceName, "private_key"),
 
 				func(s *terraform.State) (err error) {
 					resId2, err = acctest.FromInstanceState(s, resourceName, "id")
@@ -168,6 +175,8 @@ func TestEmailDkimResource_basic(t *testing.T) {
 				resource.TestCheckResourceAttrSet(singularDatasourceName, "dns_subdomain_name"),
 				resource.TestCheckResourceAttr(singularDatasourceName, "freeform_tags.%", "1"),
 				resource.TestCheckResourceAttrSet(singularDatasourceName, "id"),
+				resource.TestCheckResourceAttrSet(singularDatasourceName, "is_imported"),
+				resource.TestCheckResourceAttrSet(singularDatasourceName, "key_length"),
 				resource.TestCheckResourceAttr(singularDatasourceName, "name", "testselector1"),
 				resource.TestCheckResourceAttrSet(singularDatasourceName, "state"),
 				resource.TestCheckResourceAttrSet(singularDatasourceName, "time_created"),
@@ -177,11 +186,13 @@ func TestEmailDkimResource_basic(t *testing.T) {
 		},
 		// verify resource import
 		{
-			Config:                  config + EmailDkimRequiredOnlyResource,
-			ImportState:             true,
-			ImportStateVerify:       true,
-			ImportStateVerifyIgnore: []string{},
-			ResourceName:            resourceName,
+			Config:            config + EmailDkimRequiredOnlyResource,
+			ImportState:       true,
+			ImportStateVerify: true,
+			ImportStateVerifyIgnore: []string{
+				"private_key",
+			},
+			ResourceName: resourceName,
 		},
 	})
 }

internal/service/email/email_dkim_data_source.go

@@ -92,6 +92,14 @@ func (s *EmailDkimDataSourceCrud) SetData() error {
 
 	s.D.Set("freeform_tags", s.Res.FreeformTags)
 
+	if s.Res.IsImported != nil {
+		s.D.Set("is_imported", *s.Res.IsImported)
+	}
+
+	if s.Res.KeyLength != nil {
+		s.D.Set("key_length", *s.Res.KeyLength)
+	}
+
 	if s.Res.LifecycleDetails != nil {
 		s.D.Set("lifecycle_details", *s.Res.LifecycleDetails)
 	}

internal/service/email/email_dkim_resource.go

@@ -63,6 +63,13 @@ func EmailDkimResource() *schema.Resource {
 				Computed: true,
 				ForceNew: true,
 			},
+			"private_key": {
+				Type:      schema.TypeString,
+				Optional:  true,
+				Computed:  true,
+				ForceNew:  true,
+				Sensitive: true,
+			},
 
 			// Computed
 			"cname_record_value": {
@@ -77,6 +84,14 @@ func EmailDkimResource() *schema.Resource {
 				Type:     schema.TypeString,
 				Computed: true,
 			},
+			"is_imported": {
+				Type:     schema.TypeBool,
+				Computed: true,
+			},
+			"key_length": {
+				Type:     schema.TypeInt,
+				Computed: true,
+			},
 			"lifecycle_details": {
 				Type:     schema.TypeString,
 				Computed: true,
@@ -205,6 +220,11 @@ func (s *EmailDkimResourceCrud) Create() error {
 		request.Name = &tmp
 	}
 
+	if privateKey, ok := s.D.GetOkExists("private_key"); ok {
+		tmp := privateKey.(string)
+		request.PrivateKey = &tmp
+	}
+
 	request.RequestMetadata.RetryPolicy = tfresource.GetRetryPolicy(s.DisableNotFoundRetries, "email")
 
 	response, err := s.Client.CreateDkim(context.Background(), request)
@@ -436,6 +456,14 @@ func (s *EmailDkimResourceCrud) SetData() error {
 
 	s.D.Set("freeform_tags", s.Res.FreeformTags)
 
+	if s.Res.IsImported != nil {
+		s.D.Set("is_imported", *s.Res.IsImported)
+	}
+
+	if s.Res.KeyLength != nil {
+		s.D.Set("key_length", *s.Res.KeyLength)
+	}
+
 	if s.Res.LifecycleDetails != nil {
 		s.D.Set("lifecycle_details", *s.Res.LifecycleDetails)
 	}
@@ -490,6 +518,14 @@ func DkimSummaryToMap(obj oci_email.DkimSummary) map[string]interface{} {
 		result["id"] = string(*obj.Id)
 	}
 
+	if obj.IsImported != nil {
+		result["is_imported"] = bool(*obj.IsImported)
+	}
+
+	if obj.KeyLength != nil {
+		result["key_length"] = int(*obj.KeyLength)
+	}
+
 	if obj.Name != nil {
 		result["name"] = string(*obj.Name)
 	}

website/docs/d/email_dkim.html.markdown

@@ -40,6 +40,8 @@ The following attributes are exported:
 * `email_domain_id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the email domain that this DKIM belongs to. 
 * `freeform_tags` - 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).  Example: `{"Department": "Finance"}` 
 * `id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DKIM. 
+* `is_imported` - Indicates whether the DKIM was imported.
+* `key_length` - Length of the RSA key used in the DKIM.
 * `lifecycle_details` - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource. 
 * `name` - The DKIM selector. If the same domain is managed in more than one region, each region must use different selectors. 
 * `state` - The current state of the DKIM.

website/docs/d/email_dkims.html.markdown

@@ -54,6 +54,8 @@ The following attributes are exported:
 * `email_domain_id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the email domain that this DKIM belongs to. 
 * `freeform_tags` - 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).  Example: `{"Department": "Finance"}` 
 * `id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DKIM. 
+* `is_imported` - Indicates whether the DKIM was imported.
+* `key_length` - Length of the RSA key used in the DKIM.
 * `lifecycle_details` - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource. 
 * `name` - The DKIM selector. If the same domain is managed in more than one region, each region must use different selectors. 
 * `state` - The current state of the DKIM.

website/docs/d/email_email_return_paths.html.markdown

@@ -21,7 +21,7 @@ data "oci_email_email_return_paths" "test_email_return_paths" {
 	compartment_id = var.compartment_id
 	id = var.email_return_path_id
 	name = var.email_return_path_name
-	parent_resource_id = oci_usage_proxy_resource.test_resource.id
+	parent_resource_id = oci_cloud_guard_resource.test_resource.id
 	state = var.email_return_path_state
 }
 ```

website/docs/guides/resource_discovery.html.markdown

@@ -745,6 +745,7 @@ email
 * oci\_email\_sender
 * oci\_email\_email\_domain
 * oci\_email\_dkim
+* oci\_email\_email\_return\_path
 
 events
 

website/docs/r/email_dkim.html.markdown

@@ -29,6 +29,7 @@ resource "oci_email_dkim" "test_dkim" {
 	description = var.dkim_description
 	freeform_tags = {"Department"= "Finance"}
 	name = var.dkim_name
+	private_key = var.dkim_private_key
 }
 ```
 
@@ -44,8 +45,8 @@ The following arguments are supported:
 
 	Avoid entering confidential information.
 
-	Example: `mydomain-phx-20210228`
-
+	Example: `mydomain-phx-20210228` 
+* `private_key` - (Optional) The DKIM RSA Private Key in Privacy-Enhanced Mail (PEM) format. It is a text-based representation of the private key used for signing email messages.
 
 ** IMPORTANT **
 Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
@@ -58,11 +59,13 @@ The following attributes are exported:
 * `compartment_id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains this DKIM.
 * `defined_tags` - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).  Example: `{"Operations.CostCenter": "42"}`
 * `description` - The description of the DKIM. Avoid entering confidential information.
-* `dns_subdomain_name` - 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` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the email domain that this DKIM belongs to.
-* `freeform_tags` - 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).  Example: `{"Department": "Finance"}`
-* `id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DKIM.
-* `lifecycle_details` - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource.
+* `dns_subdomain_name` - 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` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the email domain that this DKIM belongs to. 
+* `freeform_tags` - 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).  Example: `{"Department": "Finance"}` 
+* `id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DKIM. 
+* `is_imported` - Indicates whether the DKIM was imported.
+* `key_length` - Length of the RSA key used in the DKIM.
+* `lifecycle_details` - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource. 
 * `name` - The DKIM selector. If the same domain is managed in more than one region, each region must use different selectors.
 * `state` - The current state of the DKIM.
 * `system_tags` - Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}`

website/docs/r/email_email_domain.html.markdown

@@ -33,7 +33,7 @@ resource "oci_email_email_domain" "test_email_domain" {
 The following arguments are supported:
 
 * `compartment_id` - (Required) (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for this email domain.
-* `defined_tags` - (Optional) (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).  Example: `{"Operations.CostCenter": "42"}` 
+* `defined_tags` - (Optional) (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).  Example: `{"Operations.CostCenter": "42"}`
 * `description` - (Optional) (Updatable) A string that describes the details about the domain. It does not have to be unique, and you can change it. Avoid entering confidential information.
 * `domain_verification_id` - (Optional) (Updatable) Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
 * `freeform_tags` - (Optional) (Updatable) 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).  Example: `{"Department": "Finance"}`