software.amazon.awscdk.services.servicecatalog

Class CfnCloudFormationProduct

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

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.066Z")
 @Stability(value=Stable)
public class CfnCloudFormationProduct
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ServiceCatalog::CloudFormationProduct`.

Specifies a product.

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.*;
 Object info;
 CfnCloudFormationProduct cfnCloudFormationProduct = CfnCloudFormationProduct.Builder.create(this, "MyCfnCloudFormationProduct")
         .name("name")
         .owner("owner")
         .provisioningArtifactParameters(List.of(ProvisioningArtifactPropertiesProperty.builder()
                 .info(info)
                 // the properties below are optional
                 .description("description")
                 .disableTemplateValidation(false)
                 .name("name")
                 .build()))
         // the properties below are optional
         .acceptLanguage("acceptLanguage")
         .description("description")
         .distributor("distributor")
         .replaceProvisioningArtifacts(false)
         .supportDescription("supportDescription")
         .supportEmail("supportEmail")
         .supportUrl("supportUrl")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnCloudFormationProduct.Builder A fluent builder for CfnCloudFormationProduct.
static interface	CfnCloudFormationProduct.ProvisioningArtifactPropertiesProperty Information about a provisioning artifact (also known as a version) for a product.

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

Method Summary

Modifier and Type	Method and Description
String	getAcceptLanguage() The language code.
String	getAttrProductName() The name of the product.
String	getAttrProvisioningArtifactIds() The IDs of the provisioning artifacts.
String	getAttrProvisioningArtifactNames() The names of the provisioning artifacts.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the product.
String	getDistributor() The distributor of the product.
String	getName() The name of the product.
String	getOwner() The owner of the product.
Object	getProvisioningArtifactParameters() The configuration of the provisioning artifact (also known as a version).
Object	getReplaceProvisioningArtifacts() This property is turned off by default.
String	getSupportDescription() The support information about the product.
String	getSupportEmail() The contact email for product support.
String	getSupportUrl() The contact URL for product support.
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 product.
void	setDistributor(String value) The distributor of the product.
void	setName(String value) The name of the product.
void	setOwner(String value) The owner of the product.
void	setProvisioningArtifactParameters(IResolvable value) The configuration of the provisioning artifact (also known as a version).
void	setProvisioningArtifactParameters(List<Object> value) The configuration of the provisioning artifact (also known as a version).
void	setReplaceProvisioningArtifacts(Boolean value) This property is turned off by default.
void	setReplaceProvisioningArtifacts(IResolvable value) This property is turned off by default.
void	setSupportDescription(String value) The support information about the product.
void	setSupportEmail(String value) The contact email for product support.
void	setSupportUrl(String value) The contact URL for product support.

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

CfnCloudFormationProduct

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

CfnCloudFormationProduct

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

CfnCloudFormationProduct

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

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

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.

getAttrProductName

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

The name of the product.

getAttrProvisioningArtifactIds

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

The IDs of the provisioning artifacts.

getAttrProvisioningArtifactNames

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

The names of the provisioning artifacts.

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.

getName

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

The name of the product.

setName

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

The name of the product.

getOwner

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

The owner of the product.

setOwner

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

The owner of the product.

getProvisioningArtifactParameters

@Stability(value=Stable)
 @NotNull
public Object getProvisioningArtifactParameters()

The configuration of the provisioning artifact (also known as a version).

setProvisioningArtifactParameters

@Stability(value=Stable)
public void setProvisioningArtifactParameters(@NotNull
                                                                       IResolvable value)

The configuration of the provisioning artifact (also known as a version).

setProvisioningArtifactParameters

@Stability(value=Stable)
public void setProvisioningArtifactParameters(@NotNull
                                                                       List<Object> value)

The configuration of the provisioning artifact (also known as a version).

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

setDescription

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

The description of the product.

getDistributor

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

The distributor of the product.

setDistributor

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

The distributor of the product.

getReplaceProvisioningArtifacts

@Stability(value=Stable)
 @Nullable
public Object getReplaceProvisioningArtifacts()

This property is turned off by default.

If turned off, you can update provisioning artifacts or product attributes (such as description, distributor, name, owner, and more) and the associated provisioning artifacts will retain the same unique identifier. Provisioning artifacts are matched within the CloudFormationProduct resource, and only those that have been updated will be changed. Provisioning artifacts are matched by a combinaton of provisioning artifact template URL and name.

If turned on, provisioning artifacts will be given a new unique identifier when you update the product or provisioning artifacts.

setReplaceProvisioningArtifacts

@Stability(value=Stable)
public void setReplaceProvisioningArtifacts(@Nullable
                                                                     Boolean value)

This property is turned off by default.

If turned off, you can update provisioning artifacts or product attributes (such as description, distributor, name, owner, and more) and the associated provisioning artifacts will retain the same unique identifier. Provisioning artifacts are matched within the CloudFormationProduct resource, and only those that have been updated will be changed. Provisioning artifacts are matched by a combinaton of provisioning artifact template URL and name.

If turned on, provisioning artifacts will be given a new unique identifier when you update the product or provisioning artifacts.

setReplaceProvisioningArtifacts

@Stability(value=Stable)
public void setReplaceProvisioningArtifacts(@Nullable
                                                                     IResolvable value)

This property is turned off by default.

If turned off, you can update provisioning artifacts or product attributes (such as description, distributor, name, owner, and more) and the associated provisioning artifacts will retain the same unique identifier. Provisioning artifacts are matched within the CloudFormationProduct resource, and only those that have been updated will be changed. Provisioning artifacts are matched by a combinaton of provisioning artifact template URL and name.

If turned on, provisioning artifacts will be given a new unique identifier when you update the product or provisioning artifacts.

getSupportDescription

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

The support information about the product.

setSupportDescription

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

The support information about the product.

getSupportEmail

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

The contact email for product support.

setSupportEmail

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

The contact email for product support.

getSupportUrl

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

The contact URL for product support.

^https?:\/\// / is the pattern used to validate SupportUrl.

setSupportUrl

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

The contact URL for product support.

^https?:\/\// / is the pattern used to validate SupportUrl.