Skip to content
v2.274.0

CfnProjectProps Struct ​

Properties for defining a CfnProject.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';

declare const serviceCatalogProvisioningDetails: any;
const cfnProjectProps: sagemaker.CfnProjectProps = {
  projectName: 'projectName',

  // the properties below are optional
  projectDescription: 'projectDescription',
  serviceCatalogProvisionedProductDetails: {
    provisionedProductId: 'provisionedProductId',
    provisionedProductStatusMessage: 'provisionedProductStatusMessage',
  },
  serviceCatalogProvisioningDetails: serviceCatalogProvisioningDetails,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  templateProviderDetails: [{
    cfnTemplateProviderDetail: {
      templateName: 'templateName',
      templateUrl: 'templateUrl',

      // the properties below are optional
      parameters: [{
        key: 'key',
        value: 'value',
      }],
      roleArn: 'roleArn',
    },
  }],
};

Properties ​

projectDescriptionoptionalstringproject_descriptionoptionalstrprojectDescriptionoptionalStringProjectDescriptionoptionalstringProjectDescriptionoptional*string#
The description of the project.
projectNamestringproject_namestrprojectNameStringProjectNamestringProjectName*stringrequired#
The name of the project.
serviceCatalogProvisionedProductDetailsoptionalIResolvable | CfnProject.ServiceCatalogProvisionedProductDetailsPropertyservice_catalog_provisioned_product_detailsoptionaltyping.Union[IResolvable, ServiceCatalogProvisionedProductDetailsProperty]serviceCatalogProvisionedProductDetailsoptionalIResolvableServiceCatalogProvisionedProductDetailsoptionalIResolvableServiceCatalogProvisionedProductDetailsoptionalinterface{}#
Details of a provisioned service catalog product.

For information about service catalog, see What is AWS Service Catalog .

serviceCatalogProvisioningDetailsoptionalanyservice_catalog_provisioning_detailsoptionalAnyserviceCatalogProvisioningDetailsoptionalObjectServiceCatalogProvisioningDetailsoptionalobjectServiceCatalogProvisioningDetailsoptionalinterface{}#
The product ID and provisioning artifact ID to provision a service catalog.

For information, see What is AWS Service Catalog .

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
A list of key-value pairs to apply to this resource.
notes

For more information, see Resource Tag and Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .

templateProviderDetailsoptionalIResolvable | IResolvable | CfnProject.TemplateProviderDetailProperty[]template_provider_detailsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TemplateProviderDetailProperty]]]templateProviderDetailsoptionalIResolvableTemplateProviderDetailsoptionalIResolvableTemplateProviderDetailsoptionalinterface{}#
An array of template providers associated with the project.