Project

sagemaker.services.k8s.aws/v1alpha1

Type	Link
GoDoc	sagemaker-controller/apis/v1alpha1#Project

Metadata

Property	Value
Scope	Namespaced
Kind	`Project`
ListKind	`ProjectList`
Plural	`projects`
Singular	`project`

The properties of a project as returned by the Search API.

Spec

projectDescription: string
projectName: string
serviceCatalogProvisioningDetails: 
  pathID: string
  productID: string
  provisioningArtifactID: string
  provisioningParameters:
  - key: string
    value: string
tags:
- key: string
  value: string
templateProviders:
  cfnTemplateProvider: 
    parameters:
    - key: string
      value: string
    roleARN: string
    templateName: string
    templateURL: string

Field	Description
projectDescription Optional	string A description for the project. Regex Pattern: `^[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*$`
projectName Required	string The name of the project. Regex Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}$`
serviceCatalogProvisioningDetails Optional	object The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don’t provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html).
serviceCatalogProvisioningDetails.pathID Optional	string
serviceCatalogProvisioningDetails.productID Optional	string
serviceCatalogProvisioningDetails.provisioningArtifactID Optional	string
serviceCatalogProvisioningDetails.provisioningParameters Optional	array
serviceCatalogProvisioningDetails.provisioningParameters.[] Required	object A key value pair used when you provision a project as a service catalog product.
For information, see What is Amazon Web Services Service Catalog (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html).
serviceCatalogProvisioningDetails.provisioningParameters.[].value Optional	string
tags Optional	array An array of key-value pairs that you want to use to organize and track your Amazon Web Services resource costs. For more information, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon Web Services General Reference Guide.
tags.[] Required	object A tag object that consists of a key and an optional value, used to manage
metadata for SageMaker Amazon Web Services resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).

For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || tags.[].key
Optional | string
| | tags.[].value
Optional | string
| | templateProviders
Optional | array
An array of template provider configurations for creating infrastructure
resources for the project. | | templateProviders.[]
Required | object
Contains configuration details for a template provider. Only one type of template provider can be specified. || templateProviders.[].cfnTemplateProvider
Optional | object
The CloudFormation template provider configuration for creating infrastructure
resources. | | templateProviders.[].cfnTemplateProvider.parameters
Optional | array
| | templateProviders.[].cfnTemplateProvider.parameters.[]
Required | object
A key-value pair that represents a parameter for the CloudFormation stack. || templateProviders.[].cfnTemplateProvider.parameters.[].key
Optional | string
| | templateProviders.[].cfnTemplateProvider.parameters.[].value
Optional | string
| | templateProviders.[].cfnTemplateProvider.roleARN
Optional | string
| | templateProviders.[].cfnTemplateProvider.templateName
Optional | string
| | templateProviders.[].cfnTemplateProvider.templateURL
Optional | string
|

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  partition: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
creationTime: string
projectID: string
projectStatus: string
serviceCatalogProvisionedProductDetails: 
  provisionedProductID: string
  provisionedProductStatusMessage: string
templateProviderDetails:
  cfnTemplateProviderDetail: 
    parameters:
    - key: string
      value: string
    roleARN: string
    stackDetail: 
      id: string
      name: string
      statusMessage: string
    templateName: string
    templateURL: string

Field	Description
ackResourceMetadata Optional	object All CRs managed by ACK have a common `Status.ACKResourceMetadata` member that is used to contain resource sync state, account ownership, constructed ARN for the resource
ackResourceMetadata.arn Optional	string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID Required	string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.
ackResourceMetadata.partition Optional	string Partition is the AWS partition in which the resource exists or will exist
ackResourceMetadata.region Required	string Region is the AWS region in which the resource exists or will exist.
conditions Optional	array All CRs managed by ACK have a common `Status.Conditions` member that contains a collection of `ackv1alpha1.Condition` objects that describe the various terminal states of the CR and its backend AWS service API resource
conditions.[] Required	object Condition is the common struct used by all CRDs managed by ACK service
controllers to indicate terminal states of the CR and its backend AWS
service API resource
conditions.[].message Optional	string A human readable message indicating details about the transition.
conditions.[].reason Optional	string The reason for the condition’s last transition.
conditions.[].status Optional	string Status of the condition, one of True, False, Unknown.
conditions.[].type Optional	string Type is the type of the Condition
creationTime Optional	string The time when the project was created.
projectID Optional	string The ID of the new project. Regex Pattern: `^[a-zA-Z0-9](-[a-zA-Z0-9])$`
projectStatus Optional	string The status of the project.
serviceCatalogProvisionedProductDetails Optional	object Information about a provisioned service catalog product.
serviceCatalogProvisionedProductDetails.provisionedProductID Optional	string
serviceCatalogProvisionedProductDetails.provisionedProductStatusMessage Optional	string
templateProviderDetails Optional	array An array of template providers associated with the project.
templateProviderDetails.[] Required	object Details about a template provider configuration and associated provisioning
information.
templateProviderDetails.[].cfnTemplateProviderDetail.parameters Optional	array
templateProviderDetails.[].cfnTemplateProviderDetail.parameters.[] Required	object A key-value pair representing a parameter used in the CloudFormation stack.
templateProviderDetails.[].cfnTemplateProviderDetail.parameters.[].value Optional	string
templateProviderDetails.[].cfnTemplateProviderDetail.roleARN Optional	string
templateProviderDetails.[].cfnTemplateProviderDetail.stackDetail Optional	object Details about the CloudFormation stack.
templateProviderDetails.[].cfnTemplateProviderDetail.stackDetail.id Optional	string
templateProviderDetails.[].cfnTemplateProviderDetail.stackDetail.name Optional	string
templateProviderDetails.[].cfnTemplateProviderDetail.stackDetail.statusMessage Optional	string
templateProviderDetails.[].cfnTemplateProviderDetail.templateName Optional	string
templateProviderDetails.[].cfnTemplateProviderDetail.templateURL Optional	string

Project

Metadata#

Spec#

Status#

Metadata

Spec

Status