AWS SDK for C++

AWS SDK for C++ Version 1.11.754

Loading...
Searching...
No Matches
DescribeSecretResult.h
1
6#pragma once
7#include <aws/core/utils/DateTime.h>
8#include <aws/core/utils/memory/stl/AWSMap.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/core/utils/memory/stl/AWSVector.h>
11#include <aws/secretsmanager/SecretsManager_EXPORTS.h>
12#include <aws/secretsmanager/model/ExternalSecretRotationMetadataItem.h>
13#include <aws/secretsmanager/model/ReplicationStatusType.h>
14#include <aws/secretsmanager/model/RotationRulesType.h>
15#include <aws/secretsmanager/model/Tag.h>
16
17#include <utility>
18
19namespace Aws {
20template <typename RESULT_TYPE>
21class AmazonWebServiceResult;
22
23namespace Utils {
24namespace Json {
25class JsonValue;
26} // namespace Json
27} // namespace Utils
28namespace SecretsManager {
29namespace Model {
31 public:
32 AWS_SECRETSMANAGER_API DescribeSecretResult() = default;
35
37
40 inline const Aws::String& GetARN() const { return m_aRN; }
41 template <typename ARNT = Aws::String>
42 void SetARN(ARNT&& value) {
43 m_aRNHasBeenSet = true;
44 m_aRN = std::forward<ARNT>(value);
45 }
46 template <typename ARNT = Aws::String>
48 SetARN(std::forward<ARNT>(value));
49 return *this;
50 }
52
54
57 inline const Aws::String& GetName() const { return m_name; }
58 template <typename NameT = Aws::String>
59 void SetName(NameT&& value) {
60 m_nameHasBeenSet = true;
61 m_name = std::forward<NameT>(value);
62 }
63 template <typename NameT = Aws::String>
65 SetName(std::forward<NameT>(value));
66 return *this;
67 }
69
71
77 inline const Aws::String& GetType() const { return m_type; }
78 template <typename TypeT = Aws::String>
79 void SetType(TypeT&& value) {
80 m_typeHasBeenSet = true;
81 m_type = std::forward<TypeT>(value);
82 }
83 template <typename TypeT = Aws::String>
85 SetType(std::forward<TypeT>(value));
86 return *this;
87 }
89
91
94 inline const Aws::String& GetDescription() const { return m_description; }
95 template <typename DescriptionT = Aws::String>
96 void SetDescription(DescriptionT&& value) {
97 m_descriptionHasBeenSet = true;
98 m_description = std::forward<DescriptionT>(value);
99 }
100 template <typename DescriptionT = Aws::String>
101 DescribeSecretResult& WithDescription(DescriptionT&& value) {
102 SetDescription(std::forward<DescriptionT>(value));
103 return *this;
104 }
106
108
114 inline const Aws::String& GetKmsKeyId() const { return m_kmsKeyId; }
115 template <typename KmsKeyIdT = Aws::String>
116 void SetKmsKeyId(KmsKeyIdT&& value) {
117 m_kmsKeyIdHasBeenSet = true;
118 m_kmsKeyId = std::forward<KmsKeyIdT>(value);
119 }
120 template <typename KmsKeyIdT = Aws::String>
121 DescribeSecretResult& WithKmsKeyId(KmsKeyIdT&& value) {
122 SetKmsKeyId(std::forward<KmsKeyIdT>(value));
123 return *this;
124 }
126
128
134 inline bool GetRotationEnabled() const { return m_rotationEnabled; }
135 inline void SetRotationEnabled(bool value) {
136 m_rotationEnabledHasBeenSet = true;
137 m_rotationEnabled = value;
138 }
140 SetRotationEnabled(value);
141 return *this;
142 }
144
146
150 inline const Aws::String& GetRotationLambdaARN() const { return m_rotationLambdaARN; }
151 template <typename RotationLambdaARNT = Aws::String>
152 void SetRotationLambdaARN(RotationLambdaARNT&& value) {
153 m_rotationLambdaARNHasBeenSet = true;
154 m_rotationLambdaARN = std::forward<RotationLambdaARNT>(value);
155 }
156 template <typename RotationLambdaARNT = Aws::String>
157 DescribeSecretResult& WithRotationLambdaARN(RotationLambdaARNT&& value) {
158 SetRotationLambdaARN(std::forward<RotationLambdaARNT>(value));
159 return *this;
160 }
162
164
170 inline const RotationRulesType& GetRotationRules() const { return m_rotationRules; }
171 template <typename RotationRulesT = RotationRulesType>
172 void SetRotationRules(RotationRulesT&& value) {
173 m_rotationRulesHasBeenSet = true;
174 m_rotationRules = std::forward<RotationRulesT>(value);
175 }
176 template <typename RotationRulesT = RotationRulesType>
177 DescribeSecretResult& WithRotationRules(RotationRulesT&& value) {
178 SetRotationRules(std::forward<RotationRulesT>(value));
179 return *this;
180 }
182
184
192 return m_externalSecretRotationMetadata;
193 }
194 template <typename ExternalSecretRotationMetadataT = Aws::Vector<ExternalSecretRotationMetadataItem>>
195 void SetExternalSecretRotationMetadata(ExternalSecretRotationMetadataT&& value) {
196 m_externalSecretRotationMetadataHasBeenSet = true;
197 m_externalSecretRotationMetadata = std::forward<ExternalSecretRotationMetadataT>(value);
198 }
199 template <typename ExternalSecretRotationMetadataT = Aws::Vector<ExternalSecretRotationMetadataItem>>
200 DescribeSecretResult& WithExternalSecretRotationMetadata(ExternalSecretRotationMetadataT&& value) {
201 SetExternalSecretRotationMetadata(std::forward<ExternalSecretRotationMetadataT>(value));
202 return *this;
203 }
204 template <typename ExternalSecretRotationMetadataT = ExternalSecretRotationMetadataItem>
205 DescribeSecretResult& AddExternalSecretRotationMetadata(ExternalSecretRotationMetadataT&& value) {
206 m_externalSecretRotationMetadataHasBeenSet = true;
207 m_externalSecretRotationMetadata.emplace_back(std::forward<ExternalSecretRotationMetadataT>(value));
208 return *this;
209 }
211
213
219 inline const Aws::String& GetExternalSecretRotationRoleArn() const { return m_externalSecretRotationRoleArn; }
220 template <typename ExternalSecretRotationRoleArnT = Aws::String>
221 void SetExternalSecretRotationRoleArn(ExternalSecretRotationRoleArnT&& value) {
222 m_externalSecretRotationRoleArnHasBeenSet = true;
223 m_externalSecretRotationRoleArn = std::forward<ExternalSecretRotationRoleArnT>(value);
224 }
225 template <typename ExternalSecretRotationRoleArnT = Aws::String>
226 DescribeSecretResult& WithExternalSecretRotationRoleArn(ExternalSecretRotationRoleArnT&& value) {
227 SetExternalSecretRotationRoleArn(std::forward<ExternalSecretRotationRoleArnT>(value));
228 return *this;
229 }
231
233
238 inline const Aws::Utils::DateTime& GetLastRotatedDate() const { return m_lastRotatedDate; }
239 template <typename LastRotatedDateT = Aws::Utils::DateTime>
240 void SetLastRotatedDate(LastRotatedDateT&& value) {
241 m_lastRotatedDateHasBeenSet = true;
242 m_lastRotatedDate = std::forward<LastRotatedDateT>(value);
243 }
244 template <typename LastRotatedDateT = Aws::Utils::DateTime>
245 DescribeSecretResult& WithLastRotatedDate(LastRotatedDateT&& value) {
246 SetLastRotatedDate(std::forward<LastRotatedDateT>(value));
247 return *this;
248 }
250
252
255 inline const Aws::Utils::DateTime& GetLastChangedDate() const { return m_lastChangedDate; }
256 template <typename LastChangedDateT = Aws::Utils::DateTime>
257 void SetLastChangedDate(LastChangedDateT&& value) {
258 m_lastChangedDateHasBeenSet = true;
259 m_lastChangedDate = std::forward<LastChangedDateT>(value);
260 }
261 template <typename LastChangedDateT = Aws::Utils::DateTime>
262 DescribeSecretResult& WithLastChangedDate(LastChangedDateT&& value) {
263 SetLastChangedDate(std::forward<LastChangedDateT>(value));
264 return *this;
265 }
267
269
273 inline const Aws::Utils::DateTime& GetLastAccessedDate() const { return m_lastAccessedDate; }
274 template <typename LastAccessedDateT = Aws::Utils::DateTime>
275 void SetLastAccessedDate(LastAccessedDateT&& value) {
276 m_lastAccessedDateHasBeenSet = true;
277 m_lastAccessedDate = std::forward<LastAccessedDateT>(value);
278 }
279 template <typename LastAccessedDateT = Aws::Utils::DateTime>
280 DescribeSecretResult& WithLastAccessedDate(LastAccessedDateT&& value) {
281 SetLastAccessedDate(std::forward<LastAccessedDateT>(value));
282 return *this;
283 }
285
287
296 inline const Aws::Utils::DateTime& GetDeletedDate() const { return m_deletedDate; }
297 template <typename DeletedDateT = Aws::Utils::DateTime>
298 void SetDeletedDate(DeletedDateT&& value) {
299 m_deletedDateHasBeenSet = true;
300 m_deletedDate = std::forward<DeletedDateT>(value);
301 }
302 template <typename DeletedDateT = Aws::Utils::DateTime>
303 DescribeSecretResult& WithDeletedDate(DeletedDateT&& value) {
304 SetDeletedDate(std::forward<DeletedDateT>(value));
305 return *this;
306 }
308
310
320 inline const Aws::Utils::DateTime& GetNextRotationDate() const { return m_nextRotationDate; }
321 template <typename NextRotationDateT = Aws::Utils::DateTime>
322 void SetNextRotationDate(NextRotationDateT&& value) {
323 m_nextRotationDateHasBeenSet = true;
324 m_nextRotationDate = std::forward<NextRotationDateT>(value);
325 }
326 template <typename NextRotationDateT = Aws::Utils::DateTime>
327 DescribeSecretResult& WithNextRotationDate(NextRotationDateT&& value) {
328 SetNextRotationDate(std::forward<NextRotationDateT>(value));
329 return *this;
330 }
332
334
338 inline const Aws::Vector<Tag>& GetTags() const { return m_tags; }
339 template <typename TagsT = Aws::Vector<Tag>>
340 void SetTags(TagsT&& value) {
341 m_tagsHasBeenSet = true;
342 m_tags = std::forward<TagsT>(value);
343 }
344 template <typename TagsT = Aws::Vector<Tag>>
346 SetTags(std::forward<TagsT>(value));
347 return *this;
348 }
349 template <typename TagsT = Tag>
351 m_tagsHasBeenSet = true;
352 m_tags.emplace_back(std::forward<TagsT>(value));
353 return *this;
354 }
356
358
376 inline const Aws::Map<Aws::String, Aws::Vector<Aws::String>>& GetVersionIdsToStages() const { return m_versionIdsToStages; }
377 template <typename VersionIdsToStagesT = Aws::Map<Aws::String, Aws::Vector<Aws::String>>>
378 void SetVersionIdsToStages(VersionIdsToStagesT&& value) {
379 m_versionIdsToStagesHasBeenSet = true;
380 m_versionIdsToStages = std::forward<VersionIdsToStagesT>(value);
381 }
382 template <typename VersionIdsToStagesT = Aws::Map<Aws::String, Aws::Vector<Aws::String>>>
383 DescribeSecretResult& WithVersionIdsToStages(VersionIdsToStagesT&& value) {
384 SetVersionIdsToStages(std::forward<VersionIdsToStagesT>(value));
385 return *this;
386 }
387 template <typename VersionIdsToStagesKeyT = Aws::String, typename VersionIdsToStagesValueT = Aws::Vector<Aws::String>>
388 DescribeSecretResult& AddVersionIdsToStages(VersionIdsToStagesKeyT&& key, VersionIdsToStagesValueT&& value) {
389 m_versionIdsToStagesHasBeenSet = true;
390 m_versionIdsToStages.emplace(std::forward<VersionIdsToStagesKeyT>(key), std::forward<VersionIdsToStagesValueT>(value));
391 return *this;
392 }
394
396
401 inline const Aws::String& GetOwningService() const { return m_owningService; }
402 template <typename OwningServiceT = Aws::String>
403 void SetOwningService(OwningServiceT&& value) {
404 m_owningServiceHasBeenSet = true;
405 m_owningService = std::forward<OwningServiceT>(value);
406 }
407 template <typename OwningServiceT = Aws::String>
408 DescribeSecretResult& WithOwningService(OwningServiceT&& value) {
409 SetOwningService(std::forward<OwningServiceT>(value));
410 return *this;
411 }
413
415
418 inline const Aws::Utils::DateTime& GetCreatedDate() const { return m_createdDate; }
419 template <typename CreatedDateT = Aws::Utils::DateTime>
420 void SetCreatedDate(CreatedDateT&& value) {
421 m_createdDateHasBeenSet = true;
422 m_createdDate = std::forward<CreatedDateT>(value);
423 }
424 template <typename CreatedDateT = Aws::Utils::DateTime>
425 DescribeSecretResult& WithCreatedDate(CreatedDateT&& value) {
426 SetCreatedDate(std::forward<CreatedDateT>(value));
427 return *this;
428 }
430
432
436 inline const Aws::String& GetPrimaryRegion() const { return m_primaryRegion; }
437 template <typename PrimaryRegionT = Aws::String>
438 void SetPrimaryRegion(PrimaryRegionT&& value) {
439 m_primaryRegionHasBeenSet = true;
440 m_primaryRegion = std::forward<PrimaryRegionT>(value);
441 }
442 template <typename PrimaryRegionT = Aws::String>
443 DescribeSecretResult& WithPrimaryRegion(PrimaryRegionT&& value) {
444 SetPrimaryRegion(std::forward<PrimaryRegionT>(value));
445 return *this;
446 }
448
450
457 inline const Aws::Vector<ReplicationStatusType>& GetReplicationStatus() const { return m_replicationStatus; }
458 template <typename ReplicationStatusT = Aws::Vector<ReplicationStatusType>>
459 void SetReplicationStatus(ReplicationStatusT&& value) {
460 m_replicationStatusHasBeenSet = true;
461 m_replicationStatus = std::forward<ReplicationStatusT>(value);
462 }
463 template <typename ReplicationStatusT = Aws::Vector<ReplicationStatusType>>
464 DescribeSecretResult& WithReplicationStatus(ReplicationStatusT&& value) {
465 SetReplicationStatus(std::forward<ReplicationStatusT>(value));
466 return *this;
467 }
468 template <typename ReplicationStatusT = ReplicationStatusType>
469 DescribeSecretResult& AddReplicationStatus(ReplicationStatusT&& value) {
470 m_replicationStatusHasBeenSet = true;
471 m_replicationStatus.emplace_back(std::forward<ReplicationStatusT>(value));
472 return *this;
473 }
475
477
478 inline const Aws::String& GetRequestId() const { return m_requestId; }
479 template <typename RequestIdT = Aws::String>
480 void SetRequestId(RequestIdT&& value) {
481 m_requestIdHasBeenSet = true;
482 m_requestId = std::forward<RequestIdT>(value);
483 }
484 template <typename RequestIdT = Aws::String>
485 DescribeSecretResult& WithRequestId(RequestIdT&& value) {
486 SetRequestId(std::forward<RequestIdT>(value));
487 return *this;
488 }
490 private:
491 Aws::String m_aRN;
492
493 Aws::String m_name;
494
495 Aws::String m_type;
496
497 Aws::String m_description;
498
499 Aws::String m_kmsKeyId;
500
501 bool m_rotationEnabled{false};
502
503 Aws::String m_rotationLambdaARN;
504
505 RotationRulesType m_rotationRules;
506
507 Aws::Vector<ExternalSecretRotationMetadataItem> m_externalSecretRotationMetadata;
508
509 Aws::String m_externalSecretRotationRoleArn;
510
511 Aws::Utils::DateTime m_lastRotatedDate{};
512
513 Aws::Utils::DateTime m_lastChangedDate{};
514
515 Aws::Utils::DateTime m_lastAccessedDate{};
516
517 Aws::Utils::DateTime m_deletedDate{};
518
519 Aws::Utils::DateTime m_nextRotationDate{};
520
521 Aws::Vector<Tag> m_tags;
522
524
525 Aws::String m_owningService;
526
527 Aws::Utils::DateTime m_createdDate{};
528
529 Aws::String m_primaryRegion;
530
531 Aws::Vector<ReplicationStatusType> m_replicationStatus;
532
533 Aws::String m_requestId;
534 bool m_aRNHasBeenSet = false;
535 bool m_nameHasBeenSet = false;
536 bool m_typeHasBeenSet = false;
537 bool m_descriptionHasBeenSet = false;
538 bool m_kmsKeyIdHasBeenSet = false;
539 bool m_rotationEnabledHasBeenSet = false;
540 bool m_rotationLambdaARNHasBeenSet = false;
541 bool m_rotationRulesHasBeenSet = false;
542 bool m_externalSecretRotationMetadataHasBeenSet = false;
543 bool m_externalSecretRotationRoleArnHasBeenSet = false;
544 bool m_lastRotatedDateHasBeenSet = false;
545 bool m_lastChangedDateHasBeenSet = false;
546 bool m_lastAccessedDateHasBeenSet = false;
547 bool m_deletedDateHasBeenSet = false;
548 bool m_nextRotationDateHasBeenSet = false;
549 bool m_tagsHasBeenSet = false;
550 bool m_versionIdsToStagesHasBeenSet = false;
551 bool m_owningServiceHasBeenSet = false;
552 bool m_createdDateHasBeenSet = false;
553 bool m_primaryRegionHasBeenSet = false;
554 bool m_replicationStatusHasBeenSet = false;
555 bool m_requestIdHasBeenSet = false;
556};
557
558} // namespace Model
559} // namespace SecretsManager
560} // namespace Aws
DescribeSecretResult & WithNextRotationDate(NextRotationDateT &&value)
const Aws::Utils::DateTime & GetNextRotationDate() const
const Aws::Map< Aws::String, Aws::Vector< Aws::String > > & GetVersionIdsToStages() const
DescribeSecretResult & WithRequestId(RequestIdT &&value)
DescribeSecretResult & WithCreatedDate(CreatedDateT &&value)
DescribeSecretResult & WithDescription(DescriptionT &&value)
const Aws::Vector< ReplicationStatusType > & GetReplicationStatus() const
DescribeSecretResult & WithRotationEnabled(bool value)
DescribeSecretResult & AddExternalSecretRotationMetadata(ExternalSecretRotationMetadataT &&value)
DescribeSecretResult & WithRotationLambdaARN(RotationLambdaARNT &&value)
AWS_SECRETSMANAGER_API DescribeSecretResult & operator=(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
DescribeSecretResult & WithLastChangedDate(LastChangedDateT &&value)
DescribeSecretResult & WithARN(ARNT &&value)
DescribeSecretResult & WithKmsKeyId(KmsKeyIdT &&value)
DescribeSecretResult & AddVersionIdsToStages(VersionIdsToStagesKeyT &&key, VersionIdsToStagesValueT &&value)
void SetVersionIdsToStages(VersionIdsToStagesT &&value)
DescribeSecretResult & WithLastAccessedDate(LastAccessedDateT &&value)
DescribeSecretResult & WithExternalSecretRotationMetadata(ExternalSecretRotationMetadataT &&value)
DescribeSecretResult & WithOwningService(OwningServiceT &&value)
DescribeSecretResult & WithType(TypeT &&value)
void SetRotationLambdaARN(RotationLambdaARNT &&value)
const Aws::Vector< ExternalSecretRotationMetadataItem > & GetExternalSecretRotationMetadata() const
void SetExternalSecretRotationRoleArn(ExternalSecretRotationRoleArnT &&value)
DescribeSecretResult & WithPrimaryRegion(PrimaryRegionT &&value)
DescribeSecretResult & WithLastRotatedDate(LastRotatedDateT &&value)
AWS_SECRETSMANAGER_API DescribeSecretResult()=default
DescribeSecretResult & WithExternalSecretRotationRoleArn(ExternalSecretRotationRoleArnT &&value)
DescribeSecretResult & WithVersionIdsToStages(VersionIdsToStagesT &&value)
DescribeSecretResult & AddReplicationStatus(ReplicationStatusT &&value)
DescribeSecretResult & AddTags(TagsT &&value)
AWS_SECRETSMANAGER_API DescribeSecretResult(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
const Aws::Utils::DateTime & GetCreatedDate() const
const Aws::Utils::DateTime & GetDeletedDate() const
const Aws::Utils::DateTime & GetLastRotatedDate() const
void SetReplicationStatus(ReplicationStatusT &&value)
void SetExternalSecretRotationMetadata(ExternalSecretRotationMetadataT &&value)
DescribeSecretResult & WithTags(TagsT &&value)
const Aws::Utils::DateTime & GetLastAccessedDate() const
DescribeSecretResult & WithRotationRules(RotationRulesT &&value)
const Aws::Utils::DateTime & GetLastChangedDate() const
DescribeSecretResult & WithName(NameT &&value)
DescribeSecretResult & WithDeletedDate(DeletedDateT &&value)
DescribeSecretResult & WithReplicationStatus(ReplicationStatusT &&value)
std::map< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > > Map
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector
Aws::Utils::Json::JsonValue JsonValue