aws_ec2: KeyPair static methods do not retrieve existing key pairs

Describe the bug

using the static methods

KeyPair.fromKeyPairName()
KeyPair.fromKeyPairAttributes()

and the the keyPair property on the InstanceProps interface does not set the public key on the instance at instance deployment

{
     keyPair:IKeyPair
}

### Expected Behavior

using the methods:

```typescript
    const keyPair = KeyPair.fromKeyPairAttributes(this, 'key-pair', {
      keyPairName: 'myExistingKeyName',
      type: KeyPairType.RSA
    });

   const instance = new ec2.Instance(this, 'instance', {
      vpc: this.props.vpc,
      securityGroup: this.props.applicationSecurityGroup,
      vpcSubnets: {
        subnetType: ec2.SubnetType.PUBLIC
      },
      instanceName: 'host',
      instanceType: ec2.InstanceType.of(ec2.InstanceClass.T3, ec2.InstanceSize.MEDIUM),
      machineImage: ec2.MachineImage.latestAmazonLinux2023(),
      keyPair: keyPair,
      userDataCausesReplacement: true
    });

Should result in the public key being set on in the ~/.ssh/authorized_keys file of the instance.

Current Behavior

No keys are set when that property / method is used.

the "keyName" property marked as obsolete DOES work however.

Reproduction Steps

using the methods:

    const keyPair = KeyPair.fromKeyPairAttributes(this, 'key-pair', {
      keyPairName: 'myExistingKeyName',
      type: KeyPairType.RSA
    });

   const instance = new ec2.Instance(this, 'instance', {
      vpc: this.props.vpc,
      securityGroup: this.props.applicationSecurityGroup,
      vpcSubnets: {
        subnetType: ec2.SubnetType.PUBLIC
      },
      instanceName: 'host',
      instanceType: ec2.InstanceType.of(ec2.InstanceClass.T3, ec2.InstanceSize.MEDIUM),
      machineImage: ec2.MachineImage.latestAmazonLinux2023(),
      keyPair: keyPair,
      userDataCausesReplacement: true
    });

Possible Solution

No response

Additional Information/Context

No response

CDK CLI Version

2.117.0 (build 59d9b23)

Framework Version

No response

Node.js Version

v18.16.0

OS

macOS sonoma 14.1.2 (23B92)

Language

TypeScript

Language Version

5.3.3

Other information

No response

[pahud]

Can you share your ec2 instance resource template from the synthesized cloudformation template?

Is the KeyName from the synthesized template of the AWS::EC2::Instance correct?

And, did you check the ec2 console for the KeyName? Is it correct?

If both the synthesized template and console are correct, I think it should work as expected.

[laurelmay]

I believe this is a duplicate of #28478 presented in a different form. There is an open PR (#28482) to resolve this that needs review for an exemption request before it can proceed.

Thank you for reporting this! Hopefully the PR with the fix will be able to be merged quickly.

[fire015]

+1 having the same problem

[ayush-shah-1501]

We can close this as PR #28482 is merged now.

[related-issues-bot-for-aws]

Hi @ghost,

Thanks for opening this issue! After reviewing the details, we found some other discussions that may be duplicates or closely related:

Potential Duplicate Issues

• aws_ec2: passing keyPair to Instance does nothing #28478: This issue reports the same fundamental problem where the keyPair property on EC2 instances doesn't actually associate the key pair with the instance. Both issues identify that while the deprecated keyName property works, the newer keyPair property doesn't apply the key to the instance. The issue has been resolved by PR fix(ec2): passing keypair to instance unexpectedly does nothing #28482 which fixed the implementation by properly specifying the key pair reference in cfnInstance. (Resolved by PR fix(ec2): passing keypair to instance unexpectedly does nothing #28482: fix(ec2): passing keypair to instance unexpectedly does nothing)

This message was generated automatically to help connect related conversations and improve discoverability.

If you feel this issue brings new or distinct information, feel free to add a comment to keep it open. Otherwise, we'll close this issue in 7 days if we don't recieve a response to help keep discussions consolidated.

Please react with 👍 or 👎 to let us know if this response was helpful!

Thank you for helping improve CDK! 🙌