software.amazon.awscdk.services.servicecatalog

Class CfnPortfolio

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.CfnPortfolio

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.087Z")
 @Stability(value=Stable)
public class CfnPortfolio
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ServiceCatalog::Portfolio`.

Specifies a portfolio.

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.*;
 CfnPortfolio cfnPortfolio = CfnPortfolio.Builder.create(this, "MyCfnPortfolio")
         .displayName("displayName")
         .providerName("providerName")
         // the properties below are optional
         .acceptLanguage("acceptLanguage")
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.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
	CfnPortfolio(software.constructs.Construct scope, String id, CfnPortfolioProps props) Create a new `AWS::ServiceCatalog::Portfolio`.
protected	CfnPortfolio(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPortfolio(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAcceptLanguage() The language code.
String	getAttrPortfolioName() The name of the portfolio.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the portfolio.
String	getDisplayName() The name to use for display purposes.
String	getProviderName() The name of the portfolio provider.
TagManager	getTags() One or more tags.
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	setDescription(String value) The description of the portfolio.
void	setDisplayName(String value) The name to use for display purposes.
void	setProviderName(String value) The name of the portfolio provider.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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.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

CfnPortfolio

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

CfnPortfolio

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

CfnPortfolio

@Stability(value=Stable)
public CfnPortfolio(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             CfnPortfolioProps props)

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

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.

getAttrPortfolioName

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

The name of the portfolio.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

One or more tags.

getDisplayName

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

The name to use for display purposes.

setDisplayName

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

The name to use for display purposes.

getProviderName

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

The name of the portfolio provider.

setProviderName

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

The name of the portfolio provider.

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

getDescription

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

The description of the portfolio.

setDescription

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

The description of the portfolio.