AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Associates the specified principal ARN with the specified portfolio.

If you share the portfolio with principal name sharing enabled, the PrincipalARN association is included in the share.

The PortfolioID, PrincipalARN, and PrincipalType parameters are required.

You can associate a maximum of 10 Principals with a portfolio using PrincipalType as IAM_PATTERN.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginAssociatePrincipalWithPortfolio and EndAssociatePrincipalWithPortfolio.

Namespace: Amazon.ServiceCatalog
Assembly: AWSSDK.ServiceCatalog.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<AssociatePrincipalWithPortfolioResponse> AssociatePrincipalWithPortfolioAsync(
         AssociatePrincipalWithPortfolioRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.ServiceCatalog.Model.AssociatePrincipalWithPortfolioRequest

Container for the necessary parameters to execute the AssociatePrincipalWithPortfolio service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the AssociatePrincipalWithPortfolio service method, as returned by ServiceCatalog.

Exceptions

ExceptionCondition
InvalidParametersException One or more parameters provided to the operation are not valid.
LimitExceededException The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
ResourceNotFoundException The specified resource was not found.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also