AWS marketplace documentation change
Summary
Added documentation for configuring Quick Launch experience, updated CloudFormation template instructions, and clarified visibility settings for SaaS products.
Security assessment
The changes include instructions for allowlisting AWS accounts and handling CloudFormation deployment parameters (e.g., API keys, external IDs), which are security-related best practices. However, there's no evidence these changes address a specific security vulnerability.
Diff
diff --git a/marketplace/latest/userguide/saas-product-settings.md b/marketplace/latest/userguide/saas-product-settings.md index 943294f65..2d3891cc1 100644 --- a//marketplace/latest/userguide/saas-product-settings.md +++ b//marketplace/latest/userguide/saas-product-settings.md @@ -5 +5 @@ -Manage change requestsUpdate product informationUpdate architecture detailsUpdate the allowlist of AWS account IDsUpdate product visibilityUpdate pricing termsAdd pricing dimensionsUpdate pricing dimensionsRestrict pricing dimensionsDetermine how buyers will access your productUpdate availability by countryUpdate the refund policy of a productUpdate the end user license agreement (EULA) +Manage change requestsUpdate product informationUpdate architecture detailsUpdate the allowlist of AWS account IDsUpdate product visibilityUpdate pricing termsAdd pricing dimensionsUpdate pricing dimensionsRestrict pricing dimensionsDetermine how buyers will access your productConfigure Quick LaunchUpdate availability by countryUpdate the refund policy of a productUpdate the end user license agreement (EULA) @@ -32,0 +33,2 @@ After you [create a software as a service (SaaS) product](./saas-create-product. + * Configure Quick Launch + @@ -305 +307 @@ To update the URL that is used to fulfill your SaaS product, use the **Update fu -### Configure Quick Launch +## Configure Quick Launch @@ -321 +323 @@ To configure the Quick Launch experience, the product must have either Limited o - 4. For **Account login details** , provide a URL for your site where the buyer can log in or create an account. This URL opens a new tab in the buyer experience. Buyers then sign in or create an account and return to AWS Marketplace to launch the template. + 4. For **Account login details** , provide a URL for your site where the buyer can log in or create an account. This URL opens a new tab in the buyer experience. Buyers then log in or create an account and return to AWS Marketplace to launch the template. @@ -331 +333 @@ For **AWS CloudFormation template** , choose the **Add AWS CloudFormation templa - * **Title** – Enter the name of your CloudFormation deployment. + * **Title** – Provide the name of your CloudFormation deployment. @@ -333 +335 @@ For **AWS CloudFormation template** , choose the **Add AWS CloudFormation templa - * **Description** – Enter a description of the template. + * **Description** – Provide a description of the template. @@ -335 +337 @@ For **AWS CloudFormation template** , choose the **Add AWS CloudFormation templa - * **Stack name** – Enter a name for the stack. This name is the stack name for the buyer in CloudFormation. + * **Stack name** – Provide a name for the stack. This name is the stack name for the buyer in CloudFormation. @@ -337 +339 @@ For **AWS CloudFormation template** , choose the **Add AWS CloudFormation templa - * **CloudFormation template URL** – Provide the Amazon Simple Storage Service (Amazon S3) URL for the template. AWS will review this template. + * **CloudFormation template URL** – Provide the Amazon Simple Storage Service will review this template. @@ -355 +357 @@ To simplify the launch process for your customers, we suggest minimizing the num -If your product requires seller-provided CloudFormation deployment parameters, such as API keys and [external IDs](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html), use the `PutDeploymentParameter` operation to share the parameter with your customers. For more information, see [PutDeploymentParameter](https://docs.aws.amazon.com/marketplace-deployment/latest/api-reference/API_PutDeploymentParameter.html) in the _AWS Marketplace Deployment Service API Reference_. +If your product requires seller-provided CloudFormation deployment parameters (for example, API keys and [external IDs](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html)), use the `PutDeploymentParameter` operation to share the parameter with your customers. For more information, see [PutDeploymentParameter](https://docs.aws.amazon.com/marketplace-deployment/latest/api-reference/API_PutDeploymentParameter.html) in the _AWS Marketplace Deployment Service API Reference_. @@ -361 +363,3 @@ If your product requires seller-provided CloudFormation deployment parameters, s - 8. (Optional) For **Allowlisted accounts for Quick Launch** , provide a comma-separated list of AWS accounts that can view the Quick Launch experience with **Limited** visibility. + 8. (Optional) For **Allowlisted accounts for Quick Launch** , provide a comma-separated list of AWS accounts that can view the Quick Launch experience with Limited visibility. + + 9. Choose the **Submit** button. The Quick Launch experience will have Limited visibility, meaning it will only be visible to your account and allowlisted accounts. With Limited visibility, you can test your configuration using the **Configure and launch** page after subscribing to your product and choosing the **Set up your account** button. @@ -363 +367 @@ If your product requires seller-provided CloudFormation deployment parameters, s - 9. Choose **Submit**. By default, the Quick Launch experience has **Limited** visibility. Only your account and any allowlisted accounts can view the page. You can use the **Configure and launch** page to test your configuration. To do that, you must first subscribe to your product and choose the **Set up your account** button. + * To preview the page from the buyer's perspective, choose **Preview**. Your configuration changes will reflect on the preview while both pages are open. @@ -367 +371 @@ If your product requires seller-provided CloudFormation deployment parameters, s -When you change the visibility to **Public** , the AWS Marketplace Seller Operations team reviews the configuration, conducts buyer testing, and publishes the experience. +When you change the visibility to Public, the AWS Marketplace Seller Operations team will review the configuration, conduct buyer testing, and publish the experience.