AWS SDK for C++

AWS SDK for C++ Version 1.11.644

Loading...
Searching...
No Matches
DescribeNotebookInstanceResult.h
1
6#pragma once
7#include <aws/sagemaker/SageMaker_EXPORTS.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/sagemaker/model/NotebookInstanceStatus.h>
10#include <aws/sagemaker/model/InstanceType.h>
11#include <aws/sagemaker/model/IPAddressType.h>
12#include <aws/core/utils/memory/stl/AWSVector.h>
13#include <aws/core/utils/DateTime.h>
14#include <aws/sagemaker/model/DirectInternetAccess.h>
15#include <aws/sagemaker/model/RootAccess.h>
16#include <aws/sagemaker/model/InstanceMetadataServiceConfiguration.h>
17#include <aws/sagemaker/model/NotebookInstanceAcceleratorType.h>
18#include <utility>
19
20namespace Aws
21{
22template<typename RESULT_TYPE>
23class AmazonWebServiceResult;
24
25namespace Utils
26{
27namespace Json
28{
29 class JsonValue;
30} // namespace Json
31} // namespace Utils
32namespace SageMaker
33{
34namespace Model
35{
37 {
38 public:
39 AWS_SAGEMAKER_API DescribeNotebookInstanceResult() = default;
42
43
45
48 inline const Aws::String& GetNotebookInstanceArn() const { return m_notebookInstanceArn; }
49 template<typename NotebookInstanceArnT = Aws::String>
50 void SetNotebookInstanceArn(NotebookInstanceArnT&& value) { m_notebookInstanceArnHasBeenSet = true; m_notebookInstanceArn = std::forward<NotebookInstanceArnT>(value); }
51 template<typename NotebookInstanceArnT = Aws::String>
52 DescribeNotebookInstanceResult& WithNotebookInstanceArn(NotebookInstanceArnT&& value) { SetNotebookInstanceArn(std::forward<NotebookInstanceArnT>(value)); return *this;}
54
56
59 inline const Aws::String& GetNotebookInstanceName() const { return m_notebookInstanceName; }
60 template<typename NotebookInstanceNameT = Aws::String>
61 void SetNotebookInstanceName(NotebookInstanceNameT&& value) { m_notebookInstanceNameHasBeenSet = true; m_notebookInstanceName = std::forward<NotebookInstanceNameT>(value); }
62 template<typename NotebookInstanceNameT = Aws::String>
63 DescribeNotebookInstanceResult& WithNotebookInstanceName(NotebookInstanceNameT&& value) { SetNotebookInstanceName(std::forward<NotebookInstanceNameT>(value)); return *this;}
65
67
70 inline NotebookInstanceStatus GetNotebookInstanceStatus() const { return m_notebookInstanceStatus; }
71 inline void SetNotebookInstanceStatus(NotebookInstanceStatus value) { m_notebookInstanceStatusHasBeenSet = true; m_notebookInstanceStatus = value; }
74
76
79 inline const Aws::String& GetFailureReason() const { return m_failureReason; }
80 template<typename FailureReasonT = Aws::String>
81 void SetFailureReason(FailureReasonT&& value) { m_failureReasonHasBeenSet = true; m_failureReason = std::forward<FailureReasonT>(value); }
82 template<typename FailureReasonT = Aws::String>
83 DescribeNotebookInstanceResult& WithFailureReason(FailureReasonT&& value) { SetFailureReason(std::forward<FailureReasonT>(value)); return *this;}
85
87
91 inline const Aws::String& GetUrl() const { return m_url; }
92 template<typename UrlT = Aws::String>
93 void SetUrl(UrlT&& value) { m_urlHasBeenSet = true; m_url = std::forward<UrlT>(value); }
94 template<typename UrlT = Aws::String>
95 DescribeNotebookInstanceResult& WithUrl(UrlT&& value) { SetUrl(std::forward<UrlT>(value)); return *this;}
97
99
102 inline InstanceType GetInstanceType() const { return m_instanceType; }
103 inline void SetInstanceType(InstanceType value) { m_instanceTypeHasBeenSet = true; m_instanceType = value; }
106
108
113 inline IPAddressType GetIpAddressType() const { return m_ipAddressType; }
114 inline void SetIpAddressType(IPAddressType value) { m_ipAddressTypeHasBeenSet = true; m_ipAddressType = value; }
117
119
122 inline const Aws::String& GetSubnetId() const { return m_subnetId; }
123 template<typename SubnetIdT = Aws::String>
124 void SetSubnetId(SubnetIdT&& value) { m_subnetIdHasBeenSet = true; m_subnetId = std::forward<SubnetIdT>(value); }
125 template<typename SubnetIdT = Aws::String>
126 DescribeNotebookInstanceResult& WithSubnetId(SubnetIdT&& value) { SetSubnetId(std::forward<SubnetIdT>(value)); return *this;}
128
130
133 inline const Aws::Vector<Aws::String>& GetSecurityGroups() const { return m_securityGroups; }
134 template<typename SecurityGroupsT = Aws::Vector<Aws::String>>
135 void SetSecurityGroups(SecurityGroupsT&& value) { m_securityGroupsHasBeenSet = true; m_securityGroups = std::forward<SecurityGroupsT>(value); }
136 template<typename SecurityGroupsT = Aws::Vector<Aws::String>>
137 DescribeNotebookInstanceResult& WithSecurityGroups(SecurityGroupsT&& value) { SetSecurityGroups(std::forward<SecurityGroupsT>(value)); return *this;}
138 template<typename SecurityGroupsT = Aws::String>
139 DescribeNotebookInstanceResult& AddSecurityGroups(SecurityGroupsT&& value) { m_securityGroupsHasBeenSet = true; m_securityGroups.emplace_back(std::forward<SecurityGroupsT>(value)); return *this; }
141
143
147 inline const Aws::String& GetRoleArn() const { return m_roleArn; }
148 template<typename RoleArnT = Aws::String>
149 void SetRoleArn(RoleArnT&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::forward<RoleArnT>(value); }
150 template<typename RoleArnT = Aws::String>
151 DescribeNotebookInstanceResult& WithRoleArn(RoleArnT&& value) { SetRoleArn(std::forward<RoleArnT>(value)); return *this;}
153
155
159 inline const Aws::String& GetKmsKeyId() const { return m_kmsKeyId; }
160 template<typename KmsKeyIdT = Aws::String>
161 void SetKmsKeyId(KmsKeyIdT&& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = std::forward<KmsKeyIdT>(value); }
162 template<typename KmsKeyIdT = Aws::String>
163 DescribeNotebookInstanceResult& WithKmsKeyId(KmsKeyIdT&& value) { SetKmsKeyId(std::forward<KmsKeyIdT>(value)); return *this;}
165
167
171 inline const Aws::String& GetNetworkInterfaceId() const { return m_networkInterfaceId; }
172 template<typename NetworkInterfaceIdT = Aws::String>
173 void SetNetworkInterfaceId(NetworkInterfaceIdT&& value) { m_networkInterfaceIdHasBeenSet = true; m_networkInterfaceId = std::forward<NetworkInterfaceIdT>(value); }
174 template<typename NetworkInterfaceIdT = Aws::String>
175 DescribeNotebookInstanceResult& WithNetworkInterfaceId(NetworkInterfaceIdT&& value) { SetNetworkInterfaceId(std::forward<NetworkInterfaceIdT>(value)); return *this;}
177
179
183 inline const Aws::Utils::DateTime& GetLastModifiedTime() const { return m_lastModifiedTime; }
184 template<typename LastModifiedTimeT = Aws::Utils::DateTime>
185 void SetLastModifiedTime(LastModifiedTimeT&& value) { m_lastModifiedTimeHasBeenSet = true; m_lastModifiedTime = std::forward<LastModifiedTimeT>(value); }
186 template<typename LastModifiedTimeT = Aws::Utils::DateTime>
187 DescribeNotebookInstanceResult& WithLastModifiedTime(LastModifiedTimeT&& value) { SetLastModifiedTime(std::forward<LastModifiedTimeT>(value)); return *this;}
189
191
195 inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; }
196 template<typename CreationTimeT = Aws::Utils::DateTime>
197 void SetCreationTime(CreationTimeT&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::forward<CreationTimeT>(value); }
198 template<typename CreationTimeT = Aws::Utils::DateTime>
199 DescribeNotebookInstanceResult& WithCreationTime(CreationTimeT&& value) { SetCreationTime(std::forward<CreationTimeT>(value)); return *this;}
201
203
209 inline const Aws::String& GetNotebookInstanceLifecycleConfigName() const { return m_notebookInstanceLifecycleConfigName; }
210 template<typename NotebookInstanceLifecycleConfigNameT = Aws::String>
211 void SetNotebookInstanceLifecycleConfigName(NotebookInstanceLifecycleConfigNameT&& value) { m_notebookInstanceLifecycleConfigNameHasBeenSet = true; m_notebookInstanceLifecycleConfigName = std::forward<NotebookInstanceLifecycleConfigNameT>(value); }
212 template<typename NotebookInstanceLifecycleConfigNameT = Aws::String>
213 DescribeNotebookInstanceResult& WithNotebookInstanceLifecycleConfigName(NotebookInstanceLifecycleConfigNameT&& value) { SetNotebookInstanceLifecycleConfigName(std::forward<NotebookInstanceLifecycleConfigNameT>(value)); return *this;}
215
217
225 inline DirectInternetAccess GetDirectInternetAccess() const { return m_directInternetAccess; }
226 inline void SetDirectInternetAccess(DirectInternetAccess value) { m_directInternetAccessHasBeenSet = true; m_directInternetAccess = value; }
229
231
235 inline int GetVolumeSizeInGB() const { return m_volumeSizeInGB; }
236 inline void SetVolumeSizeInGB(int value) { m_volumeSizeInGBHasBeenSet = true; m_volumeSizeInGB = value; }
237 inline DescribeNotebookInstanceResult& WithVolumeSizeInGB(int value) { SetVolumeSizeInGB(value); return *this;}
239
241
246 inline const Aws::Vector<NotebookInstanceAcceleratorType>& GetAcceleratorTypes() const { return m_acceleratorTypes; }
247 template<typename AcceleratorTypesT = Aws::Vector<NotebookInstanceAcceleratorType>>
248 void SetAcceleratorTypes(AcceleratorTypesT&& value) { m_acceleratorTypesHasBeenSet = true; m_acceleratorTypes = std::forward<AcceleratorTypesT>(value); }
249 template<typename AcceleratorTypesT = Aws::Vector<NotebookInstanceAcceleratorType>>
250 DescribeNotebookInstanceResult& WithAcceleratorTypes(AcceleratorTypesT&& value) { SetAcceleratorTypes(std::forward<AcceleratorTypesT>(value)); return *this;}
251 inline DescribeNotebookInstanceResult& AddAcceleratorTypes(NotebookInstanceAcceleratorType value) { m_acceleratorTypesHasBeenSet = true; m_acceleratorTypes.push_back(value); return *this; }
253
255
266 inline const Aws::String& GetDefaultCodeRepository() const { return m_defaultCodeRepository; }
267 template<typename DefaultCodeRepositoryT = Aws::String>
268 void SetDefaultCodeRepository(DefaultCodeRepositoryT&& value) { m_defaultCodeRepositoryHasBeenSet = true; m_defaultCodeRepository = std::forward<DefaultCodeRepositoryT>(value); }
269 template<typename DefaultCodeRepositoryT = Aws::String>
270 DescribeNotebookInstanceResult& WithDefaultCodeRepository(DefaultCodeRepositoryT&& value) { SetDefaultCodeRepository(std::forward<DefaultCodeRepositoryT>(value)); return *this;}
272
274
285 inline const Aws::Vector<Aws::String>& GetAdditionalCodeRepositories() const { return m_additionalCodeRepositories; }
286 template<typename AdditionalCodeRepositoriesT = Aws::Vector<Aws::String>>
287 void SetAdditionalCodeRepositories(AdditionalCodeRepositoriesT&& value) { m_additionalCodeRepositoriesHasBeenSet = true; m_additionalCodeRepositories = std::forward<AdditionalCodeRepositoriesT>(value); }
288 template<typename AdditionalCodeRepositoriesT = Aws::Vector<Aws::String>>
289 DescribeNotebookInstanceResult& WithAdditionalCodeRepositories(AdditionalCodeRepositoriesT&& value) { SetAdditionalCodeRepositories(std::forward<AdditionalCodeRepositoriesT>(value)); return *this;}
290 template<typename AdditionalCodeRepositoriesT = Aws::String>
291 DescribeNotebookInstanceResult& AddAdditionalCodeRepositories(AdditionalCodeRepositoriesT&& value) { m_additionalCodeRepositoriesHasBeenSet = true; m_additionalCodeRepositories.emplace_back(std::forward<AdditionalCodeRepositoriesT>(value)); return *this; }
293
295
302 inline RootAccess GetRootAccess() const { return m_rootAccess; }
303 inline void SetRootAccess(RootAccess value) { m_rootAccessHasBeenSet = true; m_rootAccess = value; }
306
308
311 inline const Aws::String& GetPlatformIdentifier() const { return m_platformIdentifier; }
312 template<typename PlatformIdentifierT = Aws::String>
313 void SetPlatformIdentifier(PlatformIdentifierT&& value) { m_platformIdentifierHasBeenSet = true; m_platformIdentifier = std::forward<PlatformIdentifierT>(value); }
314 template<typename PlatformIdentifierT = Aws::String>
315 DescribeNotebookInstanceResult& WithPlatformIdentifier(PlatformIdentifierT&& value) { SetPlatformIdentifier(std::forward<PlatformIdentifierT>(value)); return *this;}
317
319
322 inline const InstanceMetadataServiceConfiguration& GetInstanceMetadataServiceConfiguration() const { return m_instanceMetadataServiceConfiguration; }
323 template<typename InstanceMetadataServiceConfigurationT = InstanceMetadataServiceConfiguration>
324 void SetInstanceMetadataServiceConfiguration(InstanceMetadataServiceConfigurationT&& value) { m_instanceMetadataServiceConfigurationHasBeenSet = true; m_instanceMetadataServiceConfiguration = std::forward<InstanceMetadataServiceConfigurationT>(value); }
325 template<typename InstanceMetadataServiceConfigurationT = InstanceMetadataServiceConfiguration>
326 DescribeNotebookInstanceResult& WithInstanceMetadataServiceConfiguration(InstanceMetadataServiceConfigurationT&& value) { SetInstanceMetadataServiceConfiguration(std::forward<InstanceMetadataServiceConfigurationT>(value)); return *this;}
328
330
331 inline const Aws::String& GetRequestId() const { return m_requestId; }
332 template<typename RequestIdT = Aws::String>
333 void SetRequestId(RequestIdT&& value) { m_requestIdHasBeenSet = true; m_requestId = std::forward<RequestIdT>(value); }
334 template<typename RequestIdT = Aws::String>
335 DescribeNotebookInstanceResult& WithRequestId(RequestIdT&& value) { SetRequestId(std::forward<RequestIdT>(value)); return *this;}
337 private:
338
339 Aws::String m_notebookInstanceArn;
340 bool m_notebookInstanceArnHasBeenSet = false;
341
342 Aws::String m_notebookInstanceName;
343 bool m_notebookInstanceNameHasBeenSet = false;
344
346 bool m_notebookInstanceStatusHasBeenSet = false;
347
348 Aws::String m_failureReason;
349 bool m_failureReasonHasBeenSet = false;
350
351 Aws::String m_url;
352 bool m_urlHasBeenSet = false;
353
354 InstanceType m_instanceType{InstanceType::NOT_SET};
355 bool m_instanceTypeHasBeenSet = false;
356
357 IPAddressType m_ipAddressType{IPAddressType::NOT_SET};
358 bool m_ipAddressTypeHasBeenSet = false;
359
360 Aws::String m_subnetId;
361 bool m_subnetIdHasBeenSet = false;
362
363 Aws::Vector<Aws::String> m_securityGroups;
364 bool m_securityGroupsHasBeenSet = false;
365
366 Aws::String m_roleArn;
367 bool m_roleArnHasBeenSet = false;
368
369 Aws::String m_kmsKeyId;
370 bool m_kmsKeyIdHasBeenSet = false;
371
372 Aws::String m_networkInterfaceId;
373 bool m_networkInterfaceIdHasBeenSet = false;
374
375 Aws::Utils::DateTime m_lastModifiedTime{};
376 bool m_lastModifiedTimeHasBeenSet = false;
377
378 Aws::Utils::DateTime m_creationTime{};
379 bool m_creationTimeHasBeenSet = false;
380
381 Aws::String m_notebookInstanceLifecycleConfigName;
382 bool m_notebookInstanceLifecycleConfigNameHasBeenSet = false;
383
385 bool m_directInternetAccessHasBeenSet = false;
386
387 int m_volumeSizeInGB{0};
388 bool m_volumeSizeInGBHasBeenSet = false;
389
391 bool m_acceleratorTypesHasBeenSet = false;
392
393 Aws::String m_defaultCodeRepository;
394 bool m_defaultCodeRepositoryHasBeenSet = false;
395
396 Aws::Vector<Aws::String> m_additionalCodeRepositories;
397 bool m_additionalCodeRepositoriesHasBeenSet = false;
398
399 RootAccess m_rootAccess{RootAccess::NOT_SET};
400 bool m_rootAccessHasBeenSet = false;
401
402 Aws::String m_platformIdentifier;
403 bool m_platformIdentifierHasBeenSet = false;
404
405 InstanceMetadataServiceConfiguration m_instanceMetadataServiceConfiguration;
406 bool m_instanceMetadataServiceConfigurationHasBeenSet = false;
407
408 Aws::String m_requestId;
409 bool m_requestIdHasBeenSet = false;
410 };
411
412} // namespace Model
413} // namespace SageMaker
414} // namespace Aws
DescribeNotebookInstanceResult & WithNotebookInstanceLifecycleConfigName(NotebookInstanceLifecycleConfigNameT &&value)
DescribeNotebookInstanceResult & WithAdditionalCodeRepositories(AdditionalCodeRepositoriesT &&value)
void SetNotebookInstanceLifecycleConfigName(NotebookInstanceLifecycleConfigNameT &&value)
DescribeNotebookInstanceResult & WithKmsKeyId(KmsKeyIdT &&value)
DescribeNotebookInstanceResult & WithRequestId(RequestIdT &&value)
DescribeNotebookInstanceResult & WithSecurityGroups(SecurityGroupsT &&value)
DescribeNotebookInstanceResult & WithSubnetId(SubnetIdT &&value)
DescribeNotebookInstanceResult & WithPlatformIdentifier(PlatformIdentifierT &&value)
DescribeNotebookInstanceResult & WithDefaultCodeRepository(DefaultCodeRepositoryT &&value)
DescribeNotebookInstanceResult & WithLastModifiedTime(LastModifiedTimeT &&value)
DescribeNotebookInstanceResult & WithRoleArn(RoleArnT &&value)
DescribeNotebookInstanceResult & AddAdditionalCodeRepositories(AdditionalCodeRepositoriesT &&value)
DescribeNotebookInstanceResult & WithInstanceType(InstanceType value)
DescribeNotebookInstanceResult & WithNotebookInstanceArn(NotebookInstanceArnT &&value)
DescribeNotebookInstanceResult & WithIpAddressType(IPAddressType value)
void SetAdditionalCodeRepositories(AdditionalCodeRepositoriesT &&value)
DescribeNotebookInstanceResult & WithFailureReason(FailureReasonT &&value)
DescribeNotebookInstanceResult & WithNotebookInstanceStatus(NotebookInstanceStatus value)
DescribeNotebookInstanceResult & WithInstanceMetadataServiceConfiguration(InstanceMetadataServiceConfigurationT &&value)
AWS_SAGEMAKER_API DescribeNotebookInstanceResult()=default
void SetInstanceMetadataServiceConfiguration(InstanceMetadataServiceConfigurationT &&value)
DescribeNotebookInstanceResult & WithNotebookInstanceName(NotebookInstanceNameT &&value)
DescribeNotebookInstanceResult & AddAcceleratorTypes(NotebookInstanceAcceleratorType value)
const Aws::Vector< Aws::String > & GetAdditionalCodeRepositories() const
DescribeNotebookInstanceResult & WithNetworkInterfaceId(NetworkInterfaceIdT &&value)
DescribeNotebookInstanceResult & WithRootAccess(RootAccess value)
DescribeNotebookInstanceResult & WithVolumeSizeInGB(int value)
DescribeNotebookInstanceResult & WithAcceleratorTypes(AcceleratorTypesT &&value)
DescribeNotebookInstanceResult & WithDirectInternetAccess(DirectInternetAccess value)
AWS_SAGEMAKER_API DescribeNotebookInstanceResult(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
const InstanceMetadataServiceConfiguration & GetInstanceMetadataServiceConfiguration() const
DescribeNotebookInstanceResult & AddSecurityGroups(SecurityGroupsT &&value)
const Aws::Vector< NotebookInstanceAcceleratorType > & GetAcceleratorTypes() const
DescribeNotebookInstanceResult & WithUrl(UrlT &&value)
AWS_SAGEMAKER_API DescribeNotebookInstanceResult & operator=(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
DescribeNotebookInstanceResult & WithCreationTime(CreationTimeT &&value)
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector
Aws::Utils::Json::JsonValue JsonValue