software.amazon.awscdk.services.servicecatalog

Class CfnPortfolioPrincipalAssociation

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.servicecatalog.CfnPortfolioPrincipalAssociation

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.72.0 (build 4b8828b)",
           date="2022-12-21T20:56:26.736Z")
 @Stability(value=Stable)
public class CfnPortfolioPrincipalAssociation
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ServiceCatalog::PortfolioPrincipalAssociation`.

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 AWS 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 AWS Service Catalog , they may be able to guess the user. If this potential escalation path is a concern, then AWS Service Catalog recommends using PrincipalType as IAM . With this configuration, the PrincipalARN must already exist in the recipient account before it can be associated.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.servicecatalog.*;
 CfnPortfolioPrincipalAssociation cfnPortfolioPrincipalAssociation = CfnPortfolioPrincipalAssociation.Builder.create(this, "MyCfnPortfolioPrincipalAssociation")
         .portfolioId("portfolioId")
         .principalArn("principalArn")
         .principalType("principalType")
         // the properties below are optional
         .acceptLanguage("acceptLanguage")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnPortfolioPrincipalAssociation.Builder A fluent builder for CfnPortfolioPrincipalAssociation.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPortfolioPrincipalAssociation(Construct scope, String id, CfnPortfolioPrincipalAssociationProps props) Create a new `AWS::ServiceCatalog::PortfolioPrincipalAssociation`.
protected	CfnPortfolioPrincipalAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPortfolioPrincipalAssociation(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAcceptLanguage() The language code.
protected Map<String,Object>	getCfnProperties()
String	getPortfolioId() The portfolio identifier.
String	getPrincipalArn() The ARN of the principal (IAM user, role, or group).
String	getPrincipalType() The principal type.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAcceptLanguage(String value) The language code.
void	setPortfolioId(String value) The portfolio identifier.
void	setPrincipalArn(String value) The ARN of the principal (IAM user, role, or group).
void	setPrincipalType(String value) The principal type.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnPortfolioPrincipalAssociation

protected CfnPortfolioPrincipalAssociation(software.amazon.jsii.JsiiObjectRef objRef)

CfnPortfolioPrincipalAssociation

protected CfnPortfolioPrincipalAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnPortfolioPrincipalAssociation

@Stability(value=Stable)
public CfnPortfolioPrincipalAssociation(@NotNull
                                                                 Construct scope,
                                                                 @NotNull
                                                                 String id,
                                                                 @NotNull
                                                                 CfnPortfolioPrincipalAssociationProps props)

Create a new `AWS::ServiceCatalog::PortfolioPrincipalAssociation`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getPortfolioId

@Stability(value=Stable)
 @NotNull
public String getPortfolioId()

The portfolio identifier.

setPortfolioId

@Stability(value=Stable)
public void setPortfolioId(@NotNull
                                                    String value)

The portfolio identifier.

getPrincipalArn

@Stability(value=Stable)
 @NotNull
public String getPrincipalArn()

The ARN of the principal (IAM user, role, or group).

This field allows an ARN with no accountID if PrincipalType is IAM_PATTERN .

You can associate multiple IAM patterns even if the account has no principal with that name. This is useful in Principal Name Sharing if you want to share a principal without creating it in the account that owns the portfolio.

setPrincipalArn

@Stability(value=Stable)
public void setPrincipalArn(@NotNull
                                                     String value)

The ARN of the principal (IAM user, role, or group).

This field allows an ARN with no accountID if PrincipalType is IAM_PATTERN .

You can associate multiple IAM patterns even if the account has no principal with that name. This is useful in Principal Name Sharing if you want to share a principal without creating it in the account that owns the portfolio.

getPrincipalType

@Stability(value=Stable)
 @NotNull
public String getPrincipalType()

The principal type.

The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you use an ARN with no accountID .

setPrincipalType

@Stability(value=Stable)
public void setPrincipalType(@NotNull
                                                      String value)

The principal type.

The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you use an ARN with no accountID .

getAcceptLanguage

@Stability(value=Stable)
 @Nullable
public String getAcceptLanguage()

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

setAcceptLanguage

@Stability(value=Stable)
public void setAcceptLanguage(@Nullable
                                                       String value)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese