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.

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

fix(ec2): exposed userDataCausesReplacement in BastionHostLinuxProps #31416

Conversation

ashishdhingra
Copy link
Contributor

@ashishdhingra ashishdhingra commented Sep 12, 2024

Issue # (if applicable)

Closes #31348.

Reason for this change

When creating a Bastion host, customer is using instance's userData to write approved public keys to .ssh/authorized_keys. However, when changing the list of authorized keys, it does not trigger the instance to be replaced, so the modification has no effect.

Description of changes

Exposed userDataCausesReplacement in BastionHostLinuxProps. The value is passed down to downstream AWS::EC2::Instance resource.

Description of how you validated changes

Added unit and integration tests.

NOTE: Re-invoking Template.fromStack(stack) doesn't change the resource Id, so unit test uses 2 stacks. May be invoking Template.fromStack(stack) caches the results and doesn't refresh it.

Checklist


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@aws-cdk-automation aws-cdk-automation requested a review from a team September 12, 2024 00:23
@github-actions github-actions bot added bug This issue is a bug. effort/small Small work item – less than a day of effort p2 labels Sep 12, 2024
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Sep 12, 2024
@amazon-codecatalyst amazon-codecatalyst bot force-pushed the user/ashdhin/userDataCausesReplacement-BastionHostLinuxProps branch 2 times, most recently from 5df5949 to d6bf834 Compare September 12, 2024 01:41
@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Sep 12, 2024
Comment on lines +211 to +230
// THEN
Template.fromStack(stackOld).templateMatches(Match.objectLike({
Resources: Match.objectLike({
[`BastionHostUserDataCausesReplacement985DBC41${oldHash}`]: Match.objectLike({
Type: 'AWS::EC2::Instance',
Properties: Match.anyValue(),
}),
}),
}));

Template.fromStack(stackNew).templateMatches(Match.objectLike({
Resources: Match.objectLike({
[`BastionHostUserDataCausesReplacement985DBC41${newHash}`]: Match.objectLike({
Type: 'AWS::EC2::Instance',
Properties: Match.anyValue(),
}),
}),
}));
});

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I just care the logicalId should be different, another option FYR

    const oldResourceIds = Object.keys(Template.fromStack(stackOld).findResources('AWS::EC2::Instance'));
    const newResourceIds = Object.keys(Template.fromStack(stackNew).findResources('AWS::EC2::Instance'));

    if (oldResourceIds.length === 1 && newResourceIds.length === 1) {
      const oldResourceId = oldResourceIds[0];
      const newResourceId = newResourceIds[0];
    
      expect(oldResourceId).not.toEqual(newResourceId);
      expect(oldResourceId).toBe(`BastionHostUserDataCausesReplacement985DBC41${oldHash}`)
      expect(newResourceId).toBe(`BastionHostUserDataCausesReplacement985DBC41${newHash}`)
    } else {
      throw new Error('Expected exactly one AWS::EC2::Instance resource in each stack');
    }

@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Oct 10, 2024
@amazon-codecatalyst amazon-codecatalyst bot force-pushed the user/ashdhin/userDataCausesReplacement-BastionHostLinuxProps branch from 923e919 to fb621ff Compare October 10, 2024 23:26
Copy link
Contributor

mergify bot commented Oct 15, 2024

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 0790d21
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

Copy link
Contributor

mergify bot commented Oct 15, 2024

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit 029c298 into aws:main Oct 15, 2024
12 checks passed
Copy link

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug This issue is a bug. contribution/core This is a PR that came from AWS. effort/small Small work item – less than a day of effort p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

aws-ec2: Expose userDataCausesReplacement in BastionHostLinuxProps
4 participants