AWS SDK for C++

AWS SDK for C++ Version 1.11.607

Loading...
Searching...
No Matches
Canary.h
1
6#pragma once
7#include <aws/synthetics/Synthetics_EXPORTS.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/synthetics/model/CanaryCodeOutput.h>
10#include <aws/synthetics/model/CanaryScheduleOutput.h>
11#include <aws/synthetics/model/CanaryRunConfigOutput.h>
12#include <aws/synthetics/model/CanaryStatus.h>
13#include <aws/synthetics/model/CanaryTimeline.h>
14#include <aws/synthetics/model/VpcConfigOutput.h>
15#include <aws/synthetics/model/VisualReferenceOutput.h>
16#include <aws/synthetics/model/ProvisionedResourceCleanupSetting.h>
17#include <aws/core/utils/memory/stl/AWSMap.h>
18#include <aws/synthetics/model/ArtifactConfigOutput.h>
19#include <aws/synthetics/model/DryRunConfigOutput.h>
20#include <utility>
21
22namespace Aws
23{
24namespace Utils
25{
26namespace Json
27{
28 class JsonValue;
29 class JsonView;
30} // namespace Json
31} // namespace Utils
32namespace Synthetics
33{
34namespace Model
35{
36
43 class Canary
44 {
45 public:
46 AWS_SYNTHETICS_API Canary() = default;
47 AWS_SYNTHETICS_API Canary(Aws::Utils::Json::JsonView jsonValue);
48 AWS_SYNTHETICS_API Canary& operator=(Aws::Utils::Json::JsonView jsonValue);
49 AWS_SYNTHETICS_API Aws::Utils::Json::JsonValue Jsonize() const;
50
51
53
56 inline const Aws::String& GetId() const { return m_id; }
57 inline bool IdHasBeenSet() const { return m_idHasBeenSet; }
58 template<typename IdT = Aws::String>
59 void SetId(IdT&& value) { m_idHasBeenSet = true; m_id = std::forward<IdT>(value); }
60 template<typename IdT = Aws::String>
61 Canary& WithId(IdT&& value) { SetId(std::forward<IdT>(value)); return *this;}
63
65
68 inline const Aws::String& GetName() const { return m_name; }
69 inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
70 template<typename NameT = Aws::String>
71 void SetName(NameT&& value) { m_nameHasBeenSet = true; m_name = std::forward<NameT>(value); }
72 template<typename NameT = Aws::String>
73 Canary& WithName(NameT&& value) { SetName(std::forward<NameT>(value)); return *this;}
75
77
78 inline const CanaryCodeOutput& GetCode() const { return m_code; }
79 inline bool CodeHasBeenSet() const { return m_codeHasBeenSet; }
80 template<typename CodeT = CanaryCodeOutput>
81 void SetCode(CodeT&& value) { m_codeHasBeenSet = true; m_code = std::forward<CodeT>(value); }
82 template<typename CodeT = CanaryCodeOutput>
83 Canary& WithCode(CodeT&& value) { SetCode(std::forward<CodeT>(value)); return *this;}
85
87
91 inline const Aws::String& GetExecutionRoleArn() const { return m_executionRoleArn; }
92 inline bool ExecutionRoleArnHasBeenSet() const { return m_executionRoleArnHasBeenSet; }
93 template<typename ExecutionRoleArnT = Aws::String>
94 void SetExecutionRoleArn(ExecutionRoleArnT&& value) { m_executionRoleArnHasBeenSet = true; m_executionRoleArn = std::forward<ExecutionRoleArnT>(value); }
95 template<typename ExecutionRoleArnT = Aws::String>
96 Canary& WithExecutionRoleArn(ExecutionRoleArnT&& value) { SetExecutionRoleArn(std::forward<ExecutionRoleArnT>(value)); return *this;}
98
100
104 inline const CanaryScheduleOutput& GetSchedule() const { return m_schedule; }
105 inline bool ScheduleHasBeenSet() const { return m_scheduleHasBeenSet; }
106 template<typename ScheduleT = CanaryScheduleOutput>
107 void SetSchedule(ScheduleT&& value) { m_scheduleHasBeenSet = true; m_schedule = std::forward<ScheduleT>(value); }
108 template<typename ScheduleT = CanaryScheduleOutput>
109 Canary& WithSchedule(ScheduleT&& value) { SetSchedule(std::forward<ScheduleT>(value)); return *this;}
111
113
114 inline const CanaryRunConfigOutput& GetRunConfig() const { return m_runConfig; }
115 inline bool RunConfigHasBeenSet() const { return m_runConfigHasBeenSet; }
116 template<typename RunConfigT = CanaryRunConfigOutput>
117 void SetRunConfig(RunConfigT&& value) { m_runConfigHasBeenSet = true; m_runConfig = std::forward<RunConfigT>(value); }
118 template<typename RunConfigT = CanaryRunConfigOutput>
119 Canary& WithRunConfig(RunConfigT&& value) { SetRunConfig(std::forward<RunConfigT>(value)); return *this;}
121
123
129 inline int GetSuccessRetentionPeriodInDays() const { return m_successRetentionPeriodInDays; }
130 inline bool SuccessRetentionPeriodInDaysHasBeenSet() const { return m_successRetentionPeriodInDaysHasBeenSet; }
131 inline void SetSuccessRetentionPeriodInDays(int value) { m_successRetentionPeriodInDaysHasBeenSet = true; m_successRetentionPeriodInDays = value; }
134
136
142 inline int GetFailureRetentionPeriodInDays() const { return m_failureRetentionPeriodInDays; }
143 inline bool FailureRetentionPeriodInDaysHasBeenSet() const { return m_failureRetentionPeriodInDaysHasBeenSet; }
144 inline void SetFailureRetentionPeriodInDays(int value) { m_failureRetentionPeriodInDaysHasBeenSet = true; m_failureRetentionPeriodInDays = value; }
147
149
152 inline const CanaryStatus& GetStatus() const { return m_status; }
153 inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; }
154 template<typename StatusT = CanaryStatus>
155 void SetStatus(StatusT&& value) { m_statusHasBeenSet = true; m_status = std::forward<StatusT>(value); }
156 template<typename StatusT = CanaryStatus>
157 Canary& WithStatus(StatusT&& value) { SetStatus(std::forward<StatusT>(value)); return *this;}
159
161
165 inline const CanaryTimeline& GetTimeline() const { return m_timeline; }
166 inline bool TimelineHasBeenSet() const { return m_timelineHasBeenSet; }
167 template<typename TimelineT = CanaryTimeline>
168 void SetTimeline(TimelineT&& value) { m_timelineHasBeenSet = true; m_timeline = std::forward<TimelineT>(value); }
169 template<typename TimelineT = CanaryTimeline>
170 Canary& WithTimeline(TimelineT&& value) { SetTimeline(std::forward<TimelineT>(value)); return *this;}
172
174
178 inline const Aws::String& GetArtifactS3Location() const { return m_artifactS3Location; }
179 inline bool ArtifactS3LocationHasBeenSet() const { return m_artifactS3LocationHasBeenSet; }
180 template<typename ArtifactS3LocationT = Aws::String>
181 void SetArtifactS3Location(ArtifactS3LocationT&& value) { m_artifactS3LocationHasBeenSet = true; m_artifactS3Location = std::forward<ArtifactS3LocationT>(value); }
182 template<typename ArtifactS3LocationT = Aws::String>
183 Canary& WithArtifactS3Location(ArtifactS3LocationT&& value) { SetArtifactS3Location(std::forward<ArtifactS3LocationT>(value)); return *this;}
185
187
193 inline const Aws::String& GetEngineArn() const { return m_engineArn; }
194 inline bool EngineArnHasBeenSet() const { return m_engineArnHasBeenSet; }
195 template<typename EngineArnT = Aws::String>
196 void SetEngineArn(EngineArnT&& value) { m_engineArnHasBeenSet = true; m_engineArn = std::forward<EngineArnT>(value); }
197 template<typename EngineArnT = Aws::String>
198 Canary& WithEngineArn(EngineArnT&& value) { SetEngineArn(std::forward<EngineArnT>(value)); return *this;}
200
202
208 inline const Aws::String& GetRuntimeVersion() const { return m_runtimeVersion; }
209 inline bool RuntimeVersionHasBeenSet() const { return m_runtimeVersionHasBeenSet; }
210 template<typename RuntimeVersionT = Aws::String>
211 void SetRuntimeVersion(RuntimeVersionT&& value) { m_runtimeVersionHasBeenSet = true; m_runtimeVersion = std::forward<RuntimeVersionT>(value); }
212 template<typename RuntimeVersionT = Aws::String>
213 Canary& WithRuntimeVersion(RuntimeVersionT&& value) { SetRuntimeVersion(std::forward<RuntimeVersionT>(value)); return *this;}
215
217
218 inline const VpcConfigOutput& GetVpcConfig() const { return m_vpcConfig; }
219 inline bool VpcConfigHasBeenSet() const { return m_vpcConfigHasBeenSet; }
220 template<typename VpcConfigT = VpcConfigOutput>
221 void SetVpcConfig(VpcConfigT&& value) { m_vpcConfigHasBeenSet = true; m_vpcConfig = std::forward<VpcConfigT>(value); }
222 template<typename VpcConfigT = VpcConfigOutput>
223 Canary& WithVpcConfig(VpcConfigT&& value) { SetVpcConfig(std::forward<VpcConfigT>(value)); return *this;}
225
227
233 inline const VisualReferenceOutput& GetVisualReference() const { return m_visualReference; }
234 inline bool VisualReferenceHasBeenSet() const { return m_visualReferenceHasBeenSet; }
235 template<typename VisualReferenceT = VisualReferenceOutput>
236 void SetVisualReference(VisualReferenceT&& value) { m_visualReferenceHasBeenSet = true; m_visualReference = std::forward<VisualReferenceT>(value); }
237 template<typename VisualReferenceT = VisualReferenceOutput>
238 Canary& WithVisualReference(VisualReferenceT&& value) { SetVisualReference(std::forward<VisualReferenceT>(value)); return *this;}
240
242
252 inline ProvisionedResourceCleanupSetting GetProvisionedResourceCleanup() const { return m_provisionedResourceCleanup; }
253 inline bool ProvisionedResourceCleanupHasBeenSet() const { return m_provisionedResourceCleanupHasBeenSet; }
254 inline void SetProvisionedResourceCleanup(ProvisionedResourceCleanupSetting value) { m_provisionedResourceCleanupHasBeenSet = true; m_provisionedResourceCleanup = value; }
257
259
262 inline const Aws::Map<Aws::String, Aws::String>& GetTags() const { return m_tags; }
263 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
264 template<typename TagsT = Aws::Map<Aws::String, Aws::String>>
265 void SetTags(TagsT&& value) { m_tagsHasBeenSet = true; m_tags = std::forward<TagsT>(value); }
266 template<typename TagsT = Aws::Map<Aws::String, Aws::String>>
267 Canary& WithTags(TagsT&& value) { SetTags(std::forward<TagsT>(value)); return *this;}
268 template<typename TagsKeyT = Aws::String, typename TagsValueT = Aws::String>
269 Canary& AddTags(TagsKeyT&& key, TagsValueT&& value) {
270 m_tagsHasBeenSet = true; m_tags.emplace(std::forward<TagsKeyT>(key), std::forward<TagsValueT>(value)); return *this;
271 }
273
275
280 inline const ArtifactConfigOutput& GetArtifactConfig() const { return m_artifactConfig; }
281 inline bool ArtifactConfigHasBeenSet() const { return m_artifactConfigHasBeenSet; }
282 template<typename ArtifactConfigT = ArtifactConfigOutput>
283 void SetArtifactConfig(ArtifactConfigT&& value) { m_artifactConfigHasBeenSet = true; m_artifactConfig = std::forward<ArtifactConfigT>(value); }
284 template<typename ArtifactConfigT = ArtifactConfigOutput>
285 Canary& WithArtifactConfig(ArtifactConfigT&& value) { SetArtifactConfig(std::forward<ArtifactConfigT>(value)); return *this;}
287
289
292 inline const DryRunConfigOutput& GetDryRunConfig() const { return m_dryRunConfig; }
293 inline bool DryRunConfigHasBeenSet() const { return m_dryRunConfigHasBeenSet; }
294 template<typename DryRunConfigT = DryRunConfigOutput>
295 void SetDryRunConfig(DryRunConfigT&& value) { m_dryRunConfigHasBeenSet = true; m_dryRunConfig = std::forward<DryRunConfigT>(value); }
296 template<typename DryRunConfigT = DryRunConfigOutput>
297 Canary& WithDryRunConfig(DryRunConfigT&& value) { SetDryRunConfig(std::forward<DryRunConfigT>(value)); return *this;}
299 private:
300
301 Aws::String m_id;
302 bool m_idHasBeenSet = false;
303
304 Aws::String m_name;
305 bool m_nameHasBeenSet = false;
306
307 CanaryCodeOutput m_code;
308 bool m_codeHasBeenSet = false;
309
310 Aws::String m_executionRoleArn;
311 bool m_executionRoleArnHasBeenSet = false;
312
313 CanaryScheduleOutput m_schedule;
314 bool m_scheduleHasBeenSet = false;
315
316 CanaryRunConfigOutput m_runConfig;
317 bool m_runConfigHasBeenSet = false;
318
319 int m_successRetentionPeriodInDays{0};
320 bool m_successRetentionPeriodInDaysHasBeenSet = false;
321
322 int m_failureRetentionPeriodInDays{0};
323 bool m_failureRetentionPeriodInDaysHasBeenSet = false;
324
325 CanaryStatus m_status;
326 bool m_statusHasBeenSet = false;
327
328 CanaryTimeline m_timeline;
329 bool m_timelineHasBeenSet = false;
330
331 Aws::String m_artifactS3Location;
332 bool m_artifactS3LocationHasBeenSet = false;
333
334 Aws::String m_engineArn;
335 bool m_engineArnHasBeenSet = false;
336
337 Aws::String m_runtimeVersion;
338 bool m_runtimeVersionHasBeenSet = false;
339
340 VpcConfigOutput m_vpcConfig;
341 bool m_vpcConfigHasBeenSet = false;
342
343 VisualReferenceOutput m_visualReference;
344 bool m_visualReferenceHasBeenSet = false;
345
347 bool m_provisionedResourceCleanupHasBeenSet = false;
348
350 bool m_tagsHasBeenSet = false;
351
352 ArtifactConfigOutput m_artifactConfig;
353 bool m_artifactConfigHasBeenSet = false;
354
355 DryRunConfigOutput m_dryRunConfig;
356 bool m_dryRunConfigHasBeenSet = false;
357 };
358
359} // namespace Model
360} // namespace Synthetics
361} // namespace Aws
const VpcConfigOutput & GetVpcConfig() const
Definition Canary.h:218
void SetTimeline(TimelineT &&value)
Definition Canary.h:168
const CanaryTimeline & GetTimeline() const
Definition Canary.h:165
AWS_SYNTHETICS_API Canary()=default
Canary & WithEngineArn(EngineArnT &&value)
Definition Canary.h:198
bool RuntimeVersionHasBeenSet() const
Definition Canary.h:209
void SetDryRunConfig(DryRunConfigT &&value)
Definition Canary.h:295
void SetExecutionRoleArn(ExecutionRoleArnT &&value)
Definition Canary.h:94
const Aws::String & GetName() const
Definition Canary.h:68
void SetCode(CodeT &&value)
Definition Canary.h:81
bool NameHasBeenSet() const
Definition Canary.h:69
bool ArtifactConfigHasBeenSet() const
Definition Canary.h:281
bool ExecutionRoleArnHasBeenSet() const
Definition Canary.h:92
void SetVpcConfig(VpcConfigT &&value)
Definition Canary.h:221
bool VpcConfigHasBeenSet() const
Definition Canary.h:219
void SetRuntimeVersion(RuntimeVersionT &&value)
Definition Canary.h:211
bool ScheduleHasBeenSet() const
Definition Canary.h:105
Canary & WithProvisionedResourceCleanup(ProvisionedResourceCleanupSetting value)
Definition Canary.h:255
int GetSuccessRetentionPeriodInDays() const
Definition Canary.h:129
const Aws::String & GetRuntimeVersion() const
Definition Canary.h:208
Canary & WithName(NameT &&value)
Definition Canary.h:73
const Aws::String & GetId() const
Definition Canary.h:56
void SetArtifactConfig(ArtifactConfigT &&value)
Definition Canary.h:283
AWS_SYNTHETICS_API Aws::Utils::Json::JsonValue Jsonize() const
void SetStatus(StatusT &&value)
Definition Canary.h:155
const CanaryStatus & GetStatus() const
Definition Canary.h:152
const CanaryCodeOutput & GetCode() const
Definition Canary.h:78
const Aws::String & GetEngineArn() const
Definition Canary.h:193
bool StatusHasBeenSet() const
Definition Canary.h:153
Canary & WithTimeline(TimelineT &&value)
Definition Canary.h:170
void SetEngineArn(EngineArnT &&value)
Definition Canary.h:196
Canary & WithRunConfig(RunConfigT &&value)
Definition Canary.h:119
const DryRunConfigOutput & GetDryRunConfig() const
Definition Canary.h:292
const VisualReferenceOutput & GetVisualReference() const
Definition Canary.h:233
bool FailureRetentionPeriodInDaysHasBeenSet() const
Definition Canary.h:143
void SetVisualReference(VisualReferenceT &&value)
Definition Canary.h:236
Canary & WithId(IdT &&value)
Definition Canary.h:61
void SetId(IdT &&value)
Definition Canary.h:59
bool SuccessRetentionPeriodInDaysHasBeenSet() const
Definition Canary.h:130
const ArtifactConfigOutput & GetArtifactConfig() const
Definition Canary.h:280
ProvisionedResourceCleanupSetting GetProvisionedResourceCleanup() const
Definition Canary.h:252
Canary & WithStatus(StatusT &&value)
Definition Canary.h:157
const Aws::String & GetArtifactS3Location() const
Definition Canary.h:178
void SetRunConfig(RunConfigT &&value)
Definition Canary.h:117
Canary & WithFailureRetentionPeriodInDays(int value)
Definition Canary.h:145
Canary & AddTags(TagsKeyT &&key, TagsValueT &&value)
Definition Canary.h:269
Canary & WithRuntimeVersion(RuntimeVersionT &&value)
Definition Canary.h:213
void SetFailureRetentionPeriodInDays(int value)
Definition Canary.h:144
int GetFailureRetentionPeriodInDays() const
Definition Canary.h:142
bool ProvisionedResourceCleanupHasBeenSet() const
Definition Canary.h:253
void SetArtifactS3Location(ArtifactS3LocationT &&value)
Definition Canary.h:181
Canary & WithDryRunConfig(DryRunConfigT &&value)
Definition Canary.h:297
const CanaryRunConfigOutput & GetRunConfig() const
Definition Canary.h:114
Canary & WithTags(TagsT &&value)
Definition Canary.h:267
Canary & WithSchedule(ScheduleT &&value)
Definition Canary.h:109
const CanaryScheduleOutput & GetSchedule() const
Definition Canary.h:104
AWS_SYNTHETICS_API Canary(Aws::Utils::Json::JsonView jsonValue)
bool RunConfigHasBeenSet() const
Definition Canary.h:115
const Aws::String & GetExecutionRoleArn() const
Definition Canary.h:91
bool DryRunConfigHasBeenSet() const
Definition Canary.h:293
void SetName(NameT &&value)
Definition Canary.h:71
Canary & WithArtifactConfig(ArtifactConfigT &&value)
Definition Canary.h:285
Canary & WithExecutionRoleArn(ExecutionRoleArnT &&value)
Definition Canary.h:96
Canary & WithVisualReference(VisualReferenceT &&value)
Definition Canary.h:238
Canary & WithArtifactS3Location(ArtifactS3LocationT &&value)
Definition Canary.h:183
const Aws::Map< Aws::String, Aws::String > & GetTags() const
Definition Canary.h:262
void SetSuccessRetentionPeriodInDays(int value)
Definition Canary.h:131
void SetTags(TagsT &&value)
Definition Canary.h:265
Canary & WithSuccessRetentionPeriodInDays(int value)
Definition Canary.h:132
bool CodeHasBeenSet() const
Definition Canary.h:79
bool VisualReferenceHasBeenSet() const
Definition Canary.h:234
void SetSchedule(ScheduleT &&value)
Definition Canary.h:107
bool ArtifactS3LocationHasBeenSet() const
Definition Canary.h:179
Canary & WithVpcConfig(VpcConfigT &&value)
Definition Canary.h:223
Canary & WithCode(CodeT &&value)
Definition Canary.h:83
bool TimelineHasBeenSet() const
Definition Canary.h:166
bool EngineArnHasBeenSet() const
Definition Canary.h:194
void SetProvisionedResourceCleanup(ProvisionedResourceCleanupSetting value)
Definition Canary.h:254
AWS_SYNTHETICS_API Canary & operator=(Aws::Utils::Json::JsonView jsonValue)
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
Aws::Utils::Json::JsonValue JsonValue