@aws-accelerator/config
    Preparing search index...

    Interface IPortfolioConfig

    CustomizationsConfig / CustomizationConfig / PortfolioConfig

    A Service Catalog portfolio — a collection of products that you share with IAM principals or organizational units, so the people in those accounts can launch the products.

    Portfolios are listed under customizations.serviceCatalogPortfolios in the customizations config file.

    customizations:
      serviceCatalogPortfolios:
        - name: accelerator-portfolio
          provider: landing-zone-accelerator
          account: Management
          regions:
            - us-east-1
          shareTargets:
            organizationalUnits:
              - Root
          shareTagOptions: true
          portfolioAssociations:
            - type: Group
              name: Administrators
          products:
            - name: EncryptedS3Bucket
              description: Deploys an S3 bucket with SSE-KMS encryption enabled.
              owner: Cloud-Platform-Team
              constraints:
                launch:
                  type: Role
                  role: ServiceCatalogLaunchRole
                tagUpdate: true
                notifications:
                  - ProductLaunchNotifications
              versions:
                - name: v1
                  description: Initial release
                  template: service-catalog/templates/encrypted-s3-bucket.yaml
          tagOptions:
            - key: Environment
              values: [Dev, Test, Prod]
    interface IPortfolioConfig {
        name: string;
        account: string;
        regions: string[];
        provider: string;
        portfolioAssociations?: IPortfolioAssociatoinConfig[];
        products?: IProductConfig[];
        shareTargets?: IShareTargets;
        shareTagOptions?: boolean;
        tagOptions?: ITagOptionsConfig[];
    }
    Index

    Properties

    name account regions provider portfolioAssociations? products? shareTargets? shareTagOptions? tagOptions?

    Properties

    name: string

    The portfolio name users see in the Service Catalog console. 1 to 100 characters.

    account: string

    The LZA friendly name of the account where the portfolio is created. Must match an entry in accounts-config.yaml.

    regions: string[]

    The regions to create the portfolio in (for example, us-east-1). The portfolio and its products are deployed independently in each region.

    provider: string

    The team or organization that owns the portfolio. Shown in the Service Catalog console so users know who's behind it. 1 to 50 characters.

    portfolioAssociations?: IPortfolioAssociatoinConfig[]

    IAM principals that should have access to view and launch the products in this portfolio. See PortfolioAssociationConfig.

    products?: IProductConfig[]

    The products to create inside this portfolio. See ProductConfig.

    shareTargets?: IShareTargets

    The accounts and organizational units you want to share this portfolio with. Once shared, admins in each recipient account can give their own users access. See IShareTargets.

    Sharing with organizational units only works when the portfolio lives in the Management account. Use LZA friendly names, not AWS account IDs or OU IDs.

    shareTagOptions?: boolean

    Set to true to also share this portfolio's TagOptions with every shared-to account. Has no effect unless shareTargets is set. Defaults to false.

    tagOptions?: ITagOptionsConfig[]

    TagOptions attached to the portfolio itself. Every product in the portfolio picks these up. See TagOptionsConfig.

    Settings

    Member Visibility

    On This Page

    Properties