Package software.amazon.awscdk.services.servicecatalog

Class CfnPortfolioShare

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.servicecatalog.CfnPortfolioShare

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:17.988Z")
@Stability(Stable)
public class CfnPortfolioShare
extends CfnResource
implements IInspectable, IPortfolioShareRef

Shares the specified portfolio with the specified account.

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.*;
 CfnPortfolioShare cfnPortfolioShare = CfnPortfolioShare.Builder.create(this, "MyCfnPortfolioShare")
         .accountId("accountId")
         .portfolioId("portfolioId")
         // the properties below are optional
         .acceptLanguage("acceptLanguage")
         .shareTagOptions(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioshare.html

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.servicecatalog.IPortfolioShareRef

IPortfolioShareRef.Jsii$Default, IPortfolioShareRef.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnPortfolioShare(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPortfolioShare(software.amazon.jsii.JsiiObjectRef objRef)
	CfnPortfolioShare(software.constructs.Construct scope, String id, CfnPortfolioShareProps props)	Create a new AWS::ServiceCatalog::PortfolioShare.

Method Summary

Modifier and Type	Method	Description
String	getAcceptLanguage()	The language code.
String	getAccountId()	The AWS account ID.
protected Map<String,Object>	getCfnProperties()
String	getPortfolioId()	The portfolio identifier.
PortfolioShareReference	getPortfolioShareRef()	A reference to a PortfolioShare resource.
Object	getShareTagOptions()	Indicates whether TagOptions sharing is enabled or disabled for the portfolio share.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnPortfolioShare(Object x)	Checks whether the given object is a CfnPortfolioShare.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAcceptLanguage(String value)	The language code.
void	setAccountId(String value)	The AWS account ID.
void	setPortfolioId(String value)	The portfolio identifier.
void	setShareTagOptions(Boolean value)	Indicates whether TagOptions sharing is enabled or disabled for the portfolio share.
void	setShareTagOptions(IResolvable value)	Indicates whether TagOptions sharing is enabled or disabled for the portfolio share.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnPortfolioShare

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

CfnPortfolioShare

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

CfnPortfolioShare

@Stability(Stable)
public CfnPortfolioShare(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnPortfolioShareProps props)

Create a new AWS::ServiceCatalog::PortfolioShare.

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

isCfnPortfolioShare

@Stability(Stable)
@NotNull
public static Boolean isCfnPortfolioShare(@NotNull
 Object x)

Checks whether the given object is a CfnPortfolioShare.

Parameters:

x - This parameter is required.

inspect

@Stability(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(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(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getPortfolioShareRef

@Stability(Stable)
@NotNull
public PortfolioShareReference getPortfolioShareRef()

A reference to a PortfolioShare resource.

Specified by:

getPortfolioShareRef in interface IPortfolioShareRef

getAccountId

@Stability(Stable)
@NotNull
public String getAccountId()

The AWS account ID.

setAccountId

@Stability(Stable)
public void setAccountId(@NotNull
 String value)

The AWS account ID.

getPortfolioId

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

The portfolio identifier.

setPortfolioId

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

The portfolio identifier.

getAcceptLanguage

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

The language code.

setAcceptLanguage

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

The language code.

getShareTagOptions

@Stability(Stable)
@Nullable
public Object getShareTagOptions()

Indicates whether TagOptions sharing is enabled or disabled for the portfolio share.

Returns union: either Boolean or IResolvable

setShareTagOptions

@Stability(Stable)
public void setShareTagOptions(@Nullable
 Boolean value)

Indicates whether TagOptions sharing is enabled or disabled for the portfolio share.

setShareTagOptions

@Stability(Stable)
public void setShareTagOptions(@Nullable
 IResolvable value)

Indicates whether TagOptions sharing is enabled or disabled for the portfolio share.