Skip to content
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

feat(secretsmanager): add support for rotateImmediatelyOnUpdate for secret rotation schedule #25652

Merged
merged 5 commits into from
May 23, 2023
Merged

feat(secretsmanager): add support for rotateImmediatelyOnUpdate for secret rotation schedule #25652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
37bcc1a
exposed rotatedImmediatelyOnUpdate
colifran May 19, 2023
3ac051f
added unit test to verify RotateImmediatelyOnUpdate is set in templat…
colifran May 19, 2023
05cc6b8
updated existing integ test to add rotateImmediatelyOnUpdate as false…
colifran May 19, 2023
4178dba
added example of using rotateImmediatelyOnUpdate prop for adding a ro…
colifran May 19, 2023
d1b35c5
Merge branch 'main' into colifran/rotate-secret-immediately
mergify[bot] May 23, 2023
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
6 changes: 3 additions & 3 deletions ...nager/test/integ.hosted-rotation.js.snapshot/cdk-integ-secret-hosted-rotation.assets.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"version": "20.0.0",
"version": "31.0.0",
"files": {
"80e7147ae17e29a7810c1890b8caa90a140f0089dcb2dce470bd13d88e5acc41": {
"68111103cf6a45cb34025acaab5488606270170cf3e4bccee5883433fe58e704": {
"source": {
"path": "cdk-integ-secret-hosted-rotation.template.json",
"packaging": "file"
},
"destinations": {
"current_account-current_region": {
"bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
"objectKey": "80e7147ae17e29a7810c1890b8caa90a140f0089dcb2dce470bd13d88e5acc41.json",
"objectKey": "68111103cf6a45cb34025acaab5488606270170cf3e4bccee5883433fe58e704.json",
"assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
}
}
Expand Down
1 change: 1 addition & 0 deletions ...ger/test/integ.hosted-rotation.js.snapshot/cdk-integ-secret-hosted-rotation.template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@
"ExcludeCharacters": "&@/",
"RotationType": "MySQLSingleUser"
},
"RotateImmediatelyOnUpdate": false,
"RotationRules": {
"AutomaticallyAfterDays": 30
}
Expand Down
2 changes: 1 addition & 1 deletion ...ng/framework-integ/test/aws-secretsmanager/test/integ.hosted-rotation.js.snapshot/cdk.out
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"version":"20.0.0"}
{"version":"31.0.0"}
2 changes: 1 addition & 1 deletion ...framework-integ/test/aws-secretsmanager/test/integ.hosted-rotation.js.snapshot/integ.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "20.0.0",
"version": "31.0.0",
"testCases": {
"integ.hosted-rotation": {
"stacks": [
Expand Down
16 changes: 8 additions & 8 deletions ...mework-integ/test/aws-secretsmanager/test/integ.hosted-rotation.js.snapshot/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
{
"version": "20.0.0",
"version": "31.0.0",
"artifacts": {
"Tree": {
"type": "cdk:tree",
"properties": {
"file": "tree.json"
}
},
"cdk-integ-secret-hosted-rotation.assets": {
"type": "cdk:asset-manifest",
"properties": {
Expand All @@ -23,7 +17,7 @@
"validateOnSynth": false,
"assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-deploy-role-${AWS::AccountId}-${AWS::Region}",
"cloudFormationExecutionRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-cfn-exec-role-${AWS::AccountId}-${AWS::Region}",
"stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}/80e7147ae17e29a7810c1890b8caa90a140f0089dcb2dce470bd13d88e5acc41.json",
"stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}/68111103cf6a45cb34025acaab5488606270170cf3e4bccee5883433fe58e704.json",
"requiresBootstrapStackVersion": 6,
"bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version",
"additionalDependencies": [
Expand Down Expand Up @@ -89,6 +83,12 @@
]
},
"displayName": "cdk-integ-secret-hosted-rotation"
},
"Tree": {
"type": "cdk:tree",
"properties": {
"file": "tree.json"
}
}
}
}
63 changes: 40 additions & 23 deletions .../framework-integ/test/aws-secretsmanager/test/integ.hosted-rotation.js.snapshot/tree.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,6 @@
"id": "App",
"path": "",
"children": {
"Tree": {
"id": "Tree",
"path": "Tree",
"constructInfo": {
"fqn": "constructs.Construct",
"version": "10.1.85"
}
},
"cdk-integ-secret-hosted-rotation": {
"id": "cdk-integ-secret-hosted-rotation",
"path": "cdk-integ-secret-hosted-rotation",
Expand All @@ -30,7 +22,7 @@
}
},
"constructInfo": {
"fqn": "@aws-cdk/aws-secretsmanager.CfnSecret",
"fqn": "aws-cdk-lib.aws_secretsmanager.CfnSecret",
"version": "0.0.0"
}
},
Expand All @@ -57,13 +49,13 @@
}
},
"constructInfo": {
"fqn": "@aws-cdk/aws-secretsmanager.CfnRotationSchedule",
"fqn": "aws-cdk-lib.aws_secretsmanager.CfnRotationSchedule",
"version": "0.0.0"
}
}
},
"constructInfo": {
"fqn": "@aws-cdk/aws-secretsmanager.RotationSchedule",
"fqn": "aws-cdk-lib.aws_secretsmanager.RotationSchedule",
"version": "0.0.0"
}
},
Expand Down Expand Up @@ -111,19 +103,19 @@
}
},
"constructInfo": {
"fqn": "@aws-cdk/aws-secretsmanager.CfnResourcePolicy",
"fqn": "aws-cdk-lib.aws_secretsmanager.CfnResourcePolicy",
"version": "0.0.0"
}
}
},
"constructInfo": {
"fqn": "@aws-cdk/aws-secretsmanager.ResourcePolicy",
"fqn": "aws-cdk-lib.aws_secretsmanager.ResourcePolicy",
"version": "0.0.0"
}
}
},
"constructInfo": {
"fqn": "@aws-cdk/aws-secretsmanager.Secret",
"fqn": "aws-cdk-lib.aws_secretsmanager.Secret",
"version": "0.0.0"
}
},
Expand All @@ -143,7 +135,7 @@
}
},
"constructInfo": {
"fqn": "@aws-cdk/aws-secretsmanager.CfnSecret",
"fqn": "aws-cdk-lib.aws_secretsmanager.CfnSecret",
"version": "0.0.0"
}
},
Expand All @@ -164,19 +156,20 @@
"rotationType": "MySQLSingleUser",
"excludeCharacters": "&@/"
},
"rotateImmediatelyOnUpdate": false,
"rotationRules": {
"automaticallyAfterDays": 30
}
}
},
"constructInfo": {
"fqn": "@aws-cdk/aws-secretsmanager.CfnRotationSchedule",
"fqn": "aws-cdk-lib.aws_secretsmanager.CfnRotationSchedule",
"version": "0.0.0"
}
}
},
"constructInfo": {
"fqn": "@aws-cdk/aws-secretsmanager.RotationSchedule",
"fqn": "aws-cdk-lib.aws_secretsmanager.RotationSchedule",
"version": "0.0.0"
}
},
Expand Down Expand Up @@ -224,32 +217,56 @@
}
},
"constructInfo": {
"fqn": "@aws-cdk/aws-secretsmanager.CfnResourcePolicy",
"fqn": "aws-cdk-lib.aws_secretsmanager.CfnResourcePolicy",
"version": "0.0.0"
}
}
},
"constructInfo": {
"fqn": "@aws-cdk/aws-secretsmanager.ResourcePolicy",
"fqn": "aws-cdk-lib.aws_secretsmanager.ResourcePolicy",
"version": "0.0.0"
}
}
},
"constructInfo": {
"fqn": "@aws-cdk/aws-secretsmanager.Secret",
"fqn": "aws-cdk-lib.aws_secretsmanager.Secret",
"version": "0.0.0"
}
},
"BootstrapVersion": {
"id": "BootstrapVersion",
"path": "cdk-integ-secret-hosted-rotation/BootstrapVersion",
"constructInfo": {
"fqn": "aws-cdk-lib.CfnParameter",
"version": "0.0.0"
}
},
"CheckBootstrapVersion": {
"id": "CheckBootstrapVersion",
"path": "cdk-integ-secret-hosted-rotation/CheckBootstrapVersion",
"constructInfo": {
"fqn": "aws-cdk-lib.CfnRule",
"version": "0.0.0"
}
}
},
"constructInfo": {
"fqn": "aws-cdk-lib.Stack",
"version": "0.0.0"
}
},
"Tree": {
"id": "Tree",
"path": "Tree",
"constructInfo": {
"fqn": "constructs.Construct",
"version": "10.1.85"
"version": "10.2.26"
}
}
},
"constructInfo": {
"fqn": "constructs.Construct",
"version": "10.1.85"
"fqn": "aws-cdk-lib.App",
"version": "0.0.0"
}
}
}
1 change: 1 addition & 0 deletions ...es/@aws-cdk-testing/framework-integ/test/aws-secretsmanager/test/integ.hosted-rotation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ class TestStack extends cdk.Stack {
});
customSecret.addRotationSchedule('Schedule', {
hostedRotation: secretsmanager.HostedRotation.mysqlSingleUser(),
rotateImmediatelyOnUpdate: false,
});
}
}
Expand Down
1 change: 1 addition & 0 deletions packages/aws-cdk-lib/aws-secretsmanager/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ const secret = new secretsmanager.Secret(this, 'Secret');

