[feat]: allow adding resource policy to dynamodb tables #154
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,13 @@ | ||
| ack_generate_info: | ||
| build_date: "2025-10-17T18:47:29Z" | ||
| build_hash: 6b4211163dcc34776b01da9a18217bac0f4103fd | ||
| go_version: go1.24.6 | ||
| version: v0.52.0 | ||
| api_directory_checksum: d2887bf57c4e94a2687e17c41f74c875131c0beb | ||
| api_version: v1alpha1 | ||
| aws_sdk_go_version: v1.32.6 | ||
| generator_config_info: | ||
| file_checksum: 3c4832feff83bc9c29b40bc73bafc1d7e75ab1cd | ||
| original_file_name: generator.yaml | ||
| last_modification: | ||
| reason: API generation |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -166,17 +166,6 @@ func (rm *resourceManager) customUpdateTable( | |
| setSyncedCondition(desired, corev1.ConditionFalse, &msg, nil) | ||
| return desired, requeueWaitWhileCreating | ||
| } | ||
|
|
||
| // Merge in the information we read from the API call above to the copy of | ||
| // the original Kubernetes object we passed to the function | ||
|
|
@@ -188,10 +177,36 @@ func (rm *resourceManager) customUpdateTable( | |
| return nil, err | ||
| } | ||
| } | ||
|
|
||
| // ResourcePolicy can be updated independently of table state | ||
| if delta.DifferentAt("Spec.ResourcePolicy") { | ||
| if latest.ko.Status.ACKResourceMetadata == nil || latest.ko.Status.ACKResourceMetadata.ARN == nil { | ||
| rlog.Debug("skipping ResourcePolicy sync - table ARN not available yet") | ||
| return &resource{ko}, requeueWaitWhileCreating | ||
| } | ||
|
|
||
| err = rm.syncResourcePolicy(ctx, desired, latest) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("cannot update table resource policy %v", err) | ||
| } | ||
| } | ||
|
|
||
| if !delta.DifferentExcept("Spec.Tags", "Spec.ResourcePolicy") { | ||
| return &resource{ko}, nil | ||
| } | ||
|
|
||
| if isTableUpdating(latest) { | ||
| msg := "table is currently being updated" | ||
| setSyncedCondition(desired, corev1.ConditionFalse, &msg, nil) | ||
| return desired, requeueWaitWhileUpdating | ||
| } | ||
| if tableHasTerminalStatus(latest) { | ||
| msg := "table is in '" + *latest.ko.Status.TableStatus + "' status" | ||
| setTerminalCondition(desired, corev1.ConditionTrue, &msg, nil) | ||
| setSyncedCondition(desired, corev1.ConditionTrue, nil, nil) | ||
| return desired, nil | ||
| } | ||
|
|
||
| if delta.DifferentAt("Spec.TimeToLive") { | ||
| if err := rm.syncTTL(ctx, desired, latest); err != nil { | ||
| // Ignore "already disabled errors" | ||
|
|
@@ -522,6 +537,15 @@ func (rm *resourceManager) setResourceAdditionalFields( | |
| } else { | ||
| ko.Spec.ContinuousBackups = pitrSpec | ||
| } | ||
|
|
||
| if ko.Status.ACKResourceMetadata != nil && ko.Status.ACKResourceMetadata.ARN != nil { | ||
| policy, err := rm.getResourcePolicyWithContext(ctx, (*string)(ko.Status.ACKResourceMetadata.ARN)) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| ko.Spec.ResourcePolicy = policy | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
|
|
@@ -671,6 +695,14 @@ func customPreCompare( | |
| } | ||
| } | ||
|
|
||
| if ackcompare.HasNilDifference(a.ko.Spec.ResourcePolicy, b.ko.Spec.ResourcePolicy) { | ||
| delta.Add("Spec.ResourcePolicy", a.ko.Spec.ResourcePolicy, b.ko.Spec.ResourcePolicy) | ||
| } else if a.ko.Spec.ResourcePolicy != nil && b.ko.Spec.ResourcePolicy != nil { | ||
| if *a.ko.Spec.ResourcePolicy != *b.ko.Spec.ResourcePolicy { | ||
| delta.Add("Spec.ResourcePolicy", a.ko.Spec.ResourcePolicy, b.ko.Spec.ResourcePolicy) | ||
| } | ||
| } | ||
|
|
||
|
||
| } | ||
|
|
||
| // equalAttributeDefinitions return whether two AttributeDefinition arrays are equal or not. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| // Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"). You may | ||
| // not use this file except in compliance with the License. A copy of the | ||
| // License is located at | ||
| // | ||
| // http://aws.amazon.com/apache2.0/ | ||
| // | ||
| // or in the "license" file accompanying this file. This file is distributed | ||
| // on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
| // express or implied. See the License for the specific language governing | ||
| // permissions and limitations under the License. | ||
|
|
||
| package table | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
|
|
||
| ackerr "github.com/aws-controllers-k8s/runtime/pkg/errors" | ||
| ackrtlog "github.com/aws-controllers-k8s/runtime/pkg/runtime/log" | ||
| svcsdk "github.com/aws/aws-sdk-go-v2/service/dynamodb" | ||
| svcsdktypes "github.com/aws/aws-sdk-go-v2/service/dynamodb/types" | ||
| ) | ||
|
|
||
| // syncResourcePolicy updates a DynamoDB table's resource-based policy. | ||
| func (rm *resourceManager) syncResourcePolicy( | ||
| ctx context.Context, | ||
| desired *resource, | ||
| latest *resource, | ||
| ) (err error) { | ||
| rlog := ackrtlog.FromContext(ctx) | ||
| exit := rlog.Trace("rm.syncResourcePolicy") | ||
| defer func(err error) { exit(err) }(err) | ||
|
|
||
| if desired.ko.Spec.ResourcePolicy == nil { | ||
| return rm.deleteResourcePolicy(ctx, latest) | ||
| } | ||
|
|
||
| return rm.putResourcePolicy(ctx, desired) | ||
| } | ||
|
|
||
| // putResourcePolicy attaches or updates a resource-based policy to a DynamoDB table. | ||
| func (rm *resourceManager) putResourcePolicy( | ||
| ctx context.Context, | ||
| r *resource, | ||
| ) (err error) { | ||
| rlog := ackrtlog.FromContext(ctx) | ||
| exit := rlog.Trace("rm.putResourcePolicy") | ||
| defer func(err error) { exit(err) }(err) | ||
|
|
||
| if r.ko.Spec.ResourcePolicy == nil { | ||
| return nil | ||
| } | ||
|
|
||
| tableARN := (*string)(r.ko.Status.ACKResourceMetadata.ARN) | ||
| if tableARN == nil || *tableARN == "" { | ||
| return errors.New("table ARN is required to put resource policy") | ||
| } | ||
|
|
||
| _, err = rm.sdkapi.PutResourcePolicy( | ||
| ctx, | ||
| &svcsdk.PutResourcePolicyInput{ | ||
| ResourceArn: tableARN, | ||
| Policy: r.ko.Spec.ResourcePolicy, | ||
| }, | ||
| ) | ||
| rm.metrics.RecordAPICall("UPDATE", "PutResourcePolicy", err) | ||
| return err | ||
| } | ||
|
|
||
| // deleteResourcePolicy removes a resource-based policy from a DynamoDB table. | ||
| func (rm *resourceManager) deleteResourcePolicy( | ||
| ctx context.Context, | ||
| r *resource, | ||
| ) (err error) { | ||
| rlog := ackrtlog.FromContext(ctx) | ||
| exit := rlog.Trace("rm.deleteResourcePolicy") | ||
| defer func(err error) { exit(err) }(err) | ||
|
|
||
| tableARN := (*string)(r.ko.Status.ACKResourceMetadata.ARN) | ||
| if tableARN == nil || *tableARN == "" { | ||
| return errors.New("table ARN is required to delete resource policy") | ||
| } | ||
|
|
||
| _, err = rm.sdkapi.DeleteResourcePolicy( | ||
| ctx, | ||
| &svcsdk.DeleteResourcePolicyInput{ | ||
| ResourceArn: tableARN, | ||
| }, | ||
| ) | ||
|
|
||
| if err != nil { | ||
| var policyNotFoundErr *svcsdktypes.PolicyNotFoundException | ||
|
Contributor
There was a problem hiding this comment. p: It would be good to add a unit test validating this behavior. |
||
| if errors.As(err, &policyNotFoundErr) { | ||
| // Policy already doesn't exist, this is a success case | ||
| return nil | ||
| } | ||
| } | ||
|
|
||
| rm.metrics.RecordAPICall("DELETE", "DeleteResourcePolicy", err) | ||
shabbskagalwala marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| return err | ||
| } | ||
|
|
||
| // getResourcePolicyWithContext retrieves the resource-based policy of a DynamoDB table. | ||
| func (rm *resourceManager) getResourcePolicyWithContext( | ||
| ctx context.Context, | ||
| tableARN *string, | ||
| ) (*string, error) { | ||
| var err error | ||
| rlog := ackrtlog.FromContext(ctx) | ||
| exit := rlog.Trace("rm.getResourcePolicyWithContext") | ||
| defer func(err error) { exit(err) }(err) | ||
|
|
||
| if tableARN == nil || *tableARN == "" { | ||
| return nil, errors.New("table ARN is required to get resource policy") | ||
| } | ||
|
|
||
| res, err := rm.sdkapi.GetResourcePolicy( | ||
| ctx, | ||
| &svcsdk.GetResourcePolicyInput{ | ||
| ResourceArn: tableARN, | ||
| }, | ||
| ) | ||
|
|
||
| if err != nil { | ||
| if awsErr, ok := ackerr.AWSError(err); ok && awsErr.ErrorCode() == "PolicyNotFoundException" { | ||
| return nil, nil | ||
| } | ||
| rm.metrics.RecordAPICall("GET", "GetResourcePolicy", err) | ||
| return nil, err | ||
| } | ||
|
|
||
| rm.metrics.RecordAPICall("GET", "GetResourcePolicy", nil) | ||
| return res.Policy, nil | ||
shabbskagalwala marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