Package software.amazon.awscdk.services.sagemaker

Class CfnProject

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.sagemaker.CfnProject
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IProjectRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-12T17:54:22.259Z") @Stability(Stable) public class CfnProject extends CfnResource implements IInspectable, IProjectRef, ITaggable
Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.

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;
 CfnProject cfnProject = CfnProject.Builder.create(this, "MyCfnProject")
         .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:

  • 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

    • CfnProject

      protected CfnProject(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnProject

      protected CfnProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnProject

      @Stability(Stable) public CfnProject(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnProjectProps props)
      Create a new AWS::SageMaker::Project.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForProject

      @Stability(Stable) @NotNull public static String arnForProject(@NotNull IProjectRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnProject

      @Stability(Stable) @NotNull public static Boolean isCfnProject(@NotNull Object x)
      Checks whether the given object is a CfnProject.

      Parameters:
      x - This parameter is required.

    • 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.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      The time that the project was created.

    • getAttrProjectArn

      @Stability(Stable) @NotNull public String getAttrProjectArn()
      The Amazon Resource Name (ARN) of the project.

    • getAttrProjectId

      @Stability(Stable) @NotNull public String getAttrProjectId()
      The ID of the project.

      This ID is prepended to all entities associated with this project.

    • getAttrProjectStatus

      @Stability(Stable) @NotNull public String getAttrProjectStatus()
      The status of the project.

    • getCfnProperties

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

    • getProjectRef

      @Stability(Stable) @NotNull public ProjectReference getProjectRef()
      A reference to a Project resource.
      Specified by:
      getProjectRef in interface IProjectRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getProjectName

      @Stability(Stable) @NotNull public String getProjectName()
      The name of the project.

    • setProjectName

      @Stability(Stable) public void setProjectName(@NotNull String value)
      The name of the project.

    • getProjectDescription

      @Stability(Stable) @Nullable public String getProjectDescription()
      The description of the project.

    • setProjectDescription

      @Stability(Stable) public void setProjectDescription(@Nullable String value)
      The description of the project.

    • getServiceCatalogProvisionedProductDetails

      @Stability(Stable) @Nullable public Object getServiceCatalogProvisionedProductDetails()
      Details of a provisioned service catalog product.

      Returns union: either IResolvable or CfnProject.ServiceCatalogProvisionedProductDetailsProperty

    • setServiceCatalogProvisionedProductDetails

      @Stability(Stable) public void setServiceCatalogProvisionedProductDetails(@Nullable IResolvable value)
      Details of a provisioned service catalog product.

    • setServiceCatalogProvisionedProductDetails

      @Stability(Stable) public void setServiceCatalogProvisionedProductDetails(@Nullable CfnProject.ServiceCatalogProvisionedProductDetailsProperty value)
      Details of a provisioned service catalog product.

    • getServiceCatalogProvisioningDetails

      @Stability(Stable) @Nullable public Object getServiceCatalogProvisioningDetails()
      The product ID and provisioning artifact ID to provision a service catalog.

    • setServiceCatalogProvisioningDetails

      @Stability(Stable) public void setServiceCatalogProvisioningDetails(@Nullable Object value)
      The product ID and provisioning artifact ID to provision a service catalog.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A list of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of key-value pairs to apply to this resource.

    • getTemplateProviderDetails

      @Stability(Stable) @Nullable public Object getTemplateProviderDetails()
      An array of template providers associated with the project.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnProject.TemplateProviderDetailProperty>

    • setTemplateProviderDetails

      @Stability(Stable) public void setTemplateProviderDetails(@Nullable IResolvable value)
      An array of template providers associated with the project.

    • setTemplateProviderDetails

      @Stability(Stable) public void setTemplateProviderDetails(@Nullable List<Object> value)
      An array of template providers associated with the project.