Class Portfolio
A Service Catalog portfolio.
Inherited Members
Namespace: Amazon.CDK.AWS.ServiceCatalog
Assembly: Amazon.CDK.AWS.ServiceCatalog.dll
Syntax (csharp)
public class Portfolio : Resource, IPortfolio, IResource, IConstruct, IDependable
Syntax (vb)
Public Class Portfolio
Inherits Resource
Implements IPortfolio, IResource, IConstruct, IDependable
Remarks
ExampleMetadata: infused
Examples
new Portfolio(this, "Portfolio", new PortfolioProps {
DisplayName = "MyPortfolio",
ProviderName = "MyTeam"
});
Synopsis
Constructors
Portfolio(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
Portfolio(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Portfolio(Construct, String, IPortfolioProps) |
Properties
PortfolioArn | The ARN of the portfolio. |
PortfolioId | The ID of the portfolio. |
Methods
AddProduct(IProduct) | Associate portfolio with the given product. |
AssociateTagOptions(TagOptions) | Associate Tag Options. |
ConstrainCloudFormationParameters(IProduct, ICloudFormationRuleConstraintOptions) | Set provisioning rules for the product. |
ConstrainTagUpdates(IProduct, ITagUpdateConstraintOptions) | Add a Resource Update Constraint. |
DeployWithStackSets(IProduct, IStackSetsConstraintOptions) | Configure deployment options using AWS Cloudformation StackSets. |
FromPortfolioArn(Construct, String, String) | Creates a Portfolio construct that represents an external portfolio. |
GenerateUniqueHash(String) | Create a unique id based off the L1 CfnPortfolio or the arn of an imported portfolio. |
GiveAccessToGroup(IGroup) | Associate portfolio with an IAM Group. |
GiveAccessToRole(IRole) | Associate portfolio with an IAM Role. |
GiveAccessToUser(IUser) | Associate portfolio with an IAM User. |
NotifyOnStackEvents(IProduct, ITopic, ICommonConstraintOptions) | Add notifications for supplied topics on the provisioned product. |
SetLaunchRole(IProduct, IRole, ICommonConstraintOptions) | Force users to assume a certain role when launching a product. |
SetLocalLaunchRole(IProduct, IRole, ICommonConstraintOptions) | Force users to assume a certain role when launching a product. |
SetLocalLaunchRoleName(IProduct, String, ICommonConstraintOptions) | Force users to assume a certain role when launching a product. |
ShareWithAccount(String, IPortfolioShareOptions) | Initiate a portfolio share with another account. |
Constructors
Portfolio(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected Portfolio(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
Portfolio(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected Portfolio(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Portfolio(Construct, String, IPortfolioProps)
public Portfolio(Construct scope, string id, IPortfolioProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props IPortfolioProps
Properties
PortfolioArn
The ARN of the portfolio.
public virtual string PortfolioArn { get; }
Property Value
System.String
PortfolioId
The ID of the portfolio.
public virtual string PortfolioId { get; }
Property Value
System.String
Methods
AddProduct(IProduct)
Associate portfolio with the given product.
public virtual void AddProduct(IProduct product)
Parameters
- product IProduct
AssociateTagOptions(TagOptions)
Associate Tag Options.
public virtual void AssociateTagOptions(TagOptions tagOptions)
Parameters
- tagOptions TagOptions
Remarks
A TagOption is a key-value pair managed in AWS Service Catalog. It is not an AWS tag, but serves as a template for creating an AWS tag based on the TagOption.
ConstrainCloudFormationParameters(IProduct, ICloudFormationRuleConstraintOptions)
Set provisioning rules for the product.
public virtual void ConstrainCloudFormationParameters(IProduct product, ICloudFormationRuleConstraintOptions options)
Parameters
- product IProduct
- options ICloudFormationRuleConstraintOptions
ConstrainTagUpdates(IProduct, ITagUpdateConstraintOptions)
Add a Resource Update Constraint.
public virtual void ConstrainTagUpdates(IProduct product, ITagUpdateConstraintOptions options = null)
Parameters
- product IProduct
- options ITagUpdateConstraintOptions
DeployWithStackSets(IProduct, IStackSetsConstraintOptions)
Configure deployment options using AWS Cloudformation StackSets.
public virtual void DeployWithStackSets(IProduct product, IStackSetsConstraintOptions options)
Parameters
- product IProduct
- options IStackSetsConstraintOptions
FromPortfolioArn(Construct, String, String)
Creates a Portfolio construct that represents an external portfolio.
public static IPortfolio FromPortfolioArn(Construct scope, string id, string portfolioArn)
Parameters
- scope Constructs.Construct
The parent creating construct (usually
this
).- id System.String
The construct's name.
- portfolioArn System.String
the Amazon Resource Name of the existing portfolio.
Returns
GenerateUniqueHash(String)
Create a unique id based off the L1 CfnPortfolio or the arn of an imported portfolio.
protected virtual string GenerateUniqueHash(string value)
Parameters
- value System.String
Returns
System.String
GiveAccessToGroup(IGroup)
Associate portfolio with an IAM Group.
public virtual void GiveAccessToGroup(IGroup group)
Parameters
- group IGroup
GiveAccessToRole(IRole)
Associate portfolio with an IAM Role.
public virtual void GiveAccessToRole(IRole role)
Parameters
- role IRole
GiveAccessToUser(IUser)
Associate portfolio with an IAM User.
public virtual void GiveAccessToUser(IUser user)
Parameters
- user IUser
NotifyOnStackEvents(IProduct, ITopic, ICommonConstraintOptions)
Add notifications for supplied topics on the provisioned product.
public virtual void NotifyOnStackEvents(IProduct product, ITopic topic, ICommonConstraintOptions options = null)
Parameters
- product IProduct
- topic ITopic
- options ICommonConstraintOptions
SetLaunchRole(IProduct, IRole, ICommonConstraintOptions)
Force users to assume a certain role when launching a product.
public virtual void SetLaunchRole(IProduct product, IRole launchRole, ICommonConstraintOptions options = null)
Parameters
- product IProduct
- launchRole IRole
- options ICommonConstraintOptions
Remarks
This sets the launch role using the role arn which is tied to the account this role exists in. This is useful if you will be provisioning products from the account where this role exists. If you intend to share the portfolio across accounts, use a local launch role.
SetLocalLaunchRole(IProduct, IRole, ICommonConstraintOptions)
Force users to assume a certain role when launching a product.
public virtual void SetLocalLaunchRole(IProduct product, IRole launchRole, ICommonConstraintOptions options = null)
Parameters
- product IProduct
- launchRole IRole
- options ICommonConstraintOptions
Remarks
The role name will be referenced by in the local account and must be set explicitly. This is useful when sharing the portfolio with multiple accounts.
SetLocalLaunchRoleName(IProduct, String, ICommonConstraintOptions)
Force users to assume a certain role when launching a product.
public virtual IRole SetLocalLaunchRoleName(IProduct product, string launchRoleName, ICommonConstraintOptions options = null)
Parameters
- product IProduct
- launchRoleName System.String
- options ICommonConstraintOptions
Returns
Remarks
The role will be referenced by name in the local account instead of a static role arn. A role with this name will automatically be created and assumable by Service Catalog in this account. This is useful when sharing the portfolio with multiple accounts.
ShareWithAccount(String, IPortfolioShareOptions)
Initiate a portfolio share with another account.
public virtual void ShareWithAccount(string accountId, IPortfolioShareOptions options = null)
Parameters
- accountId System.String
- options IPortfolioShareOptions