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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.953Z")
 @Stability(value=Stable)
public class CfnProject
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SageMaker::Project`.

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")
         .serviceCatalogProvisioningDetails(serviceCatalogProvisioningDetails)
         // the properties below are optional
         .projectDescription("projectDescription")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnProject.Builder A fluent builder for CfnProject.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnProject(software.constructs.Construct scope, String id, CfnProjectProps props) Create a new `AWS::SageMaker::Project`.
protected	CfnProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnProject(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrCreationTime() The time that the project was created.
String	getAttrProjectArn() The Amazon Resource Name (ARN) of the project.
String	getAttrProjectId() The ID of the project.
String	getAttrProjectStatus() The status of the project.
protected Map<String,Object>	getCfnProperties()
String	getProjectDescription() The description of the project.
String	getProjectName() The name of the project.
Object	getServiceCatalogProvisioningDetails() The product ID and provisioning artifact ID to provision a service catalog.
TagManager	getTags() A list of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setProjectDescription(String value) The description of the project.
void	setProjectName(String value) The name of the project.
void	setServiceCatalogProvisioningDetails(Object value) The product ID and provisioning artifact ID to provision a service catalog.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnProject

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

CfnProject

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

CfnProject

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrCreationTime()

The time that the project was created.

getAttrProjectArn

@Stability(value=Stable)
 @NotNull
public String getAttrProjectArn()

The Amazon Resource Name (ARN) of the project.

getAttrProjectId

@Stability(value=Stable)
 @NotNull
public String getAttrProjectId()

The ID of the project.

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

getAttrProjectStatus

@Stability(value=Stable)
 @NotNull
public String getAttrProjectStatus()

The status of the project.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager 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 .

getProjectName

@Stability(value=Stable)
 @NotNull
public String getProjectName()

The name of the project.

setProjectName

@Stability(value=Stable)
public void setProjectName(@NotNull
                                                    String value)

The name of the project.

getServiceCatalogProvisioningDetails

@Stability(value=Stable)
 @NotNull
public Object getServiceCatalogProvisioningDetails()

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

For information, see What is AWS Service Catalog .

setServiceCatalogProvisioningDetails

@Stability(value=Stable)
public void setServiceCatalogProvisioningDetails(@NotNull
                                                                          Object value)

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

For information, see What is AWS Service Catalog .

getProjectDescription

@Stability(value=Stable)
 @Nullable
public String getProjectDescription()

The description of the project.

setProjectDescription

@Stability(value=Stable)
public void setProjectDescription(@Nullable
                                                           String value)

The description of the project.