portfolio_shares

Creates, updates, deletes, gets or lists a portfolio_shares resource.

Overview

Name	portfolio_shares
Type	Resource
Id	aws.servicecatalog.portfolio_shares

Fields

The following fields are returned by SELECT queries:

describe_portfolio_shares

Name	Datatype	Description
next_page_token	string	The page token to use to retrieve the next set of results. If there are no additional results, this value is null. (pattern: <code>[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*</code>)
portfolio_share_details	array	Summaries about each of the portfolio shares.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_portfolio_shares	select	region		Returns a summary of each of the portfolio shares that were created for the specified portfolio. You can use this API to determine which accounts or organizational nodes this portfolio have been shared, whether the recipient entity has imported the share, and whether TagOptions are included with the share. The PortfolioId and Type parameters are both required.
create_portfolio_share	insert	region, PortfolioId		Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the management account of an organization or by a delegated administrator. You can share portfolios to an organization, an organizational unit, or a specific account. Note that if a delegated admin is de-registered, they can no longer create portfolio shares. AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node. You can't share a shared resource, including portfolios that contain a shared product. If the portfolio share with the specified account or organization node already exists, this action will have no effect and will not return an error. To update an existing share, you must use the UpdatePortfolioShare API instead. When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using PrincipalType as IAM. With this configuration, the PrincipalARN must already exist in the recipient account before it can be associated.
update_portfolio_share	update	region, PortfolioId		Updates the specified portfolio share. You can use this API to enable or disable TagOptions sharing or Principal sharing for an existing portfolio share. The portfolio share cannot be updated if the CreatePortfolioShare operation is IN_PROGRESS, as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be completed. You must provide the accountId or organization node in the input, but not both. If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke UpdatePortfolioShare separately for each share type. This API cannot be used for removing the portfolio share. You must use DeletePortfolioShare API for that action. When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using PrincipalType as IAM. With this configuration, the PrincipalARN must already exist in the recipient account before it can be associated.
delete_portfolio_share	delete	region		Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the management account of an organization or by a delegated administrator. Note that if a delegated admin is de-registered, portfolio shares created from that account are removed.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_portfolio_shares

Returns a summary of each of the portfolio shares that were created for the specified portfolio. You can use this API to determine which accounts or organizational nodes this portfolio have been shared, whether the recipient entity has imported the share, and whether TagOptions are included with the share. The PortfolioId and Type parameters are both required.

SELECT
next_page_token,
portfolio_share_details
FROM aws.servicecatalog.portfolio_shares
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_portfolio_share

Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the management account of an organization or by a delegated administrator. You can share portfolios to an organization, an organizational unit, or a specific account. Note that if a delegated admin is de-registered, they can no longer create portfolio shares. AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node. You can't share a shared resource, including portfolios that contain a shared product. If the portfolio share with the specified account or organization node already exists, this action will have no effect and will not return an error. To update an existing share, you must use the UpdatePortfolioShare API instead. When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using PrincipalType as IAM. With this configuration, the PrincipalARN must already exist in the recipient account before it can be associated.

INSERT INTO aws.servicecatalog.portfolio_shares (
AcceptLanguage,
PortfolioId,
AccountId,
OrganizationNode,
ShareTagOptions,
SharePrincipals,
region
)
SELECT 
'{{ AcceptLanguage }}',
'{{ PortfolioId }}' /* required */,
'{{ AccountId }}',
'{{ OrganizationNode }}',
{{ ShareTagOptions }},
{{ SharePrincipals }},
'{{ region }}'
RETURNING
portfolio_share_token
;

Manifest

# Description fields are for documentation purposes
- name: portfolio_shares
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the portfolio_shares resource.
  - name: AcceptLanguage
    value: "{{ AcceptLanguage }}"
    description: |
      The language code. jp - Japanese zh - Chinese
  - name: PortfolioId
    value: "{{ PortfolioId }}"
    description: |
      The portfolio identifier.
  - name: AccountId
    value: "{{ AccountId }}"
    description: |
      The Amazon Web Services account ID. For example, 123456789012.
  - name: OrganizationNode
    description: |
      The organization node to whom you are going to share. When you pass OrganizationNode, it creates PortfolioShare for all of the Amazon Web Services accounts that are associated to the OrganizationNode. The output returns a PortfolioShareToken, which enables the administrator to monitor the status of the PortfolioShare creation process.
    value:
      Type: "{{ Type }}"
      Value: "{{ Value }}"
  - name: ShareTagOptions
    value: {{ ShareTagOptions }}
    description: |
      Enables or disables TagOptions sharing when creating the portfolio share. If this flag is not provided, TagOptions sharing is disabled.
  - name: SharePrincipals
    value: {{ SharePrincipals }}
    description: |
      This parameter is only supported for portfolios with an OrganizationalNode Type of ORGANIZATION or ORGANIZATIONAL_UNIT. Enables or disables Principal sharing when creating the portfolio share. If you do not provide this flag, principal sharing is disabled. When you enable Principal Name Sharing for a portfolio share, the share recipient account end users with a principal that matches any of the associated IAM patterns can provision products from the portfolio. Once shared, the share recipient can view associations of PrincipalType: IAM_PATTERN on their portfolio. You can create the principals in the recipient account before or after creating the share.

UPDATE examples

update_portfolio_share

Updates the specified portfolio share. You can use this API to enable or disable TagOptions sharing or Principal sharing for an existing portfolio share. The portfolio share cannot be updated if the CreatePortfolioShare operation is IN_PROGRESS, as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be completed. You must provide the accountId or organization node in the input, but not both. If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke UpdatePortfolioShare separately for each share type. This API cannot be used for removing the portfolio share. You must use DeletePortfolioShare API for that action. When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using PrincipalType as IAM. With this configuration, the PrincipalARN must already exist in the recipient account before it can be associated.

UPDATE aws.servicecatalog.portfolio_shares
SET 
AcceptLanguage = '{{ AcceptLanguage }}',
PortfolioId = '{{ PortfolioId }}',
AccountId = '{{ AccountId }}',
OrganizationNode = '{{ OrganizationNode }}',
ShareTagOptions = {{ ShareTagOptions }},
SharePrincipals = {{ SharePrincipals }}
WHERE 
region = '{{ region }}' --required
AND PortfolioId = '{{ PortfolioId }}' --required
RETURNING
portfolio_share_token,
status;

DELETE examples

delete_portfolio_share

Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the management account of an organization or by a delegated administrator. Note that if a delegated admin is de-registered, portfolio shares created from that account are removed.

DELETE FROM aws.servicecatalog.portfolio_shares
WHERE region = '{{ region }}' --required
;