Package software.amazon.awscdk.services.sagemaker

Interface CfnProjectProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProjectProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-02T11:25:40.117Z")
@Stability(Stable)
public interface CfnProjectProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnProject.

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.sagemaker.*;
 Object serviceCatalogProvisioningDetails;
 CfnProjectProps cfnProjectProps = CfnProjectProps.builder()
         .projectName("projectName")
         // the properties below are optional
         .projectDescription("projectDescription")
         .serviceCatalogProvisionedProductDetails(ServiceCatalogProvisionedProductDetailsProperty.builder()
                 .provisionedProductId("provisionedProductId")
                 .provisionedProductStatusMessage("provisionedProductStatusMessage")
                 .build())
         .serviceCatalogProvisioningDetails(serviceCatalogProvisioningDetails)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .templateProviderDetails(List.of(TemplateProviderDetailProperty.builder()
                 .cfnTemplateProviderDetail(CfnTemplateProviderDetailProperty.builder()
                         .templateName("templateName")
                         .templateUrl("templateUrl")
                         // the properties below are optional
                         .parameters(List.of(CfnStackParameterProperty.builder()
                                 .key("key")
                                 .value("value")
                                 .build()))
                         .roleArn("roleArn")
                         .build())
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-project.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnProjectProps.Builder	A builder for CfnProjectProps
static final class	CfnProjectProps.Jsii$Proxy	An implementation for CfnProjectProps

Method Summary

Modifier and Type	Method	Description
static CfnProjectProps.Builder	builder()
default String	getProjectDescription()	The description of the project.
String	getProjectName()	The name of the project.
default Object	getServiceCatalogProvisionedProductDetails()	Details of a provisioned service catalog product.
default Object	getServiceCatalogProvisioningDetails()	The product ID and provisioning artifact ID to provision a service catalog.
default List<CfnTag>	getTags()	A list of key-value pairs to apply to this resource.
default Object	getTemplateProviderDetails()	An array of template providers associated with the project.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getProjectName

@Stability(Stable)
@NotNull
String getProjectName()

The name of the project.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-project.html#cfn-sagemaker-project-projectname

getProjectDescription

@Stability(Stable)
@Nullable
default String getProjectDescription()

The description of the project.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-project.html#cfn-sagemaker-project-projectdescription

getServiceCatalogProvisionedProductDetails

@Stability(Stable)
@Nullable
default Object getServiceCatalogProvisionedProductDetails()

Details of a provisioned service catalog product.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-project.html#cfn-sagemaker-project-servicecatalogprovisionedproductdetails

getServiceCatalogProvisioningDetails

@Stability(Stable)
@Nullable
default Object getServiceCatalogProvisioningDetails()

The product ID and provisioning artifact ID to provision a service catalog.

For information, see What is AWS Service Catalog .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-project.html#cfn-sagemaker-project-servicecatalogprovisioningdetails

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A list of key-value pairs to apply to this resource.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-project.html#cfn-sagemaker-project-tags

getTemplateProviderDetails

@Stability(Stable)
@Nullable
default Object getTemplateProviderDetails()

An array of template providers associated with the project.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-project.html#cfn-sagemaker-project-templateproviderdetails

builder

@Stability(Stable)
static CfnProjectProps.Builder builder()

Returns:

a CfnProjectProps.Builder of CfnProjectProps