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.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::SageMaker::Project", "Properties" : { "ProjectDescription" :
String
, "ProjectName" :String
, "ServiceCatalogProvisionedProductDetails" :ServiceCatalogProvisionedProductDetails
, "ServiceCatalogProvisioningDetails" :ServiceCatalogProvisioningDetails
, "Tags" :[ Tag, ... ]
} }
YAML
Type: AWS::SageMaker::Project Properties: ProjectDescription:
String
ProjectName:String
ServiceCatalogProvisionedProductDetails:ServiceCatalogProvisionedProductDetails
ServiceCatalogProvisioningDetails:ServiceCatalogProvisioningDetails
Tags:- Tag
Properties
ProjectDescription
-
The description of the project.
Required: No
Type: String
Pattern:
.*
Maximum:
1024
Update requires: Replacement
ProjectName
-
The name of the project.
Required: Yes
Type: String
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
Minimum:
1
Maximum:
32
Update requires: Replacement
ServiceCatalogProvisionedProductDetails
-
Details of a provisioned service catalog product. For information about service catalog, see What is Amazon Service Catalog.
Required: No
Type: ServiceCatalogProvisionedProductDetails
Update requires: No interruption
ServiceCatalogProvisioningDetails
-
The product ID and provisioning artifact ID to provision a service catalog. For information, see What is Amazon Service Catalog.
Required: Yes
Type: ServiceCatalogProvisioningDetails
Update requires: Replacement
-
A list of key-value pairs to apply to this resource.
For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Billing and Cost Management User Guide.
Required: No
Type: Array of Tag
Maximum:
40
Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the Amazon Resource Name (ARN) of the Project.
For more information about using the Ref
function, see Ref
.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt
.
CreationTime
-
The time that the project was created.
ProjectArn
-
The Amazon Resource Name (ARN) of the project.
ProjectId
-
The ID of the project. This ID is prepended to all entities associated with this project.
ProjectStatus
-
The status of the project.
Examples
SageMaker Project Example
The following example creates a SageMaker Project.
JSON
{ "Description": "AWS SageMaker Project basic template", "Resources": { "SampleProject": { "Type": "AWS::SageMaker::Project", "Properties": { "ProjectName": "project1", "ProjectDescription": "Project Description", "ServiceCatalogProvisioningDetails": { "ProductId": "prod-53ibyqbj2cgmo", "ProvisioningArtifactId": "pa-sm4pjfuzictpe" } } } } }
YAML
--- Description: AWS SageMaker Project basic template Resources: SampleProject: Type: AWS::SageMaker::Project Properties: ProjectName: "SampleProject" ProjectDescription: "Project Description" ServiceCatalogProvisioningDetails: ProductId: "prod-53ibyqbj2cgmo" ProvisioningArtifactId: "pa-sm4pjfuzictpe"