secret.addRotationSchedule('RotationSchedule', {
hostedRotation: secretsmanager.HostedRotation.mysqlSingleUser(),
rotateImmediatelyOnUpdate: false, // by default, Secrets Manager rotates the secret immediately
});
```

Expand Down
9 changes: 9 additions & 0 deletions packages/aws-cdk-lib/aws-secretsmanager/lib/rotation-schedule.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,14 @@ export interface RotationScheduleOptions {
* @default Duration.days(30)
*/
readonly automaticallyAfter?: Duration;

/**
* Specifies whether to rotate the secret immediately or wait until the next
* scheduled rotation window.
*
* @default - secret is rotated immediately
*/
readonly rotateImmediatelyOnUpdate?: boolean;
}

/**
Expand Down Expand Up @@ -132,6 +140,7 @@ export class RotationSchedule extends Resource {
rotationLambdaArn: props.rotationLambda?.functionArn,
hostedRotationLambda: props.hostedRotation?.bind(props.secret, this),
rotationRules,
rotateImmediatelyOnUpdate: props.rotateImmediatelyOnUpdate,
});

// Prevent secrets deletions when rotation is in place
Expand Down
28 changes: 28 additions & 0 deletions packages/aws-cdk-lib/aws-secretsmanager/test/rotation-schedule.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,34 @@ test('create a rotation schedule with a rotation Lambda', () => {
});
});

test('create a rotation schedule without immediate rotation', () => {
// GIVEN
const secret = new secretsmanager.Secret(stack, 'Secret');
const rotationLambda = new lambda.Function(stack, 'Lambda', {
runtime: lambda.Runtime.NODEJS_14_X,
code: lambda.Code.fromInline('export.handler = event => event;'),
handler: 'index.handler',
});

// WHEN
new secretsmanager.RotationSchedule(stack, 'RotationSchedule', {
secret,
rotationLambda,
rotateImmediatelyOnUpdate: false,
});

// THEN
Template.fromStack(stack).hasResourceProperties('AWS::SecretsManager::RotationSchedule', {
SecretId: {
Ref: 'SecretA720EF05',
},
RotationRules: {
AutomaticallyAfterDays: 30,
},
RotateImmediatelyOnUpdate: false,
});
});

test('assign permissions for rotation schedule with a rotation Lambda', () => {
// GIVEN
const secret = new secretsmanager.Secret(stack, 'Secret');
Expand Down