AWS SDK for C++

AWS SDK for C++ Version 1.11.634

Loading...
Searching...
No Matches
UpdateCanaryRequest.h
1
6#pragma once
7#include <aws/synthetics/Synthetics_EXPORTS.h>
8#include <aws/synthetics/SyntheticsRequest.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/synthetics/model/CanaryCodeInput.h>
11#include <aws/synthetics/model/CanaryScheduleInput.h>
12#include <aws/synthetics/model/CanaryRunConfigInput.h>
13#include <aws/synthetics/model/VpcConfigInput.h>
14#include <aws/synthetics/model/VisualReferenceInput.h>
15#include <aws/synthetics/model/ArtifactConfigInput.h>
16#include <aws/synthetics/model/ProvisionedResourceCleanupSetting.h>
17#include <aws/core/utils/memory/stl/AWSVector.h>
18#include <aws/synthetics/model/BrowserConfig.h>
19#include <utility>
20
21namespace Aws
22{
23namespace Synthetics
24{
25namespace Model
26{
27
31 {
32 public:
33 AWS_SYNTHETICS_API UpdateCanaryRequest() = default;
34
35 // Service request name is the Operation name which will send this request out,
36 // each operation should has unique request name, so that we can get operation's name from this request.
37 // Note: this is not true for response, multiple operations may have the same response name,
38 // so we can not get operation's name from response.
39 inline virtual const char* GetServiceRequestName() const override { return "UpdateCanary"; }
40
41 AWS_SYNTHETICS_API Aws::String SerializePayload() const override;
42
43
45
51 inline const Aws::String& GetName() const { return m_name; }
52 inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
53 template<typename NameT = Aws::String>
54 void SetName(NameT&& value) { m_nameHasBeenSet = true; m_name = std::forward<NameT>(value); }
55 template<typename NameT = Aws::String>
56 UpdateCanaryRequest& WithName(NameT&& value) { SetName(std::forward<NameT>(value)); return *this;}
58
60
65 inline const CanaryCodeInput& GetCode() const { return m_code; }
66 inline bool CodeHasBeenSet() const { return m_codeHasBeenSet; }
67 template<typename CodeT = CanaryCodeInput>
68 void SetCode(CodeT&& value) { m_codeHasBeenSet = true; m_code = std::forward<CodeT>(value); }
69 template<typename CodeT = CanaryCodeInput>
70 UpdateCanaryRequest& WithCode(CodeT&& value) { SetCode(std::forward<CodeT>(value)); return *this;}
72
74
86 inline const Aws::String& GetExecutionRoleArn() const { return m_executionRoleArn; }
87 inline bool ExecutionRoleArnHasBeenSet() const { return m_executionRoleArnHasBeenSet; }
88 template<typename ExecutionRoleArnT = Aws::String>
89 void SetExecutionRoleArn(ExecutionRoleArnT&& value) { m_executionRoleArnHasBeenSet = true; m_executionRoleArn = std::forward<ExecutionRoleArnT>(value); }
90 template<typename ExecutionRoleArnT = Aws::String>
91 UpdateCanaryRequest& WithExecutionRoleArn(ExecutionRoleArnT&& value) { SetExecutionRoleArn(std::forward<ExecutionRoleArnT>(value)); return *this;}
93
95
101 inline const Aws::String& GetRuntimeVersion() const { return m_runtimeVersion; }
102 inline bool RuntimeVersionHasBeenSet() const { return m_runtimeVersionHasBeenSet; }
103 template<typename RuntimeVersionT = Aws::String>
104 void SetRuntimeVersion(RuntimeVersionT&& value) { m_runtimeVersionHasBeenSet = true; m_runtimeVersion = std::forward<RuntimeVersionT>(value); }
105 template<typename RuntimeVersionT = Aws::String>
106 UpdateCanaryRequest& WithRuntimeVersion(RuntimeVersionT&& value) { SetRuntimeVersion(std::forward<RuntimeVersionT>(value)); return *this;}
108
110
114 inline const CanaryScheduleInput& GetSchedule() const { return m_schedule; }
115 inline bool ScheduleHasBeenSet() const { return m_scheduleHasBeenSet; }
116 template<typename ScheduleT = CanaryScheduleInput>
117 void SetSchedule(ScheduleT&& value) { m_scheduleHasBeenSet = true; m_schedule = std::forward<ScheduleT>(value); }
118 template<typename ScheduleT = CanaryScheduleInput>
119 UpdateCanaryRequest& WithSchedule(ScheduleT&& value) { SetSchedule(std::forward<ScheduleT>(value)); return *this;}
121
123
130 inline const CanaryRunConfigInput& GetRunConfig() const { return m_runConfig; }
131 inline bool RunConfigHasBeenSet() const { return m_runConfigHasBeenSet; }
132 template<typename RunConfigT = CanaryRunConfigInput>
133 void SetRunConfig(RunConfigT&& value) { m_runConfigHasBeenSet = true; m_runConfig = std::forward<RunConfigT>(value); }
134 template<typename RunConfigT = CanaryRunConfigInput>
135 UpdateCanaryRequest& WithRunConfig(RunConfigT&& value) { SetRunConfig(std::forward<RunConfigT>(value)); return *this;}
137
139
145 inline int GetSuccessRetentionPeriodInDays() const { return m_successRetentionPeriodInDays; }
146 inline bool SuccessRetentionPeriodInDaysHasBeenSet() const { return m_successRetentionPeriodInDaysHasBeenSet; }
147 inline void SetSuccessRetentionPeriodInDays(int value) { m_successRetentionPeriodInDaysHasBeenSet = true; m_successRetentionPeriodInDays = value; }
150
152
158 inline int GetFailureRetentionPeriodInDays() const { return m_failureRetentionPeriodInDays; }
159 inline bool FailureRetentionPeriodInDaysHasBeenSet() const { return m_failureRetentionPeriodInDaysHasBeenSet; }
160 inline void SetFailureRetentionPeriodInDays(int value) { m_failureRetentionPeriodInDaysHasBeenSet = true; m_failureRetentionPeriodInDays = value; }
163
165
172 inline const VpcConfigInput& GetVpcConfig() const { return m_vpcConfig; }
173 inline bool VpcConfigHasBeenSet() const { return m_vpcConfigHasBeenSet; }
174 template<typename VpcConfigT = VpcConfigInput>
175 void SetVpcConfig(VpcConfigT&& value) { m_vpcConfigHasBeenSet = true; m_vpcConfig = std::forward<VpcConfigT>(value); }
176 template<typename VpcConfigT = VpcConfigInput>
177 UpdateCanaryRequest& WithVpcConfig(VpcConfigT&& value) { SetVpcConfig(std::forward<VpcConfigT>(value)); return *this;}
179
181
192 inline const VisualReferenceInput& GetVisualReference() const { return m_visualReference; }
193 inline bool VisualReferenceHasBeenSet() const { return m_visualReferenceHasBeenSet; }
194 template<typename VisualReferenceT = VisualReferenceInput>
195 void SetVisualReference(VisualReferenceT&& value) { m_visualReferenceHasBeenSet = true; m_visualReference = std::forward<VisualReferenceT>(value); }
196 template<typename VisualReferenceT = VisualReferenceInput>
197 UpdateCanaryRequest& WithVisualReference(VisualReferenceT&& value) { SetVisualReference(std::forward<VisualReferenceT>(value)); return *this;}
199
201
206 inline const Aws::String& GetArtifactS3Location() const { return m_artifactS3Location; }
207 inline bool ArtifactS3LocationHasBeenSet() const { return m_artifactS3LocationHasBeenSet; }
208 template<typename ArtifactS3LocationT = Aws::String>
209 void SetArtifactS3Location(ArtifactS3LocationT&& value) { m_artifactS3LocationHasBeenSet = true; m_artifactS3Location = std::forward<ArtifactS3LocationT>(value); }
210 template<typename ArtifactS3LocationT = Aws::String>
211 UpdateCanaryRequest& WithArtifactS3Location(ArtifactS3LocationT&& value) { SetArtifactS3Location(std::forward<ArtifactS3LocationT>(value)); return *this;}
213
215
220 inline const ArtifactConfigInput& GetArtifactConfig() const { return m_artifactConfig; }
221 inline bool ArtifactConfigHasBeenSet() const { return m_artifactConfigHasBeenSet; }
222 template<typename ArtifactConfigT = ArtifactConfigInput>
223 void SetArtifactConfig(ArtifactConfigT&& value) { m_artifactConfigHasBeenSet = true; m_artifactConfig = std::forward<ArtifactConfigT>(value); }
224 template<typename ArtifactConfigT = ArtifactConfigInput>
225 UpdateCanaryRequest& WithArtifactConfig(ArtifactConfigT&& value) { SetArtifactConfig(std::forward<ArtifactConfigT>(value)); return *this;}
227
229
238 inline ProvisionedResourceCleanupSetting GetProvisionedResourceCleanup() const { return m_provisionedResourceCleanup; }
239 inline bool ProvisionedResourceCleanupHasBeenSet() const { return m_provisionedResourceCleanupHasBeenSet; }
240 inline void SetProvisionedResourceCleanup(ProvisionedResourceCleanupSetting value) { m_provisionedResourceCleanupHasBeenSet = true; m_provisionedResourceCleanup = value; }
243
245
252 inline const Aws::String& GetDryRunId() const { return m_dryRunId; }
253 inline bool DryRunIdHasBeenSet() const { return m_dryRunIdHasBeenSet; }
254 template<typename DryRunIdT = Aws::String>
255 void SetDryRunId(DryRunIdT&& value) { m_dryRunIdHasBeenSet = true; m_dryRunId = std::forward<DryRunIdT>(value); }
256 template<typename DryRunIdT = Aws::String>
257 UpdateCanaryRequest& WithDryRunId(DryRunIdT&& value) { SetDryRunId(std::forward<DryRunIdT>(value)); return *this;}
259
261
281 inline const Aws::Vector<VisualReferenceInput>& GetVisualReferences() const { return m_visualReferences; }
282 inline bool VisualReferencesHasBeenSet() const { return m_visualReferencesHasBeenSet; }
283 template<typename VisualReferencesT = Aws::Vector<VisualReferenceInput>>
284 void SetVisualReferences(VisualReferencesT&& value) { m_visualReferencesHasBeenSet = true; m_visualReferences = std::forward<VisualReferencesT>(value); }
285 template<typename VisualReferencesT = Aws::Vector<VisualReferenceInput>>
286 UpdateCanaryRequest& WithVisualReferences(VisualReferencesT&& value) { SetVisualReferences(std::forward<VisualReferencesT>(value)); return *this;}
287 template<typename VisualReferencesT = VisualReferenceInput>
288 UpdateCanaryRequest& AddVisualReferences(VisualReferencesT&& value) { m_visualReferencesHasBeenSet = true; m_visualReferences.emplace_back(std::forward<VisualReferencesT>(value)); return *this; }
290
292
298 inline const Aws::Vector<BrowserConfig>& GetBrowserConfigs() const { return m_browserConfigs; }
299 inline bool BrowserConfigsHasBeenSet() const { return m_browserConfigsHasBeenSet; }
300 template<typename BrowserConfigsT = Aws::Vector<BrowserConfig>>
301 void SetBrowserConfigs(BrowserConfigsT&& value) { m_browserConfigsHasBeenSet = true; m_browserConfigs = std::forward<BrowserConfigsT>(value); }
302 template<typename BrowserConfigsT = Aws::Vector<BrowserConfig>>
303 UpdateCanaryRequest& WithBrowserConfigs(BrowserConfigsT&& value) { SetBrowserConfigs(std::forward<BrowserConfigsT>(value)); return *this;}
304 template<typename BrowserConfigsT = BrowserConfig>
305 UpdateCanaryRequest& AddBrowserConfigs(BrowserConfigsT&& value) { m_browserConfigsHasBeenSet = true; m_browserConfigs.emplace_back(std::forward<BrowserConfigsT>(value)); return *this; }
307 private:
308
309 Aws::String m_name;
310 bool m_nameHasBeenSet = false;
311
312 CanaryCodeInput m_code;
313 bool m_codeHasBeenSet = false;
314
315 Aws::String m_executionRoleArn;
316 bool m_executionRoleArnHasBeenSet = false;
317
318 Aws::String m_runtimeVersion;
319 bool m_runtimeVersionHasBeenSet = false;
320
321 CanaryScheduleInput m_schedule;
322 bool m_scheduleHasBeenSet = false;
323
324 CanaryRunConfigInput m_runConfig;
325 bool m_runConfigHasBeenSet = false;
326
327 int m_successRetentionPeriodInDays{0};
328 bool m_successRetentionPeriodInDaysHasBeenSet = false;
329
330 int m_failureRetentionPeriodInDays{0};
331 bool m_failureRetentionPeriodInDaysHasBeenSet = false;
332
333 VpcConfigInput m_vpcConfig;
334 bool m_vpcConfigHasBeenSet = false;
335
336 VisualReferenceInput m_visualReference;
337 bool m_visualReferenceHasBeenSet = false;
338
339 Aws::String m_artifactS3Location;
340 bool m_artifactS3LocationHasBeenSet = false;
341
342 ArtifactConfigInput m_artifactConfig;
343 bool m_artifactConfigHasBeenSet = false;
344
346 bool m_provisionedResourceCleanupHasBeenSet = false;
347
348 Aws::String m_dryRunId;
349 bool m_dryRunIdHasBeenSet = false;
350
351 Aws::Vector<VisualReferenceInput> m_visualReferences;
352 bool m_visualReferencesHasBeenSet = false;
353
354 Aws::Vector<BrowserConfig> m_browserConfigs;
355 bool m_browserConfigsHasBeenSet = false;
356 };
357
358} // namespace Model
359} // namespace Synthetics
360} // namespace Aws
UpdateCanaryRequest & AddVisualReferences(VisualReferencesT &&value)
const VisualReferenceInput & GetVisualReference() const
const Aws::Vector< BrowserConfig > & GetBrowserConfigs() const
UpdateCanaryRequest & WithRunConfig(RunConfigT &&value)
const Aws::Vector< VisualReferenceInput > & GetVisualReferences() const
UpdateCanaryRequest & WithFailureRetentionPeriodInDays(int value)
AWS_SYNTHETICS_API Aws::String SerializePayload() const override
UpdateCanaryRequest & WithArtifactS3Location(ArtifactS3LocationT &&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)
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
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