Associates the specified principal ARN with the specified portfolio.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::ServiceCatalog::PortfolioPrincipalAssociation",
"Properties" : {
"AcceptLanguage" : String
,
"PortfolioId" : String
,
"PrincipalARN" : String
,
"PrincipalType" : String
}
}
YAML
Type: AWS::ServiceCatalog::PortfolioPrincipalAssociation
Properties:
AcceptLanguage: String
PortfolioId: String
PrincipalARN: String
PrincipalType: String
Properties
AcceptLanguage
-
The language code.
-
jp
- Japanese -
zh
- Chinese
Required: No
Type: String
Maximum:
100
Update requires: Replacement
-
PortfolioId
-
The portfolio identifier.
Required: Yes
Type: String
Pattern:
^[a-zA-Z0-9_\-]*
Minimum:
1
Maximum:
100
Update requires: Replacement
PrincipalARN
-
The ARN of the principal (IAM user, role, or group).
Required: Yes
Type: String
Minimum:
1
Maximum:
1000
Update requires: Replacement
PrincipalType
-
The principal type. The supported values are
IAM
andIAM_PATTERN
.Required: Yes
Type: String
Allowed values:
IAM | IAM_PATTERN
Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns a unique identifier for the association.
For more information about using the Ref
function, see Ref
.
Fn::GetAtt
See also
-
AssociatePrincipalWithPortfolio in the AWS Service Catalog API Reference