aws-ec2: Instance.applyCloudFormationInit is private

[Irame]

Describe the bug

1. Can not attach CloudFormationInit to an Instance after I created it because Instance.applyCloudFormationInit is not public.

Expected Behavior

I expected to be able to call applyCloudFormationInit to attach my CloudFormationInit to a EC2 Instance, because the documentation said it would be possible.

Current Behavior

I can not call Instance.applyCloudFormationInit beacuse it it private.

Reproduction Steps

Create a ec2.Instance and try to call applyCloudFormationInit on it.

Possible Solution

Make ec2.Instance.applyCloudFormationInit public.

Additional Information/Context

Code location:

aws-cdk/packages/aws-cdk-lib/aws-ec2/lib/instance.ts

Line 633 in ce7a8d5

private applyCloudFormationInit(init: CloudFormationInit, options: ApplyCloudFormationInitOptions = {}) {

Documentation: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.CloudFormationInit.html#:~:text=As%20an%20app%20builder%2C%20use%20instance.applyCloudFormationInit()

CDK CLI Version

2.149.0

Framework Version

No response

Node.js Version

v20.11.0

OS

Windows

Language

TypeScript

Language Version

5.5.2

Other information

No response

[khushail]

Hi @Irame , thanks for reaching out. AFAIK, the applyCloydformationInit() has been inherently called by EC2 Instance object creation constructor as mentioned here which makes call to attach() to set the config.

aws-cdk/packages/aws-cdk-lib/aws-ec2/lib/instance.ts

Line 564 in ce7a8d5

if (props.init) {

aws-cdk/packages/aws-cdk-lib/aws-ec2/lib/instance.ts

Line 625 in ce7a8d5

* Use a CloudFormation Init configuration at instance startup

Making it public might not be desirable PR(014c13a#diff-53d5a35c408bb5bcd8c3b8e135dbd00660447763e9003af414536ab603d4a25d). Leaving it upto the core team for decision making.

[Irame]

Hi, thank you for the prompt response.
I noticed that applyCloydformationInit() is called by the constructor, but I didn't see any reason for it to be private. Making it public would be beneficial because reimplementing its functionality using attach is cumbersome and error-prone. Additionally, applyCloydformationInit() includes a call to waitForResourceSignal(), which is also private and similarly difficult to reimplement.

[khushail]

Hi @Irame , I checked with my team regarding this method. Seems like the change was done quite a long time ago. I also saw that this method is public with autoscaling -

aws-cdk/packages/aws-cdk-lib/aws-autoscaling/lib/auto-scaling-group.ts

Line 1650 in ffd9d9c

public applyCloudFormationInit(init: ec2.CloudFormationInit, options: ApplyCloudFormationInitOptions = {}) {

It would make no harm if we make the mentioned method public for EC2 as well. Please feel free to submit a PR if you would like. Thanks!

[github-actions]

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.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

[github-actions]

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.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

[aws-cdk-automation]

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.