AWS Service Catalog Portfolio Share

This page shows how to write Terraform and CloudFormation for AWS Service Catalog Portfolio Share and write them securely.

aws_servicecatalog_portfolio_share (Terraform)

The Portfolio Share in AWS Service Catalog can be configured in Terraform with the resource name aws_servicecatalog_portfolio_share. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Parameters

The following arguments are required:

  • portfolio_id - (Required) Portfolio identifier.
  • principal_id - (Required) Identifier of the principal with whom you will share the portfolio. Valid values AWS account IDs and ARNs of AWS Organizations and organizational units.
  • type - (Required) Type of portfolio share. Valid values are ACCOUNT (an external account), ORGANIZATION (a share to every account in an organization), ORGANIZATIONAL_UNIT, ORGANIZATION_MEMBER_ACCOUNT (a share to an account in an organization).

The following arguments are optional:

  • accept_language - (Optional) Language code. Valid values: en (English), jp (Japanese), zh (Chinese). Default value is en.
  • share_tag_options - (Optional) Whether to enable sharing of aws_servicecatalog_tag_option resources when creating the portfolio share.
  • wait_for_acceptance - (Optional) Whether to wait (up to the timeout) for the share to be accepted. Organizational shares are automatically accepted.

In addition to all arguments above, the following attributes are exported:

  • accepted - Whether the shared portfolio is imported by the recipient account. If the recipient is organizational, the share is automatically imported, and the field is always set to true.

Explanation in Terraform Registry

Manages a Service Catalog Portfolio Share. Shares the specified portfolio with the specified account or organization node. You can share portfolios to an organization, an organizational unit, or a specific account. If the portfolio share with the specified account or organization node already exists, using this resource to re-create the share will have no effect and will not return an error. You can then use this resource to update the share.

NOTE: Shares to an organization node can only be created by the management account of an organization or by a delegated administrator. If a delegated admin is de-registered, they can no longer create portfolio shares. NOTE: AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node. NOTE: You can't share a shared resource, including portfolios that contain a shared product.

AWS::ServiceCatalog::PortfolioShare (CloudFormation)

The PortfolioShare in ServiceCatalog can be configured in CloudFormation with the resource name AWS::ServiceCatalog::PortfolioShare. The following sections describe how to use the resource and its parameters.

Parameters

Explanation in CloudFormation Registry

Shares the specified portfolio with the specified account.

Frequently asked questions

What is AWS Service Catalog Portfolio Share?

AWS Service Catalog Portfolio Share is a resource for Service Catalog of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.