aws-cdk-lib.aws_servicecatalog.CfnCloudFormationProductProps

interface CfnCloudFormationProductProps

LanguageType name
.NETAmazon.CDK.AWS.Servicecatalog.CfnCloudFormationProductProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsservicecatalog#CfnCloudFormationProductProps
Javasoftware.amazon.awscdk.services.servicecatalog.CfnCloudFormationProductProps
Pythonaws_cdk.aws_servicecatalog.CfnCloudFormationProductProps
TypeScript aws-cdk-lib » aws_servicecatalog » CfnCloudFormationProductProps

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 { aws_servicecatalog as servicecatalog } from 'aws-cdk-lib';

declare const info: any;
const cfnCloudFormationProductProps: servicecatalog.CfnCloudFormationProductProps = {
  name: 'name',
  owner: 'owner',

  // the properties below are optional
  acceptLanguage: 'acceptLanguage',
  description: 'description',
  distributor: 'distributor',
  productType: 'productType',
  provisioningArtifactParameters: [{
    info: info,

    // the properties below are optional
    description: 'description',
    disableTemplateValidation: false,
    name: 'name',
    type: 'type',
  }],
  replaceProvisioningArtifacts: false,
  sourceConnection: {
    connectionParameters: {
      codeStar: {
        artifactPath: 'artifactPath',
        branch: 'branch',
        connectionArn: 'connectionArn',
        repository: 'repository',
      },
    },
    type: 'type',
  },
  supportDescription: 'supportDescription',
  supportEmail: 'supportEmail',
  supportUrl: 'supportUrl',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
namestringThe name of the product.
ownerstringThe owner of the product.
acceptLanguage?stringThe language code.
description?stringThe description of the product.
distributor?stringThe distributor of the product.
productType?stringThe type of product.
provisioningArtifactParameters?IResolvable | IResolvable | ProvisioningArtifactPropertiesProperty[]The configuration of the provisioning artifact (also known as a version).
replaceProvisioningArtifacts?boolean | IResolvableThis property is turned off by default.
sourceConnection?IResolvable | SourceConnectionPropertyA top level ProductViewDetail response containing details about the product’s connection.
supportDescription?stringThe support information about the product.
supportEmail?stringThe contact email for product support.
supportUrl?stringThe contact URL for product support.
tags?CfnTag[]One or more tags.

name

Type: string

The name of the product.


owner

Type: string

The owner of the product.


acceptLanguage?

Type: string (optional)

The language code.

  • jp - Japanese
  • zh - Chinese

description?

Type: string (optional)

The description of the product.


distributor?

Type: string (optional)

The distributor of the product.


productType?

Type: string (optional)

The type of product.


provisioningArtifactParameters?

Type: IResolvable | IResolvable | ProvisioningArtifactPropertiesProperty[] (optional)

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


replaceProvisioningArtifacts?

Type: boolean | IResolvable (optional)

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.


sourceConnection?

Type: IResolvable | SourceConnectionProperty (optional)

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.


supportDescription?

Type: string (optional)

The support information about the product.


supportEmail?

Type: string (optional)

The contact email for product support.


supportUrl?

Type: string (optional)

The contact URL for product support.

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


tags?

Type: CfnTag[] (optional)

One or more tags.