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(ec2): add versionDescription property for LaunchTemplate #30837

Merged
merged 8 commits into from
Jul 24, 2024
Merged

feat(ec2): add versionDescription property for LaunchTemplate #30837

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c3d69db
feat(ec2): add versionDescription property for launch template
yuppe-kyupeen Jul 12, 2024
7163385
docs: Remove unnecessary comment and improve formatting
yuppe-kyupeen Jul 13, 2024
849e005
Merge branch 'main' into add-version-description-for-ec2
yuppe-kyupeen Jul 13, 2024
0bec9e2
Update packages/aws-cdk-lib/aws-ec2/lib/launch-template.ts
yuppe-kyupeen Jul 13, 2024
115a68c
Merge branch 'main' into add-version-description-for-ec2
yuppe-kyupeen Jul 17, 2024
4a1505b
Update packages/aws-cdk-lib/aws-ec2/lib/launch-template.ts
yuppe-kyupeen Jul 23, 2024
a2798a5
Merge branch 'main' into add-version-description-for-ec2
yuppe-kyupeen Jul 23, 2024
70c9be5
Merge branch 'main' into add-version-description-for-ec2
mergify[bot] Jul 24, 2024
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
4 changes: 2 additions & 2 deletions ...test/aws-ec2/test/integ.launch-template.js.snapshot/aws-cdk-ec2-lt-metadata-1.assets.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion ...st/aws-ec2/test/integ.launch-template.js.snapshot/aws-cdk-ec2-lt-metadata-1.template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,8 @@
}
]
}
]
],
"VersionDescription": "test template v1"
}
},
"sg2860DD91F": {
Expand Down
2 changes: 1 addition & 1 deletion ...testing/framework-integ/test/aws-ec2/test/integ.launch-template.js.snapshot/manifest.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

107 changes: 54 additions & 53 deletions ...cdk-testing/framework-integ/test/aws-ec2/test/integ.launch-template.js.snapshot/tree.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions packages/@aws-cdk-testing/framework-integ/test/aws-ec2/test/integ.launch-template.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ const sg1 = new ec2.SecurityGroup(stack, 'sg1', {
});

const lt = new ec2.LaunchTemplate(stack, 'LT', {
versionDescription: 'test template v1',
httpEndpoint: true,
httpProtocolIpv6: true,
httpPutResponseHopLimit: 2,
Expand Down
2 changes: 2 additions & 0 deletions packages/aws-cdk-lib/aws-ec2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2287,6 +2287,8 @@ const instanceProfile = new iam.InstanceProfile(this, 'InstanceProfile', {
});

const template = new ec2.LaunchTemplate(this, 'LaunchTemplate', {
launchTemplateName: 'MyTemplateV1',
versionDescription: 'This is my v1 template',
machineImage: ec2.MachineImage.latestAmazonLinux2023(),
securityGroup: new ec2.SecurityGroup(this, 'LaunchTemplateSG', {
vpc: vpc,
Expand Down
14 changes: 14 additions & 0 deletions packages/aws-cdk-lib/aws-ec2/lib/launch-template.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,15 @@ export interface LaunchTemplateProps {
*/
readonly launchTemplateName?: string;

/**
* A description for the first version of the launch template.
* The version descrioption must be maximum 255 characters long, including hyphens (-),
Copy link
Contributor

Choose a reason for hiding this comment

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

A line break would make it clearer.

Suggested change
* A description for the first version of the launch template.
* The version descrioption must be maximum 255 characters long, including hyphens (-),
* A description for the first version of the launch template.
*
* The version descrioption must be maximum 255 characters long, including hyphens (-),

* underscores (_), spaces, and tabs.
Copy link
Contributor

@go-to-k go-to-k Jul 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

including hyphens (-), * underscores (_), spaces, and tabs.

Is there documentation available to confirm this? (I could not find that in the CFn documentation.)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-versiondescription

*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-versiondescription
*/
readonly versionDescription?: string;
Copy link
Contributor

@go-to-k go-to-k Jul 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

The CodeBuild CI seems to be failing. Optional properties must have @default documentation. Could you add the label and description to the JSDoc?

aws-cdk-lib: error: [awslint:props-default-doc:aws-cdk-lib.aws_ec2.LaunchTemplateProps.versionDescription] Optional property must have @default documentation 
aws-cdk-lib: Error: /codebuild/output/src1195990305/src/github.com/aws/aws-cdk/tools/@aws-cdk/cdk-build-tools/bin/cdk-awslint exited with error code 1
aws-cdk-lib: Build failed.!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!


/**
* Type of instance to launch.
*
Expand Down Expand Up @@ -735,8 +744,13 @@ export class LaunchTemplate extends Resource implements ILaunchTemplate, iam.IGr
? [{ deviceIndex: 0, associatePublicIpAddress: props.associatePublicIpAddress, groups: securityGroupsToken }]
: undefined;

if (props.versionDescription && !Token.isUnresolved(props.versionDescription) && props.versionDescription.length > 255) {
throw new Error(`versionDescription must be less than or equal to 255 characters, got ${props.versionDescription.length}`);
}

const resource = new CfnLaunchTemplate(this, 'Resource', {
launchTemplateName: props?.launchTemplateName,
versionDescription: props?.versionDescription,
launchTemplateData: {
blockDeviceMappings: props?.blockDevices !== undefined ? launchTemplateBlockDeviceMappings(this, props.blockDevices) : undefined,
creditSpecification: props?.cpuCredits !== undefined ? {
Expand Down
22 changes: 22 additions & 0 deletions packages/aws-cdk-lib/aws-ec2/test/launch-template.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,28 @@ describe('LaunchTemplate', () => {
});
});

test('Given versionDescription', () => {
// WHEN
new LaunchTemplate(stack, 'Template', {
versionDescription: 'test template',
});

// THEN
Template.fromStack(stack).hasResourceProperties('AWS::EC2::LaunchTemplate', {
VersionDescription: 'test template',
});
});

test('throw error when versionDescription is too long', () => {
const tooLongDescription = 'a'.repeat(256);
// WHEN / THEN
expect(() => {
new LaunchTemplate(stack, 'TemplateWithTooLongDescription', {
versionDescription: tooLongDescription,
});
}).toThrow('versionDescription must be less than or equal to 255 characters, got 256');
});

test('Given instanceType', () => {
// WHEN
new LaunchTemplate(stack, 'Template', {
Expand Down
Loading