/AWS1/CL_SCG=>CREATEPORTFOLIOSHARE()
¶
About CreatePortfolioShare¶
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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_PORTFOLIOID
TYPE /AWS1/SCGID
/AWS1/SCGID
¶
The portfolio identifier.
Optional arguments:¶
IV_ACCEPTLANGUAGE
TYPE /AWS1/SCGACCEPTLANGUAGE
/AWS1/SCGACCEPTLANGUAGE
¶
The language code.
jp
- Japanese
zh
- Chinese
IV_ACCOUNTID
TYPE /AWS1/SCGACCOUNTID
/AWS1/SCGACCOUNTID
¶
The Amazon Web Services account ID. For example,
123456789012
.
IO_ORGANIZATIONNODE
TYPE REF TO /AWS1/CL_SCGORGANIZATIONNODE
/AWS1/CL_SCGORGANIZATIONNODE
¶
The organization node to whom you are going to share. When you pass
OrganizationNode
, it createsPortfolioShare
for all of the Amazon Web Services accounts that are associated to theOrganizationNode
. The output returns aPortfolioShareToken
, which enables the administrator to monitor the status of thePortfolioShare
creation process.
IV_SHARETAGOPTIONS
TYPE /AWS1/SCGBOOLEAN
/AWS1/SCGBOOLEAN
¶
Enables or disables
TagOptions
sharing when creating the portfolio share. If this flag is not provided, TagOptions sharing is disabled.
IV_SHAREPRINCIPALS
TYPE /AWS1/SCGBOOLEAN
/AWS1/SCGBOOLEAN
¶
This parameter is only supported for portfolios with an OrganizationalNode Type of
ORGANIZATION
orORGANIZATIONAL_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.