Package software.amazon.awscdk.services.servicecatalog

Interface CfnCloudFormationProductProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnCloudFormationProductProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:39.722Z") @Stability(Stable) public interface CfnCloudFormationProductProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnCloudFormationProduct.

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;
 CfnCloudFormationProductProps cfnCloudFormationProductProps = CfnCloudFormationProductProps.builder()
         .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();

  • Method Details

    • getName

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

    • getOwner

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

    • getAcceptLanguage

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

      • jp - Japanese
      • zh - Chinese

    • getDescription

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

    • getDistributor

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

    • getProductType

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

    • getProvisioningArtifactParameters

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

    • getReplaceProvisioningArtifacts

      @Stability(Stable) @Nullable default 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.

    • getSourceConnection

      @Stability(Stable) @Nullable default 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.

    • getSupportDescription

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

    • getSupportEmail

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

    • getSupportUrl

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

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

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      One or more tags.

    • builder

      @Stability(Stable) static CfnCloudFormationProductProps.Builder builder()
      Returns:
      a CfnCloudFormationProductProps.Builder of CfnCloudFormationProductProps