@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
33kind : CustomResourceDefinition
44metadata :
55 annotations :
6- controller-gen.kubebuilder.io/version : v0.9.2
7- creationTimestamp : null
6+ controller-gen.kubebuilder.io/version : v0.19.0
87 name : apps.sagemaker.services.k8s.aws
98spec :
109 group : sagemaker.services.k8s.aws
@@ -25,37 +24,54 @@ spec:
2524 description : App is the Schema for the Apps API
2625 properties :
2726 apiVersion :
28- description : ' APIVersion defines the versioned schema of this representation
29- of an object. Servers should convert recognized schemas to the latest
30- internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
27+ description : |-
28+ APIVersion defines the versioned schema of this representation of an object.
29+ Servers should convert recognized schemas to the latest internal value, and
30+ may reject unrecognized values.
31+ More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
3132 type : string
3233 kind :
33- description : ' Kind is a string value representing the REST resource this
34- object represents. Servers may infer this from the endpoint the client
35- submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
34+ description : |-
35+ Kind is a string value representing the REST resource this object represents.
36+ Servers may infer this from the endpoint the client submits requests to.
37+ Cannot be updated.
38+ In CamelCase.
39+ More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
3640 type : string
3741 metadata :
3842 type : object
3943 spec :
4044 description : AppSpec defines the desired state of App.
4145 properties :
4246 appName :
43- description : The name of the app.
47+ description : |-
48+ The name of the app.
49+
50+ Regex Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$`
4451 type : string
4552 appType :
4653 description : The type of app.
4754 type : string
4855 domainID :
49- description : The domain ID.
56+ description : |-
57+ The domain ID.
58+
59+ Regex Pattern: `^d-(-*[a-z0-9]){1,61}$`
5060 type : string
61+ recoveryMode :
62+ description : Indicates whether the application is launched in recovery
63+ mode.
64+ type : boolean
5165 resourceSpec :
52- description : " The instance type and the Amazon Resource Name (ARN)
53- of the SageMaker image created on the instance. \n The value of
54- InstanceType passed as part of the ResourceSpec in the CreateApp
55- call overrides the value passed as part of the ResourceSpec configured
56- for the user profile or the domain. If InstanceType is not specified
57- in any of those three ResourceSpec values for a KernelGateway app,
58- the CreateApp call fails with a request validation error."
66+ description : |-
67+ The instance type and the Amazon Resource Name (ARN) of the SageMaker AI
68+ image created on the instance.
69+
70+ The value of InstanceType passed as part of the ResourceSpec in the CreateApp
71+ call overrides the value passed as part of the ResourceSpec configured for
72+ the user profile or the domain. If InstanceType is not specified in any of
73+ those three ResourceSpec values for a KernelGateway app, the CreateApp call
74+ fails with a request validation error.
5975 properties :
6076 instanceType :
6177 type : string
@@ -65,23 +81,35 @@ spec:
6581 type : string
6682 sageMakerImageVersionARN :
6783 type : string
84+ sageMakerImageVersionAlias :
85+ type : string
6886 type : object
87+ spaceName :
88+ description : |-
89+ The name of the space. If this value is not set, then UserProfileName must
90+ be set.
91+
92+ Regex Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$`
93+ type : string
6994 tags :
70- description : Each tag consists of a key and an optional value. Tag
71- keys must be unique per resource.
95+ description : |-
96+ Each tag consists of a key and an optional value. Tag keys must be unique
97+ per resource.
7298 items :
73- description : " A tag object that consists of a key and an optional
74- value, used to manage metadata for SageMaker Amazon Web Services
75- resources. \n You can add tags to notebook instances, training
76- jobs, hyperparameter tuning jobs, batch transform jobs, models,
77- labeling jobs, work teams, endpoint configurations, and endpoints.
78- For more information on adding tags to SageMaker resources, see
79- AddTags. \n For more information on adding metadata to your Amazon
80- Web Services resources with tagging, see Tagging Amazon Web Services
81- resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).
82- For advice on best practices for managing Amazon Web Services
83- resources with tagging, see Tagging Best Practices: Implement
84- an Effective Amazon Web Services Resource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf)."
99+ description : |-
100+ A tag object that consists of a key and an optional value, used to manage
101+ metadata for SageMaker Amazon Web Services resources.
102+
103+ You can add tags to notebook instances, training jobs, hyperparameter tuning
104+ jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,
105+ and endpoints. For more information on adding tags to SageMaker resources,
106+ see AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).
107+
108+ For more information on adding metadata to your Amazon Web Services resources
109+ with tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).
110+ For advice on best practices for managing Amazon Web Services resources with
111+ tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services
112+ Resource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf).
85113 properties :
86114 key :
87115 type : string
@@ -90,8 +118,10 @@ spec:
90118 type : object
91119 type : array
92120 userProfileName :
93- description : The user profile name. If this value is not set, then
94- SpaceName must be set.
121+ description : |-
122+ The user profile name. If this value is not set, then SpaceName must be set.
123+
124+ Regex Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$`
95125 type : string
96126 required :
97127 - appName
@@ -102,24 +132,25 @@ spec:
102132 description : AppStatus defines the observed state of App
103133 properties :
104134 ackResourceMetadata :
105- description : All CRs managed by ACK have a common `Status.ACKResourceMetadata`
106- member that is used to contain resource sync state, account ownership,
135+ description : |-
136+ All CRs managed by ACK have a common `Status.ACKResourceMetadata` member
137+ that is used to contain resource sync state, account ownership,
107138 constructed ARN for the resource
108139 properties :
109140 arn :
110- description : ' ARN is the Amazon Resource Name for the resource.
111- This is a globally-unique identifier and is set only by the
112- ACK service controller once the controller has orchestrated
113- the creation of the resource OR when it has verified that an
114- "adopted" resource (a resource where the ARN annotation was
115- set by the Kubernetes user on the CR) exists and matches the
116- supplied CR'' s Spec field values. TODO(vijat@): Find a better
117- strategy for resources that do not have ARN in CreateOutputResponse
118- https://github.com/aws/aws-controllers-k8s/issues/270'
141+ description : |-
142+ ARN is the Amazon Resource Name for the resource. This is a
143+ globally-unique identifier and is set only by the ACK service controller
144+ once the controller has orchestrated the creation of the resource OR
145+ when it has verified that an "adopted" resource (a resource where the
146+ ARN annotation was set by the Kubernetes user on the CR) exists and
147+ matches the supplied CR's Spec field values.
148+ https://github.com/aws/aws-controllers-k8s/issues/270
119149 type : string
120150 ownerAccountID :
121- description : OwnerAccountID is the AWS Account ID of the account
122- that owns the backend AWS service API resource.
151+ description : |-
152+ OwnerAccountID is the AWS Account ID of the account that owns the
153+ backend AWS service API resource.
123154 type : string
124155 region :
125156 description : Region is the AWS region in which the resource exists
@@ -130,14 +161,16 @@ spec:
130161 - region
131162 type : object
132163 conditions :
133- description : All CRS managed by ACK have a common `Status.Conditions`
134- member that contains a collection of `ackv1alpha1.Condition` objects
135- that describe the various terminal states of the CR and its backend
136- AWS service API resource
164+ description : |-
165+ All CRs managed by ACK have a common `Status.Conditions` member that
166+ contains a collection of `ackv1alpha1.Condition` objects that describe
167+ the various terminal states of the CR and its backend AWS service API
168+ resource
137169 items :
138- description : Condition is the common struct used by all CRDs managed
139- by ACK service controllers to indicate terminal states of the
140- CR and its backend AWS service API resource
170+ description : |-
171+ Condition is the common struct used by all CRDs managed by ACK service
172+ controllers to indicate terminal states of the CR and its backend AWS
173+ service API resource
141174 properties :
142175 lastTransitionTime :
143176 description : Last time the condition transitioned from one status
0 commit comments