AWS SDK for C++

AWS SDK for C++ Version 1.11.816

Loading...
Searching...
No Matches
DescribeDomainResult.h
1
6#pragma once
7#include <aws/core/http/HttpResponse.h>
8#include <aws/core/utils/DateTime.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/core/utils/memory/stl/AWSVector.h>
11#include <aws/sagemaker/SageMaker_EXPORTS.h>
12#include <aws/sagemaker/model/AppNetworkAccessType.h>
13#include <aws/sagemaker/model/AppSecurityGroupManagement.h>
14#include <aws/sagemaker/model/AuthMode.h>
15#include <aws/sagemaker/model/DefaultSpaceSettings.h>
16#include <aws/sagemaker/model/DomainSettings.h>
17#include <aws/sagemaker/model/DomainStatus.h>
18#include <aws/sagemaker/model/HomeEfsFileSystemCreation.h>
19#include <aws/sagemaker/model/TagPropagation.h>
20#include <aws/sagemaker/model/UserSettings.h>
21
22#include <utility>
23
24namespace Aws {
25template <typename RESULT_TYPE>
26class AmazonWebServiceResult;
27
28namespace Utils {
29namespace Json {
30class JsonValue;
31} // namespace Json
32} // namespace Utils
33namespace SageMaker {
34namespace Model {
36 public:
37 AWS_SAGEMAKER_API DescribeDomainResult() = default;
40
42
45 inline const Aws::String& GetDomainArn() const { return m_domainArn; }
46 template <typename DomainArnT = Aws::String>
47 void SetDomainArn(DomainArnT&& value) {
48 m_domainArnHasBeenSet = true;
49 m_domainArn = std::forward<DomainArnT>(value);
50 }
51 template <typename DomainArnT = Aws::String>
52 DescribeDomainResult& WithDomainArn(DomainArnT&& value) {
53 SetDomainArn(std::forward<DomainArnT>(value));
54 return *this;
55 }
57
59
62 inline const Aws::String& GetDomainId() const { return m_domainId; }
63 template <typename DomainIdT = Aws::String>
64 void SetDomainId(DomainIdT&& value) {
65 m_domainIdHasBeenSet = true;
66 m_domainId = std::forward<DomainIdT>(value);
67 }
68 template <typename DomainIdT = Aws::String>
69 DescribeDomainResult& WithDomainId(DomainIdT&& value) {
70 SetDomainId(std::forward<DomainIdT>(value));
71 return *this;
72 }
74
76
79 inline const Aws::String& GetDomainName() const { return m_domainName; }
80 template <typename DomainNameT = Aws::String>
81 void SetDomainName(DomainNameT&& value) {
82 m_domainNameHasBeenSet = true;
83 m_domainName = std::forward<DomainNameT>(value);
84 }
85 template <typename DomainNameT = Aws::String>
86 DescribeDomainResult& WithDomainName(DomainNameT&& value) {
87 SetDomainName(std::forward<DomainNameT>(value));
88 return *this;
89 }
91
93
96 inline const Aws::String& GetHomeEfsFileSystemId() const { return m_homeEfsFileSystemId; }
97 template <typename HomeEfsFileSystemIdT = Aws::String>
98 void SetHomeEfsFileSystemId(HomeEfsFileSystemIdT&& value) {
99 m_homeEfsFileSystemIdHasBeenSet = true;
100 m_homeEfsFileSystemId = std::forward<HomeEfsFileSystemIdT>(value);
101 }
102 template <typename HomeEfsFileSystemIdT = Aws::String>
103 DescribeDomainResult& WithHomeEfsFileSystemId(HomeEfsFileSystemIdT&& value) {
104 SetHomeEfsFileSystemId(std::forward<HomeEfsFileSystemIdT>(value));
105 return *this;
106 }
108
110
113 inline const Aws::String& GetSingleSignOnManagedApplicationInstanceId() const { return m_singleSignOnManagedApplicationInstanceId; }
114 template <typename SingleSignOnManagedApplicationInstanceIdT = Aws::String>
115 void SetSingleSignOnManagedApplicationInstanceId(SingleSignOnManagedApplicationInstanceIdT&& value) {
116 m_singleSignOnManagedApplicationInstanceIdHasBeenSet = true;
117 m_singleSignOnManagedApplicationInstanceId = std::forward<SingleSignOnManagedApplicationInstanceIdT>(value);
118 }
119 template <typename SingleSignOnManagedApplicationInstanceIdT = Aws::String>
120 DescribeDomainResult& WithSingleSignOnManagedApplicationInstanceId(SingleSignOnManagedApplicationInstanceIdT&& value) {
121 SetSingleSignOnManagedApplicationInstanceId(std::forward<SingleSignOnManagedApplicationInstanceIdT>(value));
122 return *this;
123 }
125
127
131 inline const Aws::String& GetSingleSignOnApplicationArn() const { return m_singleSignOnApplicationArn; }
132 template <typename SingleSignOnApplicationArnT = Aws::String>
133 void SetSingleSignOnApplicationArn(SingleSignOnApplicationArnT&& value) {
134 m_singleSignOnApplicationArnHasBeenSet = true;
135 m_singleSignOnApplicationArn = std::forward<SingleSignOnApplicationArnT>(value);
136 }
137 template <typename SingleSignOnApplicationArnT = Aws::String>
138 DescribeDomainResult& WithSingleSignOnApplicationArn(SingleSignOnApplicationArnT&& value) {
139 SetSingleSignOnApplicationArn(std::forward<SingleSignOnApplicationArnT>(value));
140 return *this;
141 }
143
145
148 inline DomainStatus GetStatus() const { return m_status; }
149 inline void SetStatus(DomainStatus value) {
150 m_statusHasBeenSet = true;
151 m_status = value;
152 }
154 SetStatus(value);
155 return *this;
156 }
158
160
163 inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; }
164 template <typename CreationTimeT = Aws::Utils::DateTime>
165 void SetCreationTime(CreationTimeT&& value) {
166 m_creationTimeHasBeenSet = true;
167 m_creationTime = std::forward<CreationTimeT>(value);
168 }
169 template <typename CreationTimeT = Aws::Utils::DateTime>
170 DescribeDomainResult& WithCreationTime(CreationTimeT&& value) {
171 SetCreationTime(std::forward<CreationTimeT>(value));
172 return *this;
173 }
175
177
180 inline const Aws::Utils::DateTime& GetLastModifiedTime() const { return m_lastModifiedTime; }
181 template <typename LastModifiedTimeT = Aws::Utils::DateTime>
182 void SetLastModifiedTime(LastModifiedTimeT&& value) {
183 m_lastModifiedTimeHasBeenSet = true;
184 m_lastModifiedTime = std::forward<LastModifiedTimeT>(value);
185 }
186 template <typename LastModifiedTimeT = Aws::Utils::DateTime>
187 DescribeDomainResult& WithLastModifiedTime(LastModifiedTimeT&& value) {
188 SetLastModifiedTime(std::forward<LastModifiedTimeT>(value));
189 return *this;
190 }
192
194
197 inline const Aws::String& GetFailureReason() const { return m_failureReason; }
198 template <typename FailureReasonT = Aws::String>
199 void SetFailureReason(FailureReasonT&& value) {
200 m_failureReasonHasBeenSet = true;
201 m_failureReason = std::forward<FailureReasonT>(value);
202 }
203 template <typename FailureReasonT = Aws::String>
204 DescribeDomainResult& WithFailureReason(FailureReasonT&& value) {
205 SetFailureReason(std::forward<FailureReasonT>(value));
206 return *this;
207 }
209
211
215 inline const Aws::String& GetSecurityGroupIdForDomainBoundary() const { return m_securityGroupIdForDomainBoundary; }
216 template <typename SecurityGroupIdForDomainBoundaryT = Aws::String>
217 void SetSecurityGroupIdForDomainBoundary(SecurityGroupIdForDomainBoundaryT&& value) {
218 m_securityGroupIdForDomainBoundaryHasBeenSet = true;
219 m_securityGroupIdForDomainBoundary = std::forward<SecurityGroupIdForDomainBoundaryT>(value);
220 }
221 template <typename SecurityGroupIdForDomainBoundaryT = Aws::String>
222 DescribeDomainResult& WithSecurityGroupIdForDomainBoundary(SecurityGroupIdForDomainBoundaryT&& value) {
223 SetSecurityGroupIdForDomainBoundary(std::forward<SecurityGroupIdForDomainBoundaryT>(value));
224 return *this;
225 }
227
229
232 inline AuthMode GetAuthMode() const { return m_authMode; }
233 inline void SetAuthMode(AuthMode value) {
234 m_authModeHasBeenSet = true;
235 m_authMode = value;
236 }
238 SetAuthMode(value);
239 return *this;
240 }
242
244
248 inline const UserSettings& GetDefaultUserSettings() const { return m_defaultUserSettings; }
249 template <typename DefaultUserSettingsT = UserSettings>
250 void SetDefaultUserSettings(DefaultUserSettingsT&& value) {
251 m_defaultUserSettingsHasBeenSet = true;
252 m_defaultUserSettings = std::forward<DefaultUserSettingsT>(value);
253 }
254 template <typename DefaultUserSettingsT = UserSettings>
255 DescribeDomainResult& WithDefaultUserSettings(DefaultUserSettingsT&& value) {
256 SetDefaultUserSettings(std::forward<DefaultUserSettingsT>(value));
257 return *this;
258 }
260
262
265 inline const DomainSettings& GetDomainSettings() const { return m_domainSettings; }
266 template <typename DomainSettingsT = DomainSettings>
267 void SetDomainSettings(DomainSettingsT&& value) {
268 m_domainSettingsHasBeenSet = true;
269 m_domainSettings = std::forward<DomainSettingsT>(value);
270 }
271 template <typename DomainSettingsT = DomainSettings>
272 DescribeDomainResult& WithDomainSettings(DomainSettingsT&& value) {
273 SetDomainSettings(std::forward<DomainSettingsT>(value));
274 return *this;
275 }
277
279
287 inline AppNetworkAccessType GetAppNetworkAccessType() const { return m_appNetworkAccessType; }
289 m_appNetworkAccessTypeHasBeenSet = true;
290 m_appNetworkAccessType = value;
291 }
294 return *this;
295 }
297
299
302 inline const Aws::Vector<Aws::String>& GetSubnetIds() const { return m_subnetIds; }
303 template <typename SubnetIdsT = Aws::Vector<Aws::String>>
304 void SetSubnetIds(SubnetIdsT&& value) {
305 m_subnetIdsHasBeenSet = true;
306 m_subnetIds = std::forward<SubnetIdsT>(value);
307 }
308 template <typename SubnetIdsT = Aws::Vector<Aws::String>>
309 DescribeDomainResult& WithSubnetIds(SubnetIdsT&& value) {
310 SetSubnetIds(std::forward<SubnetIdsT>(value));
311 return *this;
312 }
313 template <typename SubnetIdsT = Aws::String>
314 DescribeDomainResult& AddSubnetIds(SubnetIdsT&& value) {
315 m_subnetIdsHasBeenSet = true;
316 m_subnetIds.emplace_back(std::forward<SubnetIdsT>(value));
317 return *this;
318 }
320
322
325 inline const Aws::String& GetUrl() const { return m_url; }
326 template <typename UrlT = Aws::String>
327 void SetUrl(UrlT&& value) {
328 m_urlHasBeenSet = true;
329 m_url = std::forward<UrlT>(value);
330 }
331 template <typename UrlT = Aws::String>
333 SetUrl(std::forward<UrlT>(value));
334 return *this;
335 }
337
339
343 inline const Aws::String& GetVpcId() const { return m_vpcId; }
344 template <typename VpcIdT = Aws::String>
345 void SetVpcId(VpcIdT&& value) {
346 m_vpcIdHasBeenSet = true;
347 m_vpcId = std::forward<VpcIdT>(value);
348 }
349 template <typename VpcIdT = Aws::String>
351 SetVpcId(std::forward<VpcIdT>(value));
352 return *this;
353 }
355
357
361 inline const Aws::String& GetKmsKeyId() const { return m_kmsKeyId; }
362 template <typename KmsKeyIdT = Aws::String>
363 void SetKmsKeyId(KmsKeyIdT&& value) {
364 m_kmsKeyIdHasBeenSet = true;
365 m_kmsKeyId = std::forward<KmsKeyIdT>(value);
366 }
367 template <typename KmsKeyIdT = Aws::String>
368 DescribeDomainResult& WithKmsKeyId(KmsKeyIdT&& value) {
369 SetKmsKeyId(std::forward<KmsKeyIdT>(value));
370 return *this;
371 }
373
375
382 inline AppSecurityGroupManagement GetAppSecurityGroupManagement() const { return m_appSecurityGroupManagement; }
384 m_appSecurityGroupManagementHasBeenSet = true;
385 m_appSecurityGroupManagement = value;
386 }
389 return *this;
390 }
392
394
397 inline HomeEfsFileSystemCreation GetHomeEfsFileSystemCreation() const { return m_homeEfsFileSystemCreation; }
399 m_homeEfsFileSystemCreationHasBeenSet = true;
400 m_homeEfsFileSystemCreation = value;
401 }
404 return *this;
405 }
407
409
412 inline TagPropagation GetTagPropagation() const { return m_tagPropagation; }
414 m_tagPropagationHasBeenSet = true;
415 m_tagPropagation = value;
416 }
418 SetTagPropagation(value);
419 return *this;
420 }
422
424
427 inline const DefaultSpaceSettings& GetDefaultSpaceSettings() const { return m_defaultSpaceSettings; }
428 template <typename DefaultSpaceSettingsT = DefaultSpaceSettings>
429 void SetDefaultSpaceSettings(DefaultSpaceSettingsT&& value) {
430 m_defaultSpaceSettingsHasBeenSet = true;
431 m_defaultSpaceSettings = std::forward<DefaultSpaceSettingsT>(value);
432 }
433 template <typename DefaultSpaceSettingsT = DefaultSpaceSettings>
434 DescribeDomainResult& WithDefaultSpaceSettings(DefaultSpaceSettingsT&& value) {
435 SetDefaultSpaceSettings(std::forward<DefaultSpaceSettingsT>(value));
436 return *this;
437 }
439
441
442 inline const Aws::String& GetRequestId() const { return m_requestId; }
443 template <typename RequestIdT = Aws::String>
444 void SetRequestId(RequestIdT&& value) {
445 m_requestIdHasBeenSet = true;
446 m_requestId = std::forward<RequestIdT>(value);
447 }
448 template <typename RequestIdT = Aws::String>
449 DescribeDomainResult& WithRequestId(RequestIdT&& value) {
450 SetRequestId(std::forward<RequestIdT>(value));
451 return *this;
452 }
454 inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; }
455
456 private:
457 Aws::String m_domainArn;
458
459 Aws::String m_domainId;
460
461 Aws::String m_domainName;
462
463 Aws::String m_homeEfsFileSystemId;
464
465 Aws::String m_singleSignOnManagedApplicationInstanceId;
466
467 Aws::String m_singleSignOnApplicationArn;
468
470
471 Aws::Utils::DateTime m_creationTime{};
472
473 Aws::Utils::DateTime m_lastModifiedTime{};
474
475 Aws::String m_failureReason;
476
477 Aws::String m_securityGroupIdForDomainBoundary;
478
479 AuthMode m_authMode{AuthMode::NOT_SET};
480
481 UserSettings m_defaultUserSettings;
482
483 DomainSettings m_domainSettings;
484
486
487 Aws::Vector<Aws::String> m_subnetIds;
488
489 Aws::String m_url;
490
491 Aws::String m_vpcId;
492
493 Aws::String m_kmsKeyId;
494
496
498
499 TagPropagation m_tagPropagation{TagPropagation::NOT_SET};
500
501 DefaultSpaceSettings m_defaultSpaceSettings;
502
503 Aws::String m_requestId;
504 Aws::Http::HttpResponseCode m_HttpResponseCode;
505 bool m_domainArnHasBeenSet = false;
506 bool m_domainIdHasBeenSet = false;
507 bool m_domainNameHasBeenSet = false;
508 bool m_homeEfsFileSystemIdHasBeenSet = false;
509 bool m_singleSignOnManagedApplicationInstanceIdHasBeenSet = false;
510 bool m_singleSignOnApplicationArnHasBeenSet = false;
511 bool m_statusHasBeenSet = false;
512 bool m_creationTimeHasBeenSet = false;
513 bool m_lastModifiedTimeHasBeenSet = false;
514 bool m_failureReasonHasBeenSet = false;
515 bool m_securityGroupIdForDomainBoundaryHasBeenSet = false;
516 bool m_authModeHasBeenSet = false;
517 bool m_defaultUserSettingsHasBeenSet = false;
518 bool m_domainSettingsHasBeenSet = false;
519 bool m_appNetworkAccessTypeHasBeenSet = false;
520 bool m_subnetIdsHasBeenSet = false;
521 bool m_urlHasBeenSet = false;
522 bool m_vpcIdHasBeenSet = false;
523 bool m_kmsKeyIdHasBeenSet = false;
524 bool m_appSecurityGroupManagementHasBeenSet = false;
525 bool m_homeEfsFileSystemCreationHasBeenSet = false;
526 bool m_tagPropagationHasBeenSet = false;
527 bool m_defaultSpaceSettingsHasBeenSet = false;
528 bool m_requestIdHasBeenSet = false;
529};
530
531} // namespace Model
532} // namespace SageMaker
533} // namespace Aws
DescribeDomainResult & WithSecurityGroupIdForDomainBoundary(SecurityGroupIdForDomainBoundaryT &&value)
DescribeDomainResult & WithHomeEfsFileSystemCreation(HomeEfsFileSystemCreation value)
DescribeDomainResult & WithDomainArn(DomainArnT &&value)
DescribeDomainResult & WithKmsKeyId(KmsKeyIdT &&value)
DescribeDomainResult & WithTagPropagation(TagPropagation value)
DescribeDomainResult & WithSingleSignOnApplicationArn(SingleSignOnApplicationArnT &&value)
void SetSingleSignOnApplicationArn(SingleSignOnApplicationArnT &&value)
DescribeDomainResult & WithDomainSettings(DomainSettingsT &&value)
DescribeDomainResult & WithAuthMode(AuthMode value)
DescribeDomainResult & WithCreationTime(CreationTimeT &&value)
DescribeDomainResult & WithVpcId(VpcIdT &&value)
HomeEfsFileSystemCreation GetHomeEfsFileSystemCreation() const
AWS_SAGEMAKER_API DescribeDomainResult & operator=(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
void SetSingleSignOnManagedApplicationInstanceId(SingleSignOnManagedApplicationInstanceIdT &&value)
const Aws::String & GetSecurityGroupIdForDomainBoundary() const
DescribeDomainResult & WithAppSecurityGroupManagement(AppSecurityGroupManagement value)
void SetHomeEfsFileSystemCreation(HomeEfsFileSystemCreation value)
const DefaultSpaceSettings & GetDefaultSpaceSettings() const
DescribeDomainResult & WithDomainId(DomainIdT &&value)
DescribeDomainResult & WithStatus(DomainStatus value)
void SetDefaultSpaceSettings(DefaultSpaceSettingsT &&value)
void SetAppNetworkAccessType(AppNetworkAccessType value)
DescribeDomainResult & WithUrl(UrlT &&value)
const DomainSettings & GetDomainSettings() const
void SetLastModifiedTime(LastModifiedTimeT &&value)
const Aws::Utils::DateTime & GetCreationTime() const
DescribeDomainResult & WithSubnetIds(SubnetIdsT &&value)
DescribeDomainResult & AddSubnetIds(SubnetIdsT &&value)
void SetDefaultUserSettings(DefaultUserSettingsT &&value)
DescribeDomainResult & WithRequestId(RequestIdT &&value)
void SetAppSecurityGroupManagement(AppSecurityGroupManagement value)
const Aws::String & GetSingleSignOnManagedApplicationInstanceId() const
DescribeDomainResult & WithLastModifiedTime(LastModifiedTimeT &&value)
Aws::Http::HttpResponseCode GetHttpResponseCode() const
DescribeDomainResult & WithDefaultUserSettings(DefaultUserSettingsT &&value)
AWS_SAGEMAKER_API DescribeDomainResult()=default
void SetSecurityGroupIdForDomainBoundary(SecurityGroupIdForDomainBoundaryT &&value)
const UserSettings & GetDefaultUserSettings() const
DescribeDomainResult & WithAppNetworkAccessType(AppNetworkAccessType value)
const Aws::String & GetSingleSignOnApplicationArn() const
AWS_SAGEMAKER_API DescribeDomainResult(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
const Aws::Vector< Aws::String > & GetSubnetIds() const
const Aws::Utils::DateTime & GetLastModifiedTime() const
AppNetworkAccessType GetAppNetworkAccessType() const
DescribeDomainResult & WithHomeEfsFileSystemId(HomeEfsFileSystemIdT &&value)
void SetHomeEfsFileSystemId(HomeEfsFileSystemIdT &&value)
AppSecurityGroupManagement GetAppSecurityGroupManagement() const
DescribeDomainResult & WithSingleSignOnManagedApplicationInstanceId(SingleSignOnManagedApplicationInstanceIdT &&value)
DescribeDomainResult & WithFailureReason(FailureReasonT &&value)
DescribeDomainResult & WithDefaultSpaceSettings(DefaultSpaceSettingsT &&value)
DescribeDomainResult & WithDomainName(DomainNameT &&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