feat: Add contributorInsights field to Table resource

Author: michaelhtm

Diff for: apis/v1alpha1/ack-generate-metadata.yaml

@@ -1,13 +1,13 @@
 ack_generate_info:
-  build_date: "2025-03-28T01:43:12Z"
+  build_date: "2025-04-01T00:50:24Z"
   build_hash: 980cb1e4734f673d16101cf55206b84ca639ec01
   go_version: go1.24.1
   version: v0.44.0
-api_directory_checksum: cb49386ebd7bb50e2521072a76262c72b9dbd285
+api_directory_checksum: 2f94829f12ad90f9c36c48823459c161c1670093
 api_version: v1alpha1
 aws_sdk_go_version: v1.32.6
 generator_config_info:
-  file_checksum: 4533fa8aca3b134b5895ad6ce9a093c3446d99da
+  file_checksum: e7e79c3c7c21273967ca24947fda0f26b344c8f0
   original_file_name: generator.yaml
 last_modification:
   reason: API generation

Diff for: apis/v1alpha1/generator.yaml

@@ -70,6 +70,10 @@ resources:
           service_name: kms
           resource: Key
           path: Status.ACKResourceMetadata.ARN
+      ContributorInsights:
+        from:
+          operation: UpdateContributorInsights
+          path: ContributorInsightsAction
     exceptions:
       errors:
         404:
@@ -86,6 +90,8 @@ resources:
         template_path: hooks/table/sdk_create_post_set_output.go.tpl
       sdk_read_one_post_set_output:
         template_path: hooks/table/sdk_read_one_post_set_output.go.tpl
+      sdk_update_pre_build_request:
+        template_path: hooks/table/sdk_update_pre_build_request.go.tpl
       sdk_delete_pre_build_request:
         template_path: hooks/table/sdk_delete_pre_build_request.go.tpl
     synced:

Diff for: apis/v1alpha1/table.go

@@ -88,6 +88,9 @@ spec:
                   pointInTimeRecoveryEnabled:
                     type: boolean
                 type: object
+              contributorInsights:
+                description: Represents the contributor insights action.
+                type: string
               deletionProtectionEnabled:
                 description: |-
                   Indicates whether deletion protection is to be enabled (true) or disabled

Diff for: apis/v1alpha1/zz_generated.deepcopy.go

@@ -70,6 +70,10 @@ resources:
           service_name: kms
           resource: Key
           path: Status.ACKResourceMetadata.ARN
+      ContributorInsights:
+        from:
+          operation: UpdateContributorInsights
+          path: ContributorInsightsAction
     exceptions:
       errors:
         404:
@@ -86,6 +90,8 @@ resources:
         template_path: hooks/table/sdk_create_post_set_output.go.tpl
       sdk_read_one_post_set_output:
         template_path: hooks/table/sdk_read_one_post_set_output.go.tpl
+      sdk_update_pre_build_request:
+        template_path: hooks/table/sdk_update_pre_build_request.go.tpl
       sdk_delete_pre_build_request:
         template_path: hooks/table/sdk_delete_pre_build_request.go.tpl
     synced:

Diff for: config/crd/bases/dynamodb.services.k8s.aws_tables.yaml

@@ -88,6 +88,9 @@ spec:
                   pointInTimeRecoveryEnabled:
                     type: boolean
                 type: object
+              contributorInsights:
+                description: Represents the contributor insights action.
+                type: string
               deletionProtectionEnabled:
                 description: |-
                   Indicates whether deletion protection is to be enabled (true) or disabled

Diff for: generator.yaml

@@ -31,6 +31,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 
 	"github.com/aws-controllers-k8s/dynamodb-controller/apis/v1alpha1"
+	svcapitypes "github.com/aws-controllers-k8s/dynamodb-controller/apis/v1alpha1"
 )
 
 var (
@@ -133,7 +134,9 @@ func isTableUpdating(r *resource) bool {
 		return false
 	}
 	dbis := *r.ko.Status.TableStatus
-	return dbis == string(v1alpha1.TableStatus_SDK_UPDATING)
+	return dbis == string(v1alpha1.TableStatus_SDK_UPDATING) ||
+		*r.ko.Spec.ContributorInsights == string(svcsdktypes.ContributorInsightsStatusEnabling) ||
+		*r.ko.Spec.ContributorInsights == string(svcsdktypes.ContributorInsightsStatusDisabling)
 }
 
 func (rm *resourceManager) customUpdateTable(
@@ -212,6 +215,13 @@ func (rm *resourceManager) customUpdateTable(
 		}
 	}
 
+	if delta.DifferentAt("Spec.ContributorInsights") {
+		err = rm.updateContributorInsights(ctx, desired)
+		if err != nil {
+			return &resource{ko}, err
+		}
+	}
+
 	// We want to update fast fields first
 	// Then attributes
 	// then GSI
@@ -590,6 +600,10 @@ func customPreCompare(
 	if a.ko.Spec.DeletionProtectionEnabled == nil {
 		a.ko.Spec.DeletionProtectionEnabled = aws.Bool(false)
 	}
+
+	if a.ko.Spec.ContributorInsights == nil && *b.ko.Spec.ContributorInsights == string(svcsdktypes.ContributorInsightsStatusDisabled) {
+		a.ko.Spec.ContributorInsights = aws.String(string(svcsdktypes.ContributorInsightsStatusDisabled))
+	}
 }
 
 // equalAttributeDefinitions return whether two AttributeDefinition arrays are equal or not.
@@ -724,3 +738,71 @@ func equalLocalSecondaryIndexes(
 	}
 	return true
 }
+
+// setContributorInsights retrieves the table's cloudformationInsights
+// configuration
+func (rm *resourceManager) setContributorInsights(
+	ctx context.Context,
+	r *resource,
+	ko *svcapitypes.Table,
+) (err error) {
+	rlog := ackrtlog.FromContext(ctx)
+	exit := rlog.Trace("rm.setCloudformationInsights")
+	defer func() {
+		exit(err)
+	}()
+
+	resp, err := rm.sdkapi.DescribeContributorInsights(
+		ctx,
+		&svcsdk.DescribeContributorInsightsInput{
+			TableName: r.ko.Spec.TableName,
+		},
+	)
+	rm.metrics.RecordAPICall("READ_ONE", "DescribeContributorInsights", err)
+	if err != nil {
+		return err
+	}
+
+	switch resp.ContributorInsightsStatus {
+	case svcsdktypes.ContributorInsightsStatusEnabled:
+		ko.Spec.ContributorInsights = aws.String(string(svcsdktypes.ContributorInsightsActionEnable))
+	case svcsdktypes.ContributorInsightsStatusDisabled:
+		ko.Spec.ContributorInsights = aws.String(string(svcsdktypes.ContributorInsightsActionDisable))
+	default:
+		ko.Spec.ContributorInsights = aws.String(string(resp.ContributorInsightsStatus))
+
+	}
+
+	return nil
+}
+
+func (rm *resourceManager) updateContributorInsights(
+	ctx context.Context,
+	r *resource,
+) (err error) {
+	rlog := ackrtlog.FromContext(ctx)
+	exit := rlog.Trace("rm.updateCloudformationInsights")
+	defer func() {
+		exit(err)
+	}()
+	var insight svcsdktypes.ContributorInsightsAction
+	if r.ko.Spec.ContributorInsights != nil {
+		insight = svcsdktypes.ContributorInsightsAction(*r.ko.Spec.ContributorInsights)
+	} else {
+		insight = svcsdktypes.ContributorInsightsActionDisable
+	}
+
+	_, err = rm.sdkapi.UpdateContributorInsights(
+		ctx,
+		&svcsdk.UpdateContributorInsightsInput{
+			TableName:                 r.ko.Spec.TableName,
+			ContributorInsightsAction: insight,
+		},
+	)
+	rm.metrics.RecordAPICall("READ_ONE", "UpdateContributorInsights", err)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

Diff for: helm/crds/dynamodb.services.k8s.aws_tables.yaml

@@ -2,4 +2,8 @@
 		if err := rm.syncTTL(ctx, desired, &resource{ko}); err != nil {
 			return nil, err
 		}
+	}
+
+	if desired.ko.Spec.ContributorInsights != nil {
+		ackcondition.SetSynced(&resource{ko}, corev1.ConditionFalse, nil, nil)
 	}

Diff for: pkg/resource/table/delta.go

@@ -1,3 +1,8 @@
+	err = rm.setContributorInsights(ctx, r, ko)
+	if err != nil {
+		return &resource{ko}, err
+	}
+	
 	if resp.Table.GlobalSecondaryIndexes != nil {
 		f := []*svcapitypes.GlobalSecondaryIndexDescription{}
 		for _, fIter := range resp.Table.GlobalSecondaryIndexes {

Diff for: pkg/resource/table/hooks.go

@@ -0,0 +1,20 @@
+# Table used to test multiple interfering updates at once
+apiVersion: dynamodb.services.k8s.aws/v1alpha1
+kind: Table
+metadata:
+  name: $TABLE_NAME
+spec:
+  tableName: $TABLE_NAME
+  billingMode: PAY_PER_REQUEST
+  tableClass: STANDARD
+  contributorInsights: ENABLE
+  attributeDefinitions:
+    - attributeName: Bill
+      attributeType: S
+    - attributeName: Total
+      attributeType: S
+  keySchema:
+    - attributeName: Bill
+      keyType: HASH
+    - attributeName: Total
+      keyType: RANGE

Diff for: pkg/resource/table/sdk.go

@@ -236,6 +236,18 @@ def get(table_name):
     except c.exceptions.ResourceNotFoundException:
         return None
 
+def get_insights(table_name):
+    """Returns a dict containing the Role record from the IAM API.
+
+    If no such Table exists, returns None.
+    """
+    c = boto3.client('dynamodb', region_name=get_region())
+    try:
+        resp = c.describe_contributor_insights(TableName=table_name)
+        return resp['ContributorInsightsStatus']
+    except c.exceptions.ResourceNotFoundException:
+        return None
+
 
 def get_time_to_live(table_name):
     """Returns the TTL specification for the table with a supplied name.

Diff for: templates/hooks/table/sdk_create_post_set_output.go.tpl

@@ -136,6 +136,18 @@ def table_basic():
     except:
         pass
 
+@pytest.fixture(scope="function")
+def table_insights():
+    resource_name = random_suffix_name("table-insights", 32)
+    (ref, cr) = create_table(resource_name, "table_insights")
+
+    yield ref, cr
+    try:
+        _, deleted = k8s.delete_custom_resource(ref, wait_periods=3, period_length=10)
+        assert deleted
+    except:
+        pass
+
 @pytest.fixture(scope="module")
 def table_basic_pay_per_request():
     resource_name = random_suffix_name("table-basic-pay-per-request", 32)
@@ -153,6 +165,9 @@ def table_basic_pay_per_request():
 class TestTable:
     def table_exists(self, table_name: str) -> bool:
         return table.get(table_name) is not None
+    
+    def table_insight_status(self, table_name: str, status: str) -> bool:
+        return table.get(table_name) is not None
 
     def test_create_delete(self, table_lsi):
         (ref, res) = table_lsi
@@ -452,6 +467,33 @@ def test_update_provisioned_throughput(self, table_lsi):
             timeout_seconds=MODIFY_WAIT_AFTER_SECONDS,
             interval_seconds=3,
         )
+    
+    def test_update_insights(self, table_insights):
+        (ref, res) = table_insights
+
+        table_name = res["spec"]["tableName"]
+        assert k8s.wait_on_condition(ref, "ACK.ResourceSynced", "True", wait_periods=5)
+
+        cr = k8s.get_resource(ref)
+
+        # Check DynamoDB Table exists
+        assert self.table_exists(table_name)
+        assert cr['spec']['contributorInsights'] == "ENABLE"
+        assert self.table_insight_status(table_name, "ENABLED")
+
+        # Set provisionedThroughput
+        updates = {
+            "spec": {
+                "contributorInsights": "DISABLE"
+            }
+        }
+        # Patch k8s resource
+        k8s.patch_custom_resource(ref, updates)
+        assert k8s.wait_on_condition(ref, "ACK.ResourceSynced", "True", wait_periods=5)
+        cr = k8s.get_resource(ref)
+        assert cr['spec']['contributorInsights'] == "DISABLE"
+        assert self.table_insight_status(table_name, "DISABLED")
+       
 
     def test_enable_sse_specification(self, table_lsi):
         (ref, res) = table_lsi