awslabs / landing-zone-accelerator-on-aws

Deploy a multi-account cloud foundation to support highly-regulated workloads and complex compliance requirements.
https://aws.amazon.com/solutions/implementations/landing-zone-accelerator-on-aws/
Apache License 2.0
566 stars 454 forks source link

Service Catalog - Incorrect typing in documentation #305

Open joshuahigginson1 opened 1 year ago

joshuahigginson1 commented 1 year ago

Describe the bug

Documentation regarding the Landing Zone Accelerator Service Catalog 'Launch Constraints' describes possible options for the 'Launch Constraint Type' as:

      constraints:
        # Specify an explicit IAM role that AWS Service Catalog will assume, to
        # deploy, update, or terminate a product.
        launch:
          type: Role | localRole

When running a pipeline with localRole set, a CFN validation error is raised.

Please update references from 'localRole' to 'LocalRole' in your documentation.

To Reproduce Run an AWS Landing Zone Accelerator customization with the launch constraint type 'localRole', as specified in documentation.

Expected behavior Build pipeline should NOT fail. Please complete the following information about the solution:

To get the version of the solution, you can look at the description of the created AWS CloudFormation stack used to install the LZA (AWSAccelerator-InstallerStack). For example, "(SO0199) Landing Zone Accelerator on AWS. Version 1.5.1.". If the description does not contain the version information, you can look at the Parameters of the stack for the RepositoryBranchName as that should contain the version number.

Screenshots If applicable, add screenshots to help explain your problem (please DO NOT include sensitive information).

Additional context Add any other context about the problem here.

KittieHearts42 commented 10 months ago

image I have received the same error in 1.6.0 LZA, please update documentation to correct LocalRole