Skip to content

/AWS1/IF_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

METHODS /AWS1/IF_SCG~CREATEPORTFOLIOSHARE
  IMPORTING
    !IV_ACCEPTLANGUAGE TYPE /AWS1/SCGACCEPTLANGUAGE OPTIONAL
    !IV_PORTFOLIOID TYPE /AWS1/SCGID OPTIONAL
    !IV_ACCOUNTID TYPE /AWS1/SCGACCOUNTID OPTIONAL
    !IO_ORGANIZATIONNODE TYPE REF TO /AWS1/CL_SCGORGANIZATIONNODE OPTIONAL
    !IV_SHARETAGOPTIONS TYPE /AWS1/SCGBOOLEAN OPTIONAL
    !IV_SHAREPRINCIPALS TYPE /AWS1/SCGBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_scgcreportfolioshar01
  RAISING
    /AWS1/CX_SCGINVALIDPARAMSEX
    /AWS1/CX_SCGINVALIDSTATEEX
    /AWS1/CX_SCGLIMITEXCEEDEDEX
    /AWS1/CX_SCGOPNOTSUPPORTEDEX
    /AWS1/CX_SCGRESOURCENOTFOUNDEX
    /AWS1/CX_SCGCLIENTEXC
    /AWS1/CX_SCGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

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 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.

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 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.

RETURNING

oo_output TYPE REF TO /aws1/cl_scgcreportfolioshar01 /AWS1/CL_SCGCREPORTFOLIOSHAR01

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createportfolioshare(
  io_organizationnode = new /aws1/cl_scgorganizationnode(
    iv_type = |string|
    iv_value = |string|
  )
  iv_acceptlanguage = |string|
  iv_accountid = |string|
  iv_portfolioid = |string|
  iv_shareprincipals = ABAP_TRUE
  iv_sharetagoptions = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_id = lo_result->get_portfoliosharetoken( ).
ENDIF.