software.amazon.awscdk.services.servicecatalog

Class CfnCloudFormationProduct

java.lang.Object

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:53.661Z")
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 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 java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

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

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 java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnCloudFormationProduct(Construct scope,
                                java.lang.String id,
                                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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrProductName

public java.lang.String getAttrProductName()

The name of the product.

getAttrProvisioningArtifactIds

public java.lang.String getAttrProvisioningArtifactIds()

The IDs of the provisioning artifacts.

getAttrProvisioningArtifactNames

public java.lang.String getAttrProvisioningArtifactNames()

The names of the provisioning artifacts.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

One or more tags.

getName

public java.lang.String getName()

The name of the product.

setName

public void setName(java.lang.String value)

The name of the product.

getOwner

public java.lang.String getOwner()

The owner of the product.

setOwner

public void setOwner(java.lang.String value)

The owner of the product.

getProvisioningArtifactParameters

public java.lang.Object getProvisioningArtifactParameters()

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

setProvisioningArtifactParameters

public void setProvisioningArtifactParameters(IResolvable value)

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

setProvisioningArtifactParameters

public void setProvisioningArtifactParameters(java.util.List<java.lang.Object> value)

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

getAcceptLanguage

public java.lang.String getAcceptLanguage()

The language code.

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

setAcceptLanguage

public void setAcceptLanguage(java.lang.String value)

The language code.

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

getDescription

public java.lang.String getDescription()

The description of the product.

setDescription

public void setDescription(java.lang.String value)

The description of the product.

getDistributor

public java.lang.String getDistributor()

The distributor of the product.

setDistributor

public void setDistributor(java.lang.String value)

The distributor of the product.

getReplaceProvisioningArtifacts

public java.lang.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

public void setReplaceProvisioningArtifacts(java.lang.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

public void setReplaceProvisioningArtifacts(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

public java.lang.String getSupportDescription()

The support information about the product.

setSupportDescription

public void setSupportDescription(java.lang.String value)

The support information about the product.

getSupportEmail

public java.lang.String getSupportEmail()

The contact email for product support.

setSupportEmail

public void setSupportEmail(java.lang.String value)

The contact email for product support.

getSupportUrl

public java.lang.String getSupportUrl()

The contact URL for product support.

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

setSupportUrl

public void setSupportUrl(java.lang.String value)

The contact URL for product support.

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