AWS SDK for C++

AWS SDK for C++ Version 1.11.759

Loading...
Searching...
No Matches
DescribeSecretResult.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/AWSMap.h>
10#include <aws/core/utils/memory/stl/AWSString.h>
11#include <aws/core/utils/memory/stl/AWSVector.h>
12#include <aws/secretsmanager/SecretsManager_EXPORTS.h>
13#include <aws/secretsmanager/model/ExternalSecretRotationMetadataItem.h>
14#include <aws/secretsmanager/model/ReplicationStatusType.h>
15#include <aws/secretsmanager/model/RotationRulesType.h>
16#include <aws/secretsmanager/model/Tag.h>
17
18#include <utility>
19
20namespace Aws {
21template <typename RESULT_TYPE>
22class AmazonWebServiceResult;
23
24namespace Utils {
25namespace Json {
26class JsonValue;
27} // namespace Json
28} // namespace Utils
29namespace SecretsManager {
30namespace Model {
32 public:
33 AWS_SECRETSMANAGER_API DescribeSecretResult() = default;
36
38
41 inline const Aws::String& GetARN() const { return m_aRN; }
42 template <typename ARNT = Aws::String>
43 void SetARN(ARNT&& value) {
44 m_aRNHasBeenSet = true;
45 m_aRN = std::forward<ARNT>(value);
46 }
47 template <typename ARNT = Aws::String>
49 SetARN(std::forward<ARNT>(value));
50 return *this;
51 }
53
55
58 inline const Aws::String& GetName() const { return m_name; }
59 template <typename NameT = Aws::String>
60 void SetName(NameT&& value) {
61 m_nameHasBeenSet = true;
62 m_name = std::forward<NameT>(value);
63 }
64 template <typename NameT = Aws::String>
66 SetName(std::forward<NameT>(value));
67 return *this;
68 }
70
72
78 inline const Aws::String& GetType() const { return m_type; }
79 template <typename TypeT = Aws::String>
80 void SetType(TypeT&& value) {
81 m_typeHasBeenSet = true;
82 m_type = std::forward<TypeT>(value);
83 }
84 template <typename TypeT = Aws::String>
86 SetType(std::forward<TypeT>(value));
87 return *this;
88 }
90
92
95 inline const Aws::String& GetDescription() const { return m_description; }
96 template <typename DescriptionT = Aws::String>
97 void SetDescription(DescriptionT&& value) {
98 m_descriptionHasBeenSet = true;
99 m_description = std::forward<DescriptionT>(value);
100 }
101 template <typename DescriptionT = Aws::String>
102 DescribeSecretResult& WithDescription(DescriptionT&& value) {
103 SetDescription(std::forward<DescriptionT>(value));
104 return *this;
105 }
107
109
115 inline const Aws::String& GetKmsKeyId() const { return m_kmsKeyId; }
116 template <typename KmsKeyIdT = Aws::String>
117 void SetKmsKeyId(KmsKeyIdT&& value) {
118 m_kmsKeyIdHasBeenSet = true;
119 m_kmsKeyId = std::forward<KmsKeyIdT>(value);
120 }
121 template <typename KmsKeyIdT = Aws::String>
122 DescribeSecretResult& WithKmsKeyId(KmsKeyIdT&& value) {
123 SetKmsKeyId(std::forward<KmsKeyIdT>(value));
124 return *this;
125 }
127
129
135 inline bool GetRotationEnabled() const { return m_rotationEnabled; }
136 inline void SetRotationEnabled(bool value) {
137 m_rotationEnabledHasBeenSet = true;
138 m_rotationEnabled = value;
139 }
141 SetRotationEnabled(value);
142 return *this;
143 }
145
147
151 inline const Aws::String& GetRotationLambdaARN() const { return m_rotationLambdaARN; }
152 template <typename RotationLambdaARNT = Aws::String>
153 void SetRotationLambdaARN(RotationLambdaARNT&& value) {
154 m_rotationLambdaARNHasBeenSet = true;
155 m_rotationLambdaARN = std::forward<RotationLambdaARNT>(value);
156 }
157 template <typename RotationLambdaARNT = Aws::String>
158 DescribeSecretResult& WithRotationLambdaARN(RotationLambdaARNT&& value) {
159 SetRotationLambdaARN(std::forward<RotationLambdaARNT>(value));
160 return *this;
161 }
163
165
171 inline const RotationRulesType& GetRotationRules() const { return m_rotationRules; }
172 template <typename RotationRulesT = RotationRulesType>
173 void SetRotationRules(RotationRulesT&& value) {
174 m_rotationRulesHasBeenSet = true;
175 m_rotationRules = std::forward<RotationRulesT>(value);
176 }
177 template <typename RotationRulesT = RotationRulesType>
178 DescribeSecretResult& WithRotationRules(RotationRulesT&& value) {
179 SetRotationRules(std::forward<RotationRulesT>(value));
180 return *this;
181 }
183
185
193 return m_externalSecretRotationMetadata;
194 }
195 template <typename ExternalSecretRotationMetadataT = Aws::Vector<ExternalSecretRotationMetadataItem>>
196 void SetExternalSecretRotationMetadata(ExternalSecretRotationMetadataT&& value) {
197 m_externalSecretRotationMetadataHasBeenSet = true;
198 m_externalSecretRotationMetadata = std::forward<ExternalSecretRotationMetadataT>(value);
199 }
200 template <typename ExternalSecretRotationMetadataT = Aws::Vector<ExternalSecretRotationMetadataItem>>
201 DescribeSecretResult& WithExternalSecretRotationMetadata(ExternalSecretRotationMetadataT&& value) {
202 SetExternalSecretRotationMetadata(std::forward<ExternalSecretRotationMetadataT>(value));
203 return *this;
204 }
205 template <typename ExternalSecretRotationMetadataT = ExternalSecretRotationMetadataItem>
206 DescribeSecretResult& AddExternalSecretRotationMetadata(ExternalSecretRotationMetadataT&& value) {
207 m_externalSecretRotationMetadataHasBeenSet = true;
208 m_externalSecretRotationMetadata.emplace_back(std::forward<ExternalSecretRotationMetadataT>(value));
209 return *this;
210 }
212
214
220 inline const Aws::String& GetExternalSecretRotationRoleArn() const { return m_externalSecretRotationRoleArn; }
221 template <typename ExternalSecretRotationRoleArnT = Aws::String>
222 void SetExternalSecretRotationRoleArn(ExternalSecretRotationRoleArnT&& value) {
223 m_externalSecretRotationRoleArnHasBeenSet = true;
224 m_externalSecretRotationRoleArn = std::forward<ExternalSecretRotationRoleArnT>(value);
225 }
226 template <typename ExternalSecretRotationRoleArnT = Aws::String>
227 DescribeSecretResult& WithExternalSecretRotationRoleArn(ExternalSecretRotationRoleArnT&& value) {
228 SetExternalSecretRotationRoleArn(std::forward<ExternalSecretRotationRoleArnT>(value));
229 return *this;
230 }
232
234
239 inline const Aws::Utils::DateTime& GetLastRotatedDate() const { return m_lastRotatedDate; }
240 template <typename LastRotatedDateT = Aws::Utils::DateTime>
241 void SetLastRotatedDate(LastRotatedDateT&& value) {
242 m_lastRotatedDateHasBeenSet = true;
243 m_lastRotatedDate = std::forward<LastRotatedDateT>(value);
244 }
245 template <typename LastRotatedDateT = Aws::Utils::DateTime>
246 DescribeSecretResult& WithLastRotatedDate(LastRotatedDateT&& value) {
247 SetLastRotatedDate(std::forward<LastRotatedDateT>(value));
248 return *this;
249 }
251
253
256 inline const Aws::Utils::DateTime& GetLastChangedDate() const { return m_lastChangedDate; }
257 template <typename LastChangedDateT = Aws::Utils::DateTime>
258 void SetLastChangedDate(LastChangedDateT&& value) {
259 m_lastChangedDateHasBeenSet = true;
260 m_lastChangedDate = std::forward<LastChangedDateT>(value);
261 }
262 template <typename LastChangedDateT = Aws::Utils::DateTime>
263 DescribeSecretResult& WithLastChangedDate(LastChangedDateT&& value) {
264 SetLastChangedDate(std::forward<LastChangedDateT>(value));
265 return *this;
266 }
268
270
274 inline const Aws::Utils::DateTime& GetLastAccessedDate() const { return m_lastAccessedDate; }
275 template <typename LastAccessedDateT = Aws::Utils::DateTime>
276 void SetLastAccessedDate(LastAccessedDateT&& value) {
277 m_lastAccessedDateHasBeenSet = true;
278 m_lastAccessedDate = std::forward<LastAccessedDateT>(value);
279 }
280 template <typename LastAccessedDateT = Aws::Utils::DateTime>
281 DescribeSecretResult& WithLastAccessedDate(LastAccessedDateT&& value) {
282 SetLastAccessedDate(std::forward<LastAccessedDateT>(value));
283 return *this;
284 }
286
288
297 inline const Aws::Utils::DateTime& GetDeletedDate() const { return m_deletedDate; }
298 template <typename DeletedDateT = Aws::Utils::DateTime>
299 void SetDeletedDate(DeletedDateT&& value) {
300 m_deletedDateHasBeenSet = true;
301 m_deletedDate = std::forward<DeletedDateT>(value);
302 }
303 template <typename DeletedDateT = Aws::Utils::DateTime>
304 DescribeSecretResult& WithDeletedDate(DeletedDateT&& value) {
305 SetDeletedDate(std::forward<DeletedDateT>(value));
306 return *this;
307 }
309
311
321 inline const Aws::Utils::DateTime& GetNextRotationDate() const { return m_nextRotationDate; }
322 template <typename NextRotationDateT = Aws::Utils::DateTime>
323 void SetNextRotationDate(NextRotationDateT&& value) {
324 m_nextRotationDateHasBeenSet = true;
325 m_nextRotationDate = std::forward<NextRotationDateT>(value);
326 }
327 template <typename NextRotationDateT = Aws::Utils::DateTime>
328 DescribeSecretResult& WithNextRotationDate(NextRotationDateT&& value) {
329 SetNextRotationDate(std::forward<NextRotationDateT>(value));
330 return *this;
331 }
333
335
339 inline const Aws::Vector<Tag>& GetTags() const { return m_tags; }
340 template <typename TagsT = Aws::Vector<Tag>>
341 void SetTags(TagsT&& value) {
342 m_tagsHasBeenSet = true;
343 m_tags = std::forward<TagsT>(value);
344 }
345 template <typename TagsT = Aws::Vector<Tag>>
347 SetTags(std::forward<TagsT>(value));
348 return *this;
349 }
350 template <typename TagsT = Tag>
352 m_tagsHasBeenSet = true;
353 m_tags.emplace_back(std::forward<TagsT>(value));
354 return *this;
355 }
357
359
377 inline const Aws::Map<Aws::String, Aws::Vector<Aws::String>>& GetVersionIdsToStages() const { return m_versionIdsToStages; }
378 template <typename VersionIdsToStagesT = Aws::Map<Aws::String, Aws::Vector<Aws::String>>>
379 void SetVersionIdsToStages(VersionIdsToStagesT&& value) {
380 m_versionIdsToStagesHasBeenSet = true;
381 m_versionIdsToStages = std::forward<VersionIdsToStagesT>(value);
382 }
383 template <typename VersionIdsToStagesT = Aws::Map<Aws::String, Aws::Vector<Aws::String>>>
384 DescribeSecretResult& WithVersionIdsToStages(VersionIdsToStagesT&& value) {
385 SetVersionIdsToStages(std::forward<VersionIdsToStagesT>(value));
386 return *this;
387 }
388 template <typename VersionIdsToStagesKeyT = Aws::String, typename VersionIdsToStagesValueT = Aws::Vector<Aws::String>>
389 DescribeSecretResult& AddVersionIdsToStages(VersionIdsToStagesKeyT&& key, VersionIdsToStagesValueT&& value) {
390 m_versionIdsToStagesHasBeenSet = true;
391 m_versionIdsToStages.emplace(std::forward<VersionIdsToStagesKeyT>(key), std::forward<VersionIdsToStagesValueT>(value));
392 return *this;
393 }
395
397
402 inline const Aws::String& GetOwningService() const { return m_owningService; }
403 template <typename OwningServiceT = Aws::String>
404 void SetOwningService(OwningServiceT&& value) {
405 m_owningServiceHasBeenSet = true;
406 m_owningService = std::forward<OwningServiceT>(value);
407 }
408 template <typename OwningServiceT = Aws::String>
409 DescribeSecretResult& WithOwningService(OwningServiceT&& value) {
410 SetOwningService(std::forward<OwningServiceT>(value));
411 return *this;
412 }
414
416
419 inline const Aws::Utils::DateTime& GetCreatedDate() const { return m_createdDate; }
420 template <typename CreatedDateT = Aws::Utils::DateTime>
421 void SetCreatedDate(CreatedDateT&& value) {
422 m_createdDateHasBeenSet = true;
423 m_createdDate = std::forward<CreatedDateT>(value);
424 }
425 template <typename CreatedDateT = Aws::Utils::DateTime>
426 DescribeSecretResult& WithCreatedDate(CreatedDateT&& value) {
427 SetCreatedDate(std::forward<CreatedDateT>(value));
428 return *this;
429 }
431
433
437 inline const Aws::String& GetPrimaryRegion() const { return m_primaryRegion; }
438 template <typename PrimaryRegionT = Aws::String>
439 void SetPrimaryRegion(PrimaryRegionT&& value) {
440 m_primaryRegionHasBeenSet = true;
441 m_primaryRegion = std::forward<PrimaryRegionT>(value);
442 }
443 template <typename PrimaryRegionT = Aws::String>
444 DescribeSecretResult& WithPrimaryRegion(PrimaryRegionT&& value) {
445 SetPrimaryRegion(std::forward<PrimaryRegionT>(value));
446 return *this;
447 }
449
451
458 inline const Aws::Vector<ReplicationStatusType>& GetReplicationStatus() const { return m_replicationStatus; }
459 template <typename ReplicationStatusT = Aws::Vector<ReplicationStatusType>>
460 void SetReplicationStatus(ReplicationStatusT&& value) {
461 m_replicationStatusHasBeenSet = true;
462 m_replicationStatus = std::forward<ReplicationStatusT>(value);
463 }
464 template <typename ReplicationStatusT = Aws::Vector<ReplicationStatusType>>
465 DescribeSecretResult& WithReplicationStatus(ReplicationStatusT&& value) {
466 SetReplicationStatus(std::forward<ReplicationStatusT>(value));
467 return *this;
468 }
469 template <typename ReplicationStatusT = ReplicationStatusType>
470 DescribeSecretResult& AddReplicationStatus(ReplicationStatusT&& value) {
471 m_replicationStatusHasBeenSet = true;
472 m_replicationStatus.emplace_back(std::forward<ReplicationStatusT>(value));
473 return *this;
474 }
476
478
479 inline const Aws::String& GetRequestId() const { return m_requestId; }
480 template <typename RequestIdT = Aws::String>
481 void SetRequestId(RequestIdT&& value) {
482 m_requestIdHasBeenSet = true;
483 m_requestId = std::forward<RequestIdT>(value);
484 }
485 template <typename RequestIdT = Aws::String>
486 DescribeSecretResult& WithRequestId(RequestIdT&& value) {
487 SetRequestId(std::forward<RequestIdT>(value));
488 return *this;
489 }
491 inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; }
492
493 private:
494 Aws::String m_aRN;
495
496 Aws::String m_name;
497
498 Aws::String m_type;
499
500 Aws::String m_description;
501
502 Aws::String m_kmsKeyId;
503
504 bool m_rotationEnabled{false};
505
506 Aws::String m_rotationLambdaARN;
507
508 RotationRulesType m_rotationRules;
509
510 Aws::Vector<ExternalSecretRotationMetadataItem> m_externalSecretRotationMetadata;
511
512 Aws::String m_externalSecretRotationRoleArn;
513
514 Aws::Utils::DateTime m_lastRotatedDate{};
515
516 Aws::Utils::DateTime m_lastChangedDate{};
517
518 Aws::Utils::DateTime m_lastAccessedDate{};
519
520 Aws::Utils::DateTime m_deletedDate{};
521
522 Aws::Utils::DateTime m_nextRotationDate{};
523
524 Aws::Vector<Tag> m_tags;
525
527
528 Aws::String m_owningService;
529
530 Aws::Utils::DateTime m_createdDate{};
531
532 Aws::String m_primaryRegion;
533
534 Aws::Vector<ReplicationStatusType> m_replicationStatus;
535
536 Aws::String m_requestId;
537 Aws::Http::HttpResponseCode m_HttpResponseCode;
538 bool m_aRNHasBeenSet = false;
539 bool m_nameHasBeenSet = false;
540 bool m_typeHasBeenSet = false;
541 bool m_descriptionHasBeenSet = false;
542 bool m_kmsKeyIdHasBeenSet = false;
543 bool m_rotationEnabledHasBeenSet = false;
544 bool m_rotationLambdaARNHasBeenSet = false;
545 bool m_rotationRulesHasBeenSet = false;
546 bool m_externalSecretRotationMetadataHasBeenSet = false;
547 bool m_externalSecretRotationRoleArnHasBeenSet = false;
548 bool m_lastRotatedDateHasBeenSet = false;
549 bool m_lastChangedDateHasBeenSet = false;
550 bool m_lastAccessedDateHasBeenSet = false;
551 bool m_deletedDateHasBeenSet = false;
552 bool m_nextRotationDateHasBeenSet = false;
553 bool m_tagsHasBeenSet = false;
554 bool m_versionIdsToStagesHasBeenSet = false;
555 bool m_owningServiceHasBeenSet = false;
556 bool m_createdDateHasBeenSet = false;
557 bool m_primaryRegionHasBeenSet = false;
558 bool m_replicationStatusHasBeenSet = false;
559 bool m_requestIdHasBeenSet = false;
560};
561
562} // namespace Model
563} // namespace SecretsManager
564} // 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)
Aws::Http::HttpResponseCode GetHttpResponseCode() const
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