Package software.amazon.awscdk.services.servicecatalog

Class CfnCloudFormationProduct

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:39.715Z") @Stability(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")
         // 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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrProductName()
      The name of the product.

    • getAttrProvisioningArtifactIds

      @Stability(Stable) @NotNull public String getAttrProvisioningArtifactIds()
      The IDs of the provisioning artifacts.

    • getAttrProvisioningArtifactNames

      @Stability(Stable) @NotNull public String getAttrProvisioningArtifactNames()
      The names of the provisioning artifacts.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      One or more tags.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the product.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the product.

    • getOwner

      @Stability(Stable) @NotNull public String getOwner()
      The owner of the product.

    • setOwner

      @Stability(Stable) public void setOwner(@NotNull String value)
      The owner of the product.

    • getAcceptLanguage

      @Stability(Stable) @Nullable public String getAcceptLanguage()
      The language code.

      • jp - Japanese
      • zh - Chinese

    • setAcceptLanguage

      @Stability(Stable) public void setAcceptLanguage(@Nullable String value)
      The language code.

      • jp - Japanese
      • zh - Chinese

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the product.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the product.

    • getDistributor

      @Stability(Stable) @Nullable public String getDistributor()
      The distributor of the product.

    • setDistributor

      @Stability(Stable) public void setDistributor(@Nullable String value)
      The distributor of the product.

    • getProductType

      @Stability(Stable) @Nullable public String getProductType()
      The type of product.

    • setProductType

      @Stability(Stable) public void setProductType(@Nullable String value)
      The type of product.

    • getProvisioningArtifactParameters

      @Stability(Stable) @Nullable public Object getProvisioningArtifactParameters()
      The configuration of the provisioning artifact (also known as a version).

    • setProvisioningArtifactParameters

      @Stability(Stable) public void setProvisioningArtifactParameters(@Nullable IResolvable value)
      The configuration of the provisioning artifact (also known as a version).

    • setProvisioningArtifactParameters

      @Stability(Stable) public void setProvisioningArtifactParameters(@Nullable List<Object> value)
      The configuration of the provisioning artifact (also known as a version).

    • getReplaceProvisioningArtifacts

      @Stability(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(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(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.

    • getSourceConnection

      @Stability(Stable) @Nullable public Object getSourceConnection()
      A top level ProductViewDetail response containing details about the product’s connection.

      AWS Service Catalog returns this field for the CreateProduct , UpdateProduct , DescribeProductAsAdmin , and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.

    • setSourceConnection

      @Stability(Stable) public void setSourceConnection(@Nullable IResolvable value)
      A top level ProductViewDetail response containing details about the product’s connection.

      AWS Service Catalog returns this field for the CreateProduct , UpdateProduct , DescribeProductAsAdmin , and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.

    • setSourceConnection

      @Stability(Stable) public void setSourceConnection(@Nullable CfnCloudFormationProduct.SourceConnectionProperty value)
      A top level ProductViewDetail response containing details about the product’s connection.

      AWS Service Catalog returns this field for the CreateProduct , UpdateProduct , DescribeProductAsAdmin , and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.

    • getSupportDescription

      @Stability(Stable) @Nullable public String getSupportDescription()
      The support information about the product.

    • setSupportDescription

      @Stability(Stable) public void setSupportDescription(@Nullable String value)
      The support information about the product.

    • getSupportEmail

      @Stability(Stable) @Nullable public String getSupportEmail()
      The contact email for product support.

    • setSupportEmail

      @Stability(Stable) public void setSupportEmail(@Nullable String value)
      The contact email for product support.

    • getSupportUrl

      @Stability(Stable) @Nullable public String getSupportUrl()
      The contact URL for product support.

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

    • setSupportUrl

      @Stability(Stable) public void setSupportUrl(@Nullable String value)
      The contact URL for product support.

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