Skip to content

feat(servicecatalog): added property productType for CloudFormationProduct #33792

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

feat(servicecatalog): added property productType for CloudFormationProduct #33792

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c69be58
wip
ymhiroki Mar 15, 2025
946799e
Merge branch 'aws:main' into yhirokiy/servicecatalog-product-type
ymhiroki Mar 16, 2025
fb29ecd
update integ test
ymhiroki Mar 16, 2025
a74ef1e
update unit test
ymhiroki Mar 16, 2025
291fc9d
update readme
ymhiroki Mar 16, 2025
678d042
Merge branch 'main' into yhirokiy/servicecatalog-product-type
ymhiroki Mar 16, 2025
962e07e
Merge branch 'main' into yhirokiy/servicecatalog-product-type
rix0rrr Mar 18, 2025
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
10 changes: 5 additions & 5 deletions ...ws-servicecatalog/test/integ.product.js.snapshot/integ-servicecatalog-product.assets.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 ...-servicecatalog/test/integ.product.js.snapshot/integ-servicecatalog-product.template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,7 @@
"Properties": {
"Name": "testProduct",
"Owner": "testOwner",
"ProductType": "CLOUD_FORMATION_TEMPLATE",
"ProvisioningArtifactParameters": [
{
"DisableTemplateValidation": true,
Expand Down
7 changes: 2 additions & 5 deletions ...ting/framework-integ/test/aws-servicecatalog/test/integ.product.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.

23 changes: 12 additions & 11 deletions ...-testing/framework-integ/test/aws-servicecatalog/test/integ.product.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-servicecatalog/test/integ.product.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ const product = new servicecatalog.CloudFormationProduct(stack, 'TestProduct', {
},
productStackHistory.currentVersion(),
],
productType: servicecatalog.ProductType.CLOUD_FORMATION_TEMPLATE,
});

new IntegTest(app, 'integ-product', {
Expand Down
33 changes: 33 additions & 0 deletions packages/aws-cdk-lib/aws-servicecatalog/lib/product.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,32 @@ import { IBucket } from '../../aws-s3';
import { ArnFormat, IResource, Resource, Stack } from '../../core';
import { addConstructMetadata } from '../../core/lib/metadata-resource';

/**
* The type of product
*/
export enum ProductType {
/**
* CloudFormation template
*/
CLOUD_FORMATION_TEMPLATE = 'CLOUD_FORMATION_TEMPLATE',
/**
* created by Amazon Web Services Marketplace
*/
MARKETPLACE = 'MARKETPLACE',
/**
* Terraform Open Source configuration file
*/
TERRAFORM_OPEN_SOURCE = 'TERRAFORM_OPEN_SOURCE',
/**
* Terraform Cloud configuration file
*/
TERRAFORM_CLOUD = 'TERRAFORM_CLOUD',
/**
* External configuration file
*/
EXTERNAL = 'EXTERNAL',
}

/**
* A Service Catalog product, currently only supports type CloudFormationProduct
*/
Expand Down Expand Up @@ -117,6 +143,12 @@ export interface CloudFormationProductProps {
*/
readonly distributor?: string;

/**
* The type of the product.
* @default - No type provided
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you please describe which type is set by default if undefined is passed?

When not explicitly setting the default value in CDK, it seems to be preferred by maintainers recently to explicitly describe what behavior occurs as the CloudFormation default, as shown below.

You don't necessarily need to adhere to it, but you might receive such feedback from the maintainers.

*/
readonly productType?: ProductType;

/**
* Whether to give provisioning artifacts a new unique identifier when the product attributes or provisioning artifacts is updated
* @default false
Expand Down Expand Up @@ -201,6 +233,7 @@ export class CloudFormationProduct extends Product {
name: props.productName,
owner: props.owner,
provisioningArtifactParameters: this.renderProvisioningArtifacts(props),
productType: props.productType,
replaceProvisioningArtifacts: props.replaceProductVersionIds,
supportDescription: props.supportDescription,
supportEmail: props.supportEmail,
Expand Down
17 changes: 17 additions & 0 deletions packages/aws-cdk-lib/aws-servicecatalog/test/product.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,6 +387,23 @@ describe('Product', () => {
expect(product.productArn).toEqual('arn:aws:catalog:region:account-id:product/prod-djh8932wr');
}),

test('configure the type of product', () => {
new servicecatalog.CloudFormationProduct(stack, 'MyProduct', {
productName: 'testProduct',
owner: 'testOwner',
productVersions: [
{
cloudFormationTemplate: servicecatalog.CloudFormationTemplate.fromUrl('https://awsdocs.s3.amazonaws.com/servicecatalog/development-environment.template'),
},
],
productType: servicecatalog.ProductType.CLOUD_FORMATION_TEMPLATE,
});

Template.fromStack(stack).hasResourceProperties('AWS::ServiceCatalog::CloudFormationProduct', {
ProductType: 'CLOUD_FORMATION_TEMPLATE',
});
});

test('fails product from attributes without resource name in arn', () => {
expect(() => {
servicecatalog.Product.fromProductArn(stack, 'MyProduct', 'arn:aws:catalog:region:account-id:product');
Expand Down
Loading