AWS SDK for C++

AWS SDK for C++ Version 1.11.854

Loading...
Searching...
No Matches
UpdateCanaryRequest.h
1
6#pragma once
7#include <aws/core/utils/memory/stl/AWSString.h>
8#include <aws/core/utils/memory/stl/AWSVector.h>
9#include <aws/synthetics/SyntheticsRequest.h>
10#include <aws/synthetics/Synthetics_EXPORTS.h>
11#include <aws/synthetics/model/AddReplicaLocationInput.h>
12#include <aws/synthetics/model/ArtifactConfigInput.h>
13#include <aws/synthetics/model/BrowserConfig.h>
14#include <aws/synthetics/model/CanaryCodeInput.h>
15#include <aws/synthetics/model/CanaryRunConfigInput.h>
16#include <aws/synthetics/model/CanaryScheduleInput.h>
17#include <aws/synthetics/model/ProvisionedResourceCleanupSetting.h>
18#include <aws/synthetics/model/VisualReferenceInput.h>
19#include <aws/synthetics/model/VpcConfigInput.h>
20
21#include <utility>
22
23namespace Aws {
24namespace Synthetics {
25namespace Model {
26
30 public:
31 AWS_SYNTHETICS_API UpdateCanaryRequest() = default;
32
33 // Service request name is the Operation name which will send this request out,
34 // each operation should has unique request name, so that we can get operation's name from this request.
35 // Note: this is not true for response, multiple operations may have the same response name,
36 // so we can not get operation's name from response.
37 inline virtual const char* GetServiceRequestName() const override { return "UpdateCanary"; }
38
39 AWS_SYNTHETICS_API Aws::String SerializePayload() const override;
40
42
48 inline const Aws::String& GetName() const { return m_name; }
49 inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
50 template <typename NameT = Aws::String>
51 void SetName(NameT&& value) {
52 m_nameHasBeenSet = true;
53 m_name = std::forward<NameT>(value);
54 }
55 template <typename NameT = Aws::String>
56 UpdateCanaryRequest& WithName(NameT&& value) {
57 SetName(std::forward<NameT>(value));
58 return *this;
59 }
61
63
68 inline const CanaryCodeInput& GetCode() const { return m_code; }
69 inline bool CodeHasBeenSet() const { return m_codeHasBeenSet; }
70 template <typename CodeT = CanaryCodeInput>
71 void SetCode(CodeT&& value) {
72 m_codeHasBeenSet = true;
73 m_code = std::forward<CodeT>(value);
74 }
75 template <typename CodeT = CanaryCodeInput>
76 UpdateCanaryRequest& WithCode(CodeT&& value) {
77 SetCode(std::forward<CodeT>(value));
78 return *this;
79 }
81
83
95 inline const Aws::String& GetExecutionRoleArn() const { return m_executionRoleArn; }
96 inline bool ExecutionRoleArnHasBeenSet() const { return m_executionRoleArnHasBeenSet; }
97 template <typename ExecutionRoleArnT = Aws::String>
98 void SetExecutionRoleArn(ExecutionRoleArnT&& value) {
99 m_executionRoleArnHasBeenSet = true;
100 m_executionRoleArn = std::forward<ExecutionRoleArnT>(value);
101 }
102 template <typename ExecutionRoleArnT = Aws::String>
103 UpdateCanaryRequest& WithExecutionRoleArn(ExecutionRoleArnT&& value) {
104 SetExecutionRoleArn(std::forward<ExecutionRoleArnT>(value));
105 return *this;
106 }
108
110
116 inline const Aws::String& GetRuntimeVersion() const { return m_runtimeVersion; }
117 inline bool RuntimeVersionHasBeenSet() const { return m_runtimeVersionHasBeenSet; }
118 template <typename RuntimeVersionT = Aws::String>
119 void SetRuntimeVersion(RuntimeVersionT&& value) {
120 m_runtimeVersionHasBeenSet = true;
121 m_runtimeVersion = std::forward<RuntimeVersionT>(value);
122 }
123 template <typename RuntimeVersionT = Aws::String>
124 UpdateCanaryRequest& WithRuntimeVersion(RuntimeVersionT&& value) {
125 SetRuntimeVersion(std::forward<RuntimeVersionT>(value));
126 return *this;
127 }
129
131
135 inline const CanaryScheduleInput& GetSchedule() const { return m_schedule; }
136 inline bool ScheduleHasBeenSet() const { return m_scheduleHasBeenSet; }
137 template <typename ScheduleT = CanaryScheduleInput>
138 void SetSchedule(ScheduleT&& value) {
139 m_scheduleHasBeenSet = true;
140 m_schedule = std::forward<ScheduleT>(value);
141 }
142 template <typename ScheduleT = CanaryScheduleInput>
143 UpdateCanaryRequest& WithSchedule(ScheduleT&& value) {
144 SetSchedule(std::forward<ScheduleT>(value));
145 return *this;
146 }
148
150
157 inline const CanaryRunConfigInput& GetRunConfig() const { return m_runConfig; }
158 inline bool RunConfigHasBeenSet() const { return m_runConfigHasBeenSet; }
159 template <typename RunConfigT = CanaryRunConfigInput>
160 void SetRunConfig(RunConfigT&& value) {
161 m_runConfigHasBeenSet = true;
162 m_runConfig = std::forward<RunConfigT>(value);
163 }
164 template <typename RunConfigT = CanaryRunConfigInput>
165 UpdateCanaryRequest& WithRunConfig(RunConfigT&& value) {
166 SetRunConfig(std::forward<RunConfigT>(value));
167 return *this;
168 }
170
172
178 inline int GetSuccessRetentionPeriodInDays() const { return m_successRetentionPeriodInDays; }
179 inline bool SuccessRetentionPeriodInDaysHasBeenSet() const { return m_successRetentionPeriodInDaysHasBeenSet; }
180 inline void SetSuccessRetentionPeriodInDays(int value) {
181 m_successRetentionPeriodInDaysHasBeenSet = true;
182 m_successRetentionPeriodInDays = value;
183 }
186 return *this;
187 }
189
191
197 inline int GetFailureRetentionPeriodInDays() const { return m_failureRetentionPeriodInDays; }
198 inline bool FailureRetentionPeriodInDaysHasBeenSet() const { return m_failureRetentionPeriodInDaysHasBeenSet; }
199 inline void SetFailureRetentionPeriodInDays(int value) {
200 m_failureRetentionPeriodInDaysHasBeenSet = true;
201 m_failureRetentionPeriodInDays = value;
202 }
205 return *this;
206 }
208
210
217 inline const VpcConfigInput& GetVpcConfig() const { return m_vpcConfig; }
218 inline bool VpcConfigHasBeenSet() const { return m_vpcConfigHasBeenSet; }
219 template <typename VpcConfigT = VpcConfigInput>
220 void SetVpcConfig(VpcConfigT&& value) {
221 m_vpcConfigHasBeenSet = true;
222 m_vpcConfig = std::forward<VpcConfigT>(value);
223 }
224 template <typename VpcConfigT = VpcConfigInput>
225 UpdateCanaryRequest& WithVpcConfig(VpcConfigT&& value) {
226 SetVpcConfig(std::forward<VpcConfigT>(value));
227 return *this;
228 }
230
232
243 inline const VisualReferenceInput& GetVisualReference() const { return m_visualReference; }
244 inline bool VisualReferenceHasBeenSet() const { return m_visualReferenceHasBeenSet; }
245 template <typename VisualReferenceT = VisualReferenceInput>
246 void SetVisualReference(VisualReferenceT&& value) {
247 m_visualReferenceHasBeenSet = true;
248 m_visualReference = std::forward<VisualReferenceT>(value);
249 }
250 template <typename VisualReferenceT = VisualReferenceInput>
251 UpdateCanaryRequest& WithVisualReference(VisualReferenceT&& value) {
252 SetVisualReference(std::forward<VisualReferenceT>(value));
253 return *this;
254 }
256
258
263 inline const Aws::String& GetArtifactS3Location() const { return m_artifactS3Location; }
264 inline bool ArtifactS3LocationHasBeenSet() const { return m_artifactS3LocationHasBeenSet; }
265 template <typename ArtifactS3LocationT = Aws::String>
266 void SetArtifactS3Location(ArtifactS3LocationT&& value) {
267 m_artifactS3LocationHasBeenSet = true;
268 m_artifactS3Location = std::forward<ArtifactS3LocationT>(value);
269 }
270 template <typename ArtifactS3LocationT = Aws::String>
271 UpdateCanaryRequest& WithArtifactS3Location(ArtifactS3LocationT&& value) {
272 SetArtifactS3Location(std::forward<ArtifactS3LocationT>(value));
273 return *this;
274 }
276
278
283 inline const ArtifactConfigInput& GetArtifactConfig() const { return m_artifactConfig; }
284 inline bool ArtifactConfigHasBeenSet() const { return m_artifactConfigHasBeenSet; }
285 template <typename ArtifactConfigT = ArtifactConfigInput>
286 void SetArtifactConfig(ArtifactConfigT&& value) {
287 m_artifactConfigHasBeenSet = true;
288 m_artifactConfig = std::forward<ArtifactConfigT>(value);
289 }
290 template <typename ArtifactConfigT = ArtifactConfigInput>
291 UpdateCanaryRequest& WithArtifactConfig(ArtifactConfigT&& value) {
292 SetArtifactConfig(std::forward<ArtifactConfigT>(value));
293 return *this;
294 }
296
298
307 inline ProvisionedResourceCleanupSetting GetProvisionedResourceCleanup() const { return m_provisionedResourceCleanup; }
308 inline bool ProvisionedResourceCleanupHasBeenSet() const { return m_provisionedResourceCleanupHasBeenSet; }
310 m_provisionedResourceCleanupHasBeenSet = true;
311 m_provisionedResourceCleanup = value;
312 }
315 return *this;
316 }
318
320
327 inline const Aws::String& GetDryRunId() const { return m_dryRunId; }
328 inline bool DryRunIdHasBeenSet() const { return m_dryRunIdHasBeenSet; }
329 template <typename DryRunIdT = Aws::String>
330 void SetDryRunId(DryRunIdT&& value) {
331 m_dryRunIdHasBeenSet = true;
332 m_dryRunId = std::forward<DryRunIdT>(value);
333 }
334 template <typename DryRunIdT = Aws::String>
335 UpdateCanaryRequest& WithDryRunId(DryRunIdT&& value) {
336 SetDryRunId(std::forward<DryRunIdT>(value));
337 return *this;
338 }
340
342
362 inline const Aws::Vector<VisualReferenceInput>& GetVisualReferences() const { return m_visualReferences; }
363 inline bool VisualReferencesHasBeenSet() const { return m_visualReferencesHasBeenSet; }
364 template <typename VisualReferencesT = Aws::Vector<VisualReferenceInput>>
365 void SetVisualReferences(VisualReferencesT&& value) {
366 m_visualReferencesHasBeenSet = true;
367 m_visualReferences = std::forward<VisualReferencesT>(value);
368 }
369 template <typename VisualReferencesT = Aws::Vector<VisualReferenceInput>>
370 UpdateCanaryRequest& WithVisualReferences(VisualReferencesT&& value) {
371 SetVisualReferences(std::forward<VisualReferencesT>(value));
372 return *this;
373 }
374 template <typename VisualReferencesT = VisualReferenceInput>
375 UpdateCanaryRequest& AddVisualReferences(VisualReferencesT&& value) {
376 m_visualReferencesHasBeenSet = true;
377 m_visualReferences.emplace_back(std::forward<VisualReferencesT>(value));
378 return *this;
379 }
381
383
389 inline const Aws::Vector<BrowserConfig>& GetBrowserConfigs() const { return m_browserConfigs; }
390 inline bool BrowserConfigsHasBeenSet() const { return m_browserConfigsHasBeenSet; }
391 template <typename BrowserConfigsT = Aws::Vector<BrowserConfig>>
392 void SetBrowserConfigs(BrowserConfigsT&& value) {
393 m_browserConfigsHasBeenSet = true;
394 m_browserConfigs = std::forward<BrowserConfigsT>(value);
395 }
396 template <typename BrowserConfigsT = Aws::Vector<BrowserConfig>>
397 UpdateCanaryRequest& WithBrowserConfigs(BrowserConfigsT&& value) {
398 SetBrowserConfigs(std::forward<BrowserConfigsT>(value));
399 return *this;
400 }
401 template <typename BrowserConfigsT = BrowserConfig>
402 UpdateCanaryRequest& AddBrowserConfigs(BrowserConfigsT&& value) {
403 m_browserConfigsHasBeenSet = true;
404 m_browserConfigs.emplace_back(std::forward<BrowserConfigsT>(value));
405 return *this;
406 }
408
410
415 inline const Aws::Vector<AddReplicaLocationInput>& GetAddReplicaLocations() const { return m_addReplicaLocations; }
416 inline bool AddReplicaLocationsHasBeenSet() const { return m_addReplicaLocationsHasBeenSet; }
417 template <typename AddReplicaLocationsT = Aws::Vector<AddReplicaLocationInput>>
418 void SetAddReplicaLocations(AddReplicaLocationsT&& value) {
419 m_addReplicaLocationsHasBeenSet = true;
420 m_addReplicaLocations = std::forward<AddReplicaLocationsT>(value);
421 }
422 template <typename AddReplicaLocationsT = Aws::Vector<AddReplicaLocationInput>>
423 UpdateCanaryRequest& WithAddReplicaLocations(AddReplicaLocationsT&& value) {
424 SetAddReplicaLocations(std::forward<AddReplicaLocationsT>(value));
425 return *this;
426 }
427 template <typename AddReplicaLocationsT = AddReplicaLocationInput>
428 UpdateCanaryRequest& AddAddReplicaLocations(AddReplicaLocationsT&& value) {
429 m_addReplicaLocationsHasBeenSet = true;
430 m_addReplicaLocations.emplace_back(std::forward<AddReplicaLocationsT>(value));
431 return *this;
432 }
434
436
441 inline const Aws::Vector<Aws::String>& GetRemoveReplicaLocations() const { return m_removeReplicaLocations; }
442 inline bool RemoveReplicaLocationsHasBeenSet() const { return m_removeReplicaLocationsHasBeenSet; }
443 template <typename RemoveReplicaLocationsT = Aws::Vector<Aws::String>>
444 void SetRemoveReplicaLocations(RemoveReplicaLocationsT&& value) {
445 m_removeReplicaLocationsHasBeenSet = true;
446 m_removeReplicaLocations = std::forward<RemoveReplicaLocationsT>(value);
447 }
448 template <typename RemoveReplicaLocationsT = Aws::Vector<Aws::String>>
449 UpdateCanaryRequest& WithRemoveReplicaLocations(RemoveReplicaLocationsT&& value) {
450 SetRemoveReplicaLocations(std::forward<RemoveReplicaLocationsT>(value));
451 return *this;
452 }
453 template <typename RemoveReplicaLocationsT = Aws::String>
454 UpdateCanaryRequest& AddRemoveReplicaLocations(RemoveReplicaLocationsT&& value) {
455 m_removeReplicaLocationsHasBeenSet = true;
456 m_removeReplicaLocations.emplace_back(std::forward<RemoveReplicaLocationsT>(value));
457 return *this;
458 }
460
462
470 inline const Aws::String& GetKmsKeyArn() const { return m_kmsKeyArn; }
471 inline bool KmsKeyArnHasBeenSet() const { return m_kmsKeyArnHasBeenSet; }
472 template <typename KmsKeyArnT = Aws::String>
473 void SetKmsKeyArn(KmsKeyArnT&& value) {
474 m_kmsKeyArnHasBeenSet = true;
475 m_kmsKeyArn = std::forward<KmsKeyArnT>(value);
476 }
477 template <typename KmsKeyArnT = Aws::String>
478 UpdateCanaryRequest& WithKmsKeyArn(KmsKeyArnT&& value) {
479 SetKmsKeyArn(std::forward<KmsKeyArnT>(value));
480 return *this;
481 }
483 private:
484 Aws::String m_name;
485
486 CanaryCodeInput m_code;
487
488 Aws::String m_executionRoleArn;
489
490 Aws::String m_runtimeVersion;
491
492 CanaryScheduleInput m_schedule;
493
494 CanaryRunConfigInput m_runConfig;
495
496 int m_successRetentionPeriodInDays{0};
497
498 int m_failureRetentionPeriodInDays{0};
499
500 VpcConfigInput m_vpcConfig;
501
502 VisualReferenceInput m_visualReference;
503
504 Aws::String m_artifactS3Location;
505
506 ArtifactConfigInput m_artifactConfig;
507
509
510 Aws::String m_dryRunId;
511
512 Aws::Vector<VisualReferenceInput> m_visualReferences;
513
514 Aws::Vector<BrowserConfig> m_browserConfigs;
515
516 Aws::Vector<AddReplicaLocationInput> m_addReplicaLocations;
517
518 Aws::Vector<Aws::String> m_removeReplicaLocations;
519
520 Aws::String m_kmsKeyArn;
521 bool m_nameHasBeenSet = false;
522 bool m_codeHasBeenSet = false;
523 bool m_executionRoleArnHasBeenSet = false;
524 bool m_runtimeVersionHasBeenSet = false;
525 bool m_scheduleHasBeenSet = false;
526 bool m_runConfigHasBeenSet = false;
527 bool m_successRetentionPeriodInDaysHasBeenSet = false;
528 bool m_failureRetentionPeriodInDaysHasBeenSet = false;
529 bool m_vpcConfigHasBeenSet = false;
530 bool m_visualReferenceHasBeenSet = false;
531 bool m_artifactS3LocationHasBeenSet = false;
532 bool m_artifactConfigHasBeenSet = false;
533 bool m_provisionedResourceCleanupHasBeenSet = false;
534 bool m_dryRunIdHasBeenSet = false;
535 bool m_visualReferencesHasBeenSet = false;
536 bool m_browserConfigsHasBeenSet = false;
537 bool m_addReplicaLocationsHasBeenSet = false;
538 bool m_removeReplicaLocationsHasBeenSet = false;
539 bool m_kmsKeyArnHasBeenSet = false;
540};
541
542} // namespace Model
543} // namespace Synthetics
544} // namespace Aws
UpdateCanaryRequest & AddVisualReferences(VisualReferencesT &&value)
void SetRemoveReplicaLocations(RemoveReplicaLocationsT &&value)
const VisualReferenceInput & GetVisualReference() const
UpdateCanaryRequest & WithKmsKeyArn(KmsKeyArnT &&value)
const Aws::Vector< BrowserConfig > & GetBrowserConfigs() const
UpdateCanaryRequest & WithRunConfig(RunConfigT &&value)
UpdateCanaryRequest & AddAddReplicaLocations(AddReplicaLocationsT &&value)
const Aws::Vector< VisualReferenceInput > & GetVisualReferences() const
UpdateCanaryRequest & AddRemoveReplicaLocations(RemoveReplicaLocationsT &&value)
UpdateCanaryRequest & WithFailureRetentionPeriodInDays(int value)
AWS_SYNTHETICS_API Aws::String SerializePayload() const override
UpdateCanaryRequest & WithArtifactS3Location(ArtifactS3LocationT &&value)
UpdateCanaryRequest & WithAddReplicaLocations(AddReplicaLocationsT &&value)
void SetProvisionedResourceCleanup(ProvisionedResourceCleanupSetting value)
UpdateCanaryRequest & WithExecutionRoleArn(ExecutionRoleArnT &&value)
UpdateCanaryRequest & WithBrowserConfigs(BrowserConfigsT &&value)
UpdateCanaryRequest & WithVisualReferences(VisualReferencesT &&value)
void SetExecutionRoleArn(ExecutionRoleArnT &&value)
const CanaryScheduleInput & GetSchedule() const
const ArtifactConfigInput & GetArtifactConfig() const
UpdateCanaryRequest & AddBrowserConfigs(BrowserConfigsT &&value)
UpdateCanaryRequest & WithVisualReference(VisualReferenceT &&value)
UpdateCanaryRequest & WithName(NameT &&value)
void SetArtifactConfig(ArtifactConfigT &&value)
UpdateCanaryRequest & WithSchedule(ScheduleT &&value)
void SetVisualReference(VisualReferenceT &&value)
void SetVisualReferences(VisualReferencesT &&value)
UpdateCanaryRequest & WithRuntimeVersion(RuntimeVersionT &&value)
const Aws::Vector< Aws::String > & GetRemoveReplicaLocations() const
AWS_SYNTHETICS_API UpdateCanaryRequest()=default
const CanaryRunConfigInput & GetRunConfig() const
void SetRuntimeVersion(RuntimeVersionT &&value)
UpdateCanaryRequest & WithArtifactConfig(ArtifactConfigT &&value)
UpdateCanaryRequest & WithDryRunId(DryRunIdT &&value)
UpdateCanaryRequest & WithProvisionedResourceCleanup(ProvisionedResourceCleanupSetting value)
void SetArtifactS3Location(ArtifactS3LocationT &&value)
virtual const char * GetServiceRequestName() const override
UpdateCanaryRequest & WithCode(CodeT &&value)
ProvisionedResourceCleanupSetting GetProvisionedResourceCleanup() const
const Aws::Vector< AddReplicaLocationInput > & GetAddReplicaLocations() const
void SetAddReplicaLocations(AddReplicaLocationsT &&value)
UpdateCanaryRequest & WithRemoveReplicaLocations(RemoveReplicaLocationsT &&value)
void SetBrowserConfigs(BrowserConfigsT &&value)
UpdateCanaryRequest & WithSuccessRetentionPeriodInDays(int value)
UpdateCanaryRequest & WithVpcConfig(VpcConfigT &&value)
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector