Class CfnCloudFormationProduct
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
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") // the properties below are optional .acceptLanguage("acceptLanguage") .description("description") .distributor("distributor") .productType("productType") .provisioningArtifactParameters(List.of(ProvisioningArtifactPropertiesProperty.builder() .info(info) // the properties below are optional .description("description") .disableTemplateValidation(false) .name("name") .type("type") .build())) .replaceProvisioningArtifacts(false) .sourceConnection(SourceConnectionProperty.builder() .connectionParameters(ConnectionParametersProperty.builder() .codeStar(CodeStarParametersProperty.builder() .artifactPath("artifactPath") .branch("branch") .connectionArn("connectionArn") .repository("repository") .build()) .build()) .type("type") .build()) .supportDescription("supportDescription") .supportEmail("supportEmail") .supportUrl("supportUrl") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnCloudFormationProduct
.static interface
The subtype containing details about the Codestar connectionType
.static interface
Provides connection details.static interface
Information about a provisioning artifact (also known as a version) for a product.static interface
A top levelProductViewDetail
response containing details about the product’s connection.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionCfnCloudFormationProduct
(Construct scope, String id, CfnCloudFormationProductProps props) Create a newAWS::ServiceCatalog::CloudFormationProduct
.protected
CfnCloudFormationProduct
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnCloudFormationProduct
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe language code.The name of the product.The IDs of the provisioning artifacts.The names of the provisioning artifacts.The description of the product.The distributor of the product.getName()
The name of the product.getOwner()
The owner of the product.The type of product.The configuration of the provisioning artifact (also known as a version).This property is turned off by default.A top levelProductViewDetail
response containing details about the product’s connection.The support information about the product.The contact email for product support.The contact URL for product support.getTags()
One or more tags.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.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
The name of the product.void
The owner of the product.void
setProductType
(String value) The type of product.void
The configuration of the provisioning artifact (also known as a version).void
The configuration of the provisioning artifact (also known as a version).void
This property is turned off by default.void
This property is turned off by default.void
setSourceConnection
(IResolvable value) A top levelProductViewDetail
response containing details about the product’s connection.void
A top levelProductViewDetail
response containing details about the product’s connection.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.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 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnCloudFormationProduct
protected CfnCloudFormationProduct(software.amazon.jsii.JsiiObjectRef objRef) -
CfnCloudFormationProduct
protected CfnCloudFormationProduct(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnCloudFormationProduct
@Stability(Stable) public CfnCloudFormationProduct(@NotNull Construct scope, @NotNull String id, @NotNull CfnCloudFormationProductProps props) Create a newAWS::ServiceCatalog::CloudFormationProduct
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrProductName
The name of the product. -
getAttrProvisioningArtifactIds
The IDs of the provisioning artifacts. -
getAttrProvisioningArtifactNames
The names of the provisioning artifacts. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
One or more tags. -
getName
The name of the product. -
setName
The name of the product. -
getOwner
The owner of the product. -
setOwner
The owner of the product. -
getAcceptLanguage
The language code.jp
- Japanesezh
- Chinese
-
setAcceptLanguage
The language code.jp
- Japanesezh
- Chinese
-
getDescription
The description of the product. -
setDescription
The description of the product. -
getDistributor
The distributor of the product. -
setDistributor
The distributor of the product. -
getProductType
The type of product. -
setProductType
The type of product. -
getProvisioningArtifactParameters
The configuration of the provisioning artifact (also known as a version). -
setProvisioningArtifactParameters
The configuration of the provisioning artifact (also known as a version). -
setProvisioningArtifactParameters
The configuration of the provisioning artifact (also known as a version). -
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
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
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.
-
getSourceConnection
A top levelProductViewDetail
response containing details about the product’s connection.AWS Service Catalog returns this field for the
CreateProduct
,UpdateProduct
,DescribeProductAsAdmin
, andSearchProductAsAdmin
APIs. This response contains the same fields as theConnectionParameters
request, with the addition of theLastSync
response. -
setSourceConnection
A top levelProductViewDetail
response containing details about the product’s connection.AWS Service Catalog returns this field for the
CreateProduct
,UpdateProduct
,DescribeProductAsAdmin
, andSearchProductAsAdmin
APIs. This response contains the same fields as theConnectionParameters
request, with the addition of theLastSync
response. -
setSourceConnection
@Stability(Stable) public void setSourceConnection(@Nullable CfnCloudFormationProduct.SourceConnectionProperty value) A top levelProductViewDetail
response containing details about the product’s connection.AWS Service Catalog returns this field for the
CreateProduct
,UpdateProduct
,DescribeProductAsAdmin
, andSearchProductAsAdmin
APIs. This response contains the same fields as theConnectionParameters
request, with the addition of theLastSync
response. -
getSupportDescription
The support information about the product. -
setSupportDescription
The support information about the product. -
getSupportEmail
The contact email for product support. -
setSupportEmail
The contact email for product support. -
getSupportUrl
The contact URL for product support.^https?:\/\//
/ is the pattern used to validate SupportUrl. -
setSupportUrl
The contact URL for product support.^https?:\/\//
/ is the pattern used to validate SupportUrl.
-