Class CfnProject

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.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnProject

Implements

IInspectable

IProjectRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Sagemaker

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnProject : CfnResource, IInspectable, IProjectRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnProject Inherits CfnResource Implements IInspectable, IProjectRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

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

CloudformationResource: AWS::SageMaker::Project

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Sagemaker;

             var serviceCatalogProvisioningDetails;

             var cfnProject = new CfnProject(this, "MyCfnProject", new CfnProjectProps {
                 ProjectName = "projectName",

                 // the properties below are optional
                 ProjectDescription = "projectDescription",
                 ServiceCatalogProvisionedProductDetails = new ServiceCatalogProvisionedProductDetailsProperty {
                     ProvisionedProductId = "provisionedProductId",
                     ProvisionedProductStatusMessage = "provisionedProductStatusMessage"
                 },
                 ServiceCatalogProvisioningDetails = serviceCatalogProvisioningDetails,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TemplateProviderDetails = new [] { new TemplateProviderDetailProperty {
                     CfnTemplateProviderDetail = new CfnTemplateProviderDetailProperty {
                         TemplateName = "templateName",
                         TemplateUrl = "templateUrl",

                         // the properties below are optional
                         Parameters = new [] { new CfnStackParameterProperty {
                             Key = "key",
                             Value = "value"
                         } },
                         RoleArn = "roleArn"
                     }
                 } }
             });

Synopsis

Constructors

CfnProject(Construct, string, ICfnProjectProps)

Create a new AWS::SageMaker::Project.

Properties

AttrCreationTime	The time that the project was created.
AttrProjectArn	The Amazon Resource Name (ARN) of the project.
AttrProjectId	The ID of the project.
AttrProjectStatus	The status of the project.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	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.
ProjectDescription	The description of the project.
ProjectName	The name of the project.
ProjectRef	A reference to a Project resource.
ServiceCatalogProvisionedProductDetails	Details of a provisioned service catalog product.
ServiceCatalogProvisioningDetails	The product ID and provisioning artifact ID to provision a service catalog.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	A list of key-value pairs to apply to this resource.
TemplateProviderDetails	An array of template providers associated with the project.

Methods

ArnForProject(IProjectRef)	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.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnProject(object)	Checks whether the given object is a CfnProject.
RenderProperties(IDictionary<string, object>)	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.

Constructors

CfnProject(Construct, string, ICfnProjectProps)

Create a new AWS::SageMaker::Project.

public CfnProject(Construct scope, string id, ICfnProjectProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnProjectProps: Resource properties.

Remarks

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

CloudformationResource: AWS::SageMaker::Project

ExampleMetadata: fixture=_generated

Properties

AttrCreationTime

The time that the project was created.

public virtual string AttrCreationTime { get; }

Property Value

string

Remarks

CloudformationAttribute: CreationTime

AttrProjectArn

The Amazon Resource Name (ARN) of the project.

public virtual string AttrProjectArn { get; }

Property Value

string

Remarks

CloudformationAttribute: ProjectArn

AttrProjectId

The ID of the project.

public virtual string AttrProjectId { get; }

Property Value

string

Remarks

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

CloudformationAttribute: ProjectId

AttrProjectStatus

The status of the project.

public virtual string AttrProjectStatus { get; }

Property Value

string

Remarks

CloudformationAttribute: ProjectStatus

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

CloudformationResource: AWS::SageMaker::Project

ExampleMetadata: fixture=_generated

CfnProperties

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.

protected override IDictionary<string, object> CfnProperties { get; }

CloudformationResource: AWS::SageMaker::Project

ExampleMetadata: fixture=_generated

ProjectDescription

The description of the project.

public virtual string? ProjectDescription { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::SageMaker::Project

ExampleMetadata: fixture=_generated

ProjectName

The name of the project.

public virtual string ProjectName { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::SageMaker::Project

ExampleMetadata: fixture=_generated

ProjectRef

A reference to a Project resource.

public virtual IProjectReference ProjectRef { get; }

Property Value

IProjectReference

Remarks

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

CloudformationResource: AWS::SageMaker::Project

ExampleMetadata: fixture=_generated

ServiceCatalogProvisionedProductDetails

Details of a provisioned service catalog product.

public virtual object? ServiceCatalogProvisionedProductDetails { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnProject.IServiceCatalogProvisionedProductDetailsProperty

ServiceCatalogProvisioningDetails

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

public virtual object? ServiceCatalogProvisioningDetails { get; set; }

Property Value

object

Remarks

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

CloudformationResource: AWS::SageMaker::Project

ExampleMetadata: fixture=_generated

TagsRaw

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

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

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

CloudformationResource: AWS::SageMaker::Project

ExampleMetadata: fixture=_generated

TemplateProviderDetails

An array of template providers associated with the project.

public virtual object? TemplateProviderDetails { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnProject.ITemplateProviderDetailProperty)[]

Methods

ArnForProject(IProjectRef)

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.

public static string ArnForProject(IProjectRef resource)

Parameters

resource IProjectRef

Returns

string

Remarks

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

CloudformationResource: AWS::SageMaker::Project

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Sagemaker;

             var serviceCatalogProvisioningDetails;

             var cfnProject = new CfnProject(this, "MyCfnProject", new CfnProjectProps {
                 ProjectName = "projectName",

                 // the properties below are optional
                 ProjectDescription = "projectDescription",
                 ServiceCatalogProvisionedProductDetails = new ServiceCatalogProvisionedProductDetailsProperty {
                     ProvisionedProductId = "provisionedProductId",
                     ProvisionedProductStatusMessage = "provisionedProductStatusMessage"
                 },
                 ServiceCatalogProvisioningDetails = serviceCatalogProvisioningDetails,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TemplateProviderDetails = new [] { new TemplateProviderDetailProperty {
                     CfnTemplateProviderDetail = new CfnTemplateProviderDetailProperty {
                         TemplateName = "templateName",
                         TemplateUrl = "templateUrl",

                         // the properties below are optional
                         Parameters = new [] { new CfnStackParameterProperty {
                             Key = "key",
                             Value = "value"
                         } },
                         RoleArn = "roleArn"
                     }
                 } }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

Remarks

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

CloudformationResource: AWS::SageMaker::Project

ExampleMetadata: fixture=_generated

IsCfnProject(object)

Checks whether the given object is a CfnProject.

public static bool IsCfnProject(object x)

Parameters

x object

Returns

bool

Remarks

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

CloudformationResource: AWS::SageMaker::Project

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

CloudformationResource: AWS::SageMaker::Project

ExampleMetadata: fixture=_generated

Implements

IInspectable

IProjectRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable