@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:53.661Z") public class CfnCloudFormationProduct extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnCloudFormationProduct(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnCloudFormationProduct(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnCloudFormationProduct(Construct scope, java.lang.String id, CfnCloudFormationProductProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrProductName()
public java.lang.String getAttrProvisioningArtifactIds()
public java.lang.String getAttrProvisioningArtifactNames()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.String getOwner()
public void setOwner(java.lang.String value)
public java.lang.Object getProvisioningArtifactParameters()
public void setProvisioningArtifactParameters(IResolvable value)
public void setProvisioningArtifactParameters(java.util.List<java.lang.Object> value)
public java.lang.String getAcceptLanguage()
en
- English (default)jp
- Japanesezh
- Chinesepublic void setAcceptLanguage(java.lang.String value)
en
- English (default)jp
- Japanesezh
- Chinesepublic java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.String getDistributor()
public void setDistributor(java.lang.String value)
public java.lang.Object getReplaceProvisioningArtifacts()
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.
public void setReplaceProvisioningArtifacts(java.lang.Boolean value)
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.
public void setReplaceProvisioningArtifacts(IResolvable value)
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.
public java.lang.String getSupportDescription()
public void setSupportDescription(java.lang.String value)
public java.lang.String getSupportEmail()
public void setSupportEmail(java.lang.String value)
public java.lang.String getSupportUrl()
^https?:\/\//
/ is the pattern used to validate SupportUrl.
public void setSupportUrl(java.lang.String value)
^https?:\/\//
/ is the pattern used to validate SupportUrl.