Skip to content

feat: grant method of AmplifyDynamoDBTable.tableFromAttr to grant index permissions #3376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fossamagna wants to merge 7 commits into
base: main
Choose a base branch
from
Open

feat: grant method of AmplifyDynamoDBTable.tableFromAttr to grant index permissions #3376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2710cd8
feat: grant method of AmplifyDynamoDBTable.tableFromAttr to grant ind…
fossamagna Nov 28, 2025
92042cc
Merge branch 'main' into grant-gsi-permissions
fossamagna Dec 20, 2025
1b6662a
Merge branch 'main' into grant-gsi-permissions
fossamagna Jan 6, 2026
6f62d76
Merge branch 'main' into grant-gsi-permissions
fossamagna Jan 22, 2026
2baaf86
Merge branch 'main' into grant-gsi-permissions
fossamagna Jan 29, 2026
2369586
Merge branch 'main' into grant-gsi-permissions
fossamagna Feb 22, 2026
f07249b
Merge branch 'main' into grant-gsi-permissions
fossamagna Feb 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 134 additions & 0 deletions .../amplify-graphql-model-transformer/src/__tests__/amplify-dynamodb-table-construct.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,4 +259,138 @@ describe('Amplify DynamoDB Table Construct Tests', () => {
}),
});
});

describe('tableFromAttr', () => {
describe('grantReadData', () => {
it('grants read access to table and indexes', () => {
const stack = new cdk.Stack();
const table = new AmplifyDynamoDBTable(stack, 'MockTable', {
customResourceServiceToken: 'mockResourceServiceToken',
tableName: 'mockTableName',
partitionKey: {
name: 'id',
type: AttributeType.STRING,
},
});
table.addGlobalSecondaryIndex({
indexName: 'gsi1',
partitionKey: {
name: 'name',
type: AttributeType.STRING,
},
});

table.tableFromAttr.grantReadData(
new Role(stack, 'MockRole', {
assumedBy: new ArnPrincipal('mock_principal'),
}),
);

const template = Template.fromStack(stack);
template.hasResourceProperties('AWS::IAM::Policy', {
PolicyDocument: Match.objectLike({
Statement: Match.arrayWith([
Match.objectLike({
Action: [
'dynamodb:BatchGetItem',
'dynamodb:GetRecords',
'dynamodb:GetShardIterator',
'dynamodb:Query',
'dynamodb:GetItem',
'dynamodb:Scan',
'dynamodb:ConditionCheckItem',
'dynamodb:DescribeTable',
],
Effect: 'Allow',
Resource: Match.arrayWith([
{
'Fn::GetAtt': ['MockTable', 'TableArn'],
},
{
'Fn::Join': [
'',
[
{
'Fn::GetAtt': ['MockTable', 'TableArn'],
},
'/index/*',
],
],
},
]),
}),
]),
}),
});
});
});

describe('grantReadWriteData', () => {
it('grants read and write access to table and indexes', () => {
const stack = new cdk.Stack();
const table = new AmplifyDynamoDBTable(stack, 'MockTable', {
customResourceServiceToken: 'mockResourceServiceToken',
tableName: 'mockTableName',
partitionKey: {
name: 'id',
type: AttributeType.STRING,
},
});
table.addGlobalSecondaryIndex({
indexName: 'gsi1',
partitionKey: {
name: 'name',
type: AttributeType.STRING,
},
});

table.tableFromAttr.grantReadWriteData(
new Role(stack, 'MockRole', {
assumedBy: new ArnPrincipal('mock_principal'),
}),
);

const template = Template.fromStack(stack);
template.hasResourceProperties('AWS::IAM::Policy', {
PolicyDocument: Match.objectLike({
Statement: Match.arrayWith([
Match.objectLike({
Action: [
'dynamodb:BatchGetItem',
'dynamodb:GetRecords',
'dynamodb:GetShardIterator',
'dynamodb:Query',
'dynamodb:GetItem',
'dynamodb:Scan',
'dynamodb:ConditionCheckItem',
'dynamodb:BatchWriteItem',
'dynamodb:PutItem',
'dynamodb:UpdateItem',
'dynamodb:DeleteItem',
'dynamodb:DescribeTable',
],
Effect: 'Allow',
Resource: Match.arrayWith([
{
'Fn::GetAtt': ['MockTable', 'TableArn'],
},
{
'Fn::Join': [
'',
[
{
'Fn::GetAtt': ['MockTable', 'TableArn'],
},
'/index/*',
],
],
},
]),
}),
]),
}),
});
});
});
});
});
1 change: 1 addition & 0 deletions ...ransformer/src/resources/amplify-dynamodb-table/amplify-dynamodb-table-construct/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ export class AmplifyDynamoDBTable extends Resource {
this.tableFromAttr = Table.fromTableAttributes(scope, `CustomTable${id}`, {
tableArn: this.tableArn,
tableStreamArn: this.tableStreamArn,
grantIndexPermissions: true,
});

this.addKey(props.partitionKey, HASH_KEY_TYPE);
Expand Down