AWS SDK for C++

AWS SDK for C++ Version 1.11.717

Loading...
Searching...
No Matches
CreateCanaryRequest.h
1
6#pragma once
7#include <aws/core/utils/memory/stl/AWSMap.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/core/utils/memory/stl/AWSVector.h>
10#include <aws/synthetics/SyntheticsRequest.h>
11#include <aws/synthetics/Synthetics_EXPORTS.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/ResourceToTag.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 CreateCanaryRequest() = 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 "CreateCanary"; }
38
39 AWS_SYNTHETICS_API Aws::String SerializePayload() const override;
40
42
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) {
55 m_nameHasBeenSet = true;
56 m_name = std::forward<NameT>(value);
57 }
58 template <typename NameT = Aws::String>
59 CreateCanaryRequest& WithName(NameT&& value) {
60 SetName(std::forward<NameT>(value));
61 return *this;
62 }
64
66
71 inline const CanaryCodeInput& GetCode() const { return m_code; }
72 inline bool CodeHasBeenSet() const { return m_codeHasBeenSet; }
73 template <typename CodeT = CanaryCodeInput>
74 void SetCode(CodeT&& value) {
75 m_codeHasBeenSet = true;
76 m_code = std::forward<CodeT>(value);
77 }
78 template <typename CodeT = CanaryCodeInput>
79 CreateCanaryRequest& WithCode(CodeT&& value) {
80 SetCode(std::forward<CodeT>(value));
81 return *this;
82 }
84
86
91 inline const Aws::String& GetArtifactS3Location() const { return m_artifactS3Location; }
92 inline bool ArtifactS3LocationHasBeenSet() const { return m_artifactS3LocationHasBeenSet; }
93 template <typename ArtifactS3LocationT = Aws::String>
94 void SetArtifactS3Location(ArtifactS3LocationT&& value) {
95 m_artifactS3LocationHasBeenSet = true;
96 m_artifactS3Location = std::forward<ArtifactS3LocationT>(value);
97 }
98 template <typename ArtifactS3LocationT = Aws::String>
99 CreateCanaryRequest& WithArtifactS3Location(ArtifactS3LocationT&& value) {
100 SetArtifactS3Location(std::forward<ArtifactS3LocationT>(value));
101 return *this;
102 }
104
106
118 inline const Aws::String& GetExecutionRoleArn() const { return m_executionRoleArn; }
119 inline bool ExecutionRoleArnHasBeenSet() const { return m_executionRoleArnHasBeenSet; }
120 template <typename ExecutionRoleArnT = Aws::String>
121 void SetExecutionRoleArn(ExecutionRoleArnT&& value) {
122 m_executionRoleArnHasBeenSet = true;
123 m_executionRoleArn = std::forward<ExecutionRoleArnT>(value);
124 }
125 template <typename ExecutionRoleArnT = Aws::String>
126 CreateCanaryRequest& WithExecutionRoleArn(ExecutionRoleArnT&& value) {
127 SetExecutionRoleArn(std::forward<ExecutionRoleArnT>(value));
128 return *this;
129 }
131
133
137 inline const CanaryScheduleInput& GetSchedule() const { return m_schedule; }
138 inline bool ScheduleHasBeenSet() const { return m_scheduleHasBeenSet; }
139 template <typename ScheduleT = CanaryScheduleInput>
140 void SetSchedule(ScheduleT&& value) {
141 m_scheduleHasBeenSet = true;
142 m_schedule = std::forward<ScheduleT>(value);
143 }
144 template <typename ScheduleT = CanaryScheduleInput>
145 CreateCanaryRequest& WithSchedule(ScheduleT&& value) {
146 SetSchedule(std::forward<ScheduleT>(value));
147 return *this;
148 }
150
152
159 inline const CanaryRunConfigInput& GetRunConfig() const { return m_runConfig; }
160 inline bool RunConfigHasBeenSet() const { return m_runConfigHasBeenSet; }
161 template <typename RunConfigT = CanaryRunConfigInput>
162 void SetRunConfig(RunConfigT&& value) {
163 m_runConfigHasBeenSet = true;
164 m_runConfig = std::forward<RunConfigT>(value);
165 }
166 template <typename RunConfigT = CanaryRunConfigInput>
167 CreateCanaryRequest& WithRunConfig(RunConfigT&& value) {
168 SetRunConfig(std::forward<RunConfigT>(value));
169 return *this;
170 }
172
174
181 inline int GetSuccessRetentionPeriodInDays() const { return m_successRetentionPeriodInDays; }
182 inline bool SuccessRetentionPeriodInDaysHasBeenSet() const { return m_successRetentionPeriodInDaysHasBeenSet; }
183 inline void SetSuccessRetentionPeriodInDays(int value) {
184 m_successRetentionPeriodInDaysHasBeenSet = true;
185 m_successRetentionPeriodInDays = value;
186 }
189 return *this;
190 }
192
194
201 inline int GetFailureRetentionPeriodInDays() const { return m_failureRetentionPeriodInDays; }
202 inline bool FailureRetentionPeriodInDaysHasBeenSet() const { return m_failureRetentionPeriodInDaysHasBeenSet; }
203 inline void SetFailureRetentionPeriodInDays(int value) {
204 m_failureRetentionPeriodInDaysHasBeenSet = true;
205 m_failureRetentionPeriodInDays = value;
206 }
209 return *this;
210 }
212
214
220 inline const Aws::String& GetRuntimeVersion() const { return m_runtimeVersion; }
221 inline bool RuntimeVersionHasBeenSet() const { return m_runtimeVersionHasBeenSet; }
222 template <typename RuntimeVersionT = Aws::String>
223 void SetRuntimeVersion(RuntimeVersionT&& value) {
224 m_runtimeVersionHasBeenSet = true;
225 m_runtimeVersion = std::forward<RuntimeVersionT>(value);
226 }
227 template <typename RuntimeVersionT = Aws::String>
228 CreateCanaryRequest& WithRuntimeVersion(RuntimeVersionT&& value) {
229 SetRuntimeVersion(std::forward<RuntimeVersionT>(value));
230 return *this;
231 }
233
235
242 inline const VpcConfigInput& GetVpcConfig() const { return m_vpcConfig; }
243 inline bool VpcConfigHasBeenSet() const { return m_vpcConfigHasBeenSet; }
244 template <typename VpcConfigT = VpcConfigInput>
245 void SetVpcConfig(VpcConfigT&& value) {
246 m_vpcConfigHasBeenSet = true;
247 m_vpcConfig = std::forward<VpcConfigT>(value);
248 }
249 template <typename VpcConfigT = VpcConfigInput>
250 CreateCanaryRequest& WithVpcConfig(VpcConfigT&& value) {
251 SetVpcConfig(std::forward<VpcConfigT>(value));
252 return *this;
253 }
255
257
264 inline const Aws::Vector<ResourceToTag>& GetResourcesToReplicateTags() const { return m_resourcesToReplicateTags; }
265 inline bool ResourcesToReplicateTagsHasBeenSet() const { return m_resourcesToReplicateTagsHasBeenSet; }
266 template <typename ResourcesToReplicateTagsT = Aws::Vector<ResourceToTag>>
267 void SetResourcesToReplicateTags(ResourcesToReplicateTagsT&& value) {
268 m_resourcesToReplicateTagsHasBeenSet = true;
269 m_resourcesToReplicateTags = std::forward<ResourcesToReplicateTagsT>(value);
270 }
271 template <typename ResourcesToReplicateTagsT = Aws::Vector<ResourceToTag>>
272 CreateCanaryRequest& WithResourcesToReplicateTags(ResourcesToReplicateTagsT&& value) {
273 SetResourcesToReplicateTags(std::forward<ResourcesToReplicateTagsT>(value));
274 return *this;
275 }
277 m_resourcesToReplicateTagsHasBeenSet = true;
278 m_resourcesToReplicateTags.push_back(value);
279 return *this;
280 }
282
284
295 inline ProvisionedResourceCleanupSetting GetProvisionedResourceCleanup() const { return m_provisionedResourceCleanup; }
296 inline bool ProvisionedResourceCleanupHasBeenSet() const { return m_provisionedResourceCleanupHasBeenSet; }
298 m_provisionedResourceCleanupHasBeenSet = true;
299 m_provisionedResourceCleanup = value;
300 }
303 return *this;
304 }
306
308
317 inline const Aws::Vector<BrowserConfig>& GetBrowserConfigs() const { return m_browserConfigs; }
318 inline bool BrowserConfigsHasBeenSet() const { return m_browserConfigsHasBeenSet; }
319 template <typename BrowserConfigsT = Aws::Vector<BrowserConfig>>
320 void SetBrowserConfigs(BrowserConfigsT&& value) {
321 m_browserConfigsHasBeenSet = true;
322 m_browserConfigs = std::forward<BrowserConfigsT>(value);
323 }
324 template <typename BrowserConfigsT = Aws::Vector<BrowserConfig>>
325 CreateCanaryRequest& WithBrowserConfigs(BrowserConfigsT&& value) {
326 SetBrowserConfigs(std::forward<BrowserConfigsT>(value));
327 return *this;
328 }
329 template <typename BrowserConfigsT = BrowserConfig>
330 CreateCanaryRequest& AddBrowserConfigs(BrowserConfigsT&& value) {
331 m_browserConfigsHasBeenSet = true;
332 m_browserConfigs.emplace_back(std::forward<BrowserConfigsT>(value));
333 return *this;
334 }
336
338
347 inline const Aws::Map<Aws::String, Aws::String>& GetTags() const { return m_tags; }
348 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
349 template <typename TagsT = Aws::Map<Aws::String, Aws::String>>
350 void SetTags(TagsT&& value) {
351 m_tagsHasBeenSet = true;
352 m_tags = std::forward<TagsT>(value);
353 }
354 template <typename TagsT = Aws::Map<Aws::String, Aws::String>>
356 SetTags(std::forward<TagsT>(value));
357 return *this;
358 }
359 template <typename TagsKeyT = Aws::String, typename TagsValueT = Aws::String>
360 CreateCanaryRequest& AddTags(TagsKeyT&& key, TagsValueT&& value) {
361 m_tagsHasBeenSet = true;
362 m_tags.emplace(std::forward<TagsKeyT>(key), std::forward<TagsValueT>(value));
363 return *this;
364 }
366
368
373 inline const ArtifactConfigInput& GetArtifactConfig() const { return m_artifactConfig; }
374 inline bool ArtifactConfigHasBeenSet() const { return m_artifactConfigHasBeenSet; }
375 template <typename ArtifactConfigT = ArtifactConfigInput>
376 void SetArtifactConfig(ArtifactConfigT&& value) {
377 m_artifactConfigHasBeenSet = true;
378 m_artifactConfig = std::forward<ArtifactConfigT>(value);
379 }
380 template <typename ArtifactConfigT = ArtifactConfigInput>
381 CreateCanaryRequest& WithArtifactConfig(ArtifactConfigT&& value) {
382 SetArtifactConfig(std::forward<ArtifactConfigT>(value));
383 return *this;
384 }
386 private:
387 Aws::String m_name;
388
389 CanaryCodeInput m_code;
390
391 Aws::String m_artifactS3Location;
392
393 Aws::String m_executionRoleArn;
394
395 CanaryScheduleInput m_schedule;
396
397 CanaryRunConfigInput m_runConfig;
398
399 int m_successRetentionPeriodInDays{0};
400
401 int m_failureRetentionPeriodInDays{0};
402
403 Aws::String m_runtimeVersion;
404
405 VpcConfigInput m_vpcConfig;
406
407 Aws::Vector<ResourceToTag> m_resourcesToReplicateTags;
408
410
411 Aws::Vector<BrowserConfig> m_browserConfigs;
412
414
415 ArtifactConfigInput m_artifactConfig;
416 bool m_nameHasBeenSet = false;
417 bool m_codeHasBeenSet = false;
418 bool m_artifactS3LocationHasBeenSet = false;
419 bool m_executionRoleArnHasBeenSet = false;
420 bool m_scheduleHasBeenSet = false;
421 bool m_runConfigHasBeenSet = false;
422 bool m_successRetentionPeriodInDaysHasBeenSet = false;
423 bool m_failureRetentionPeriodInDaysHasBeenSet = false;
424 bool m_runtimeVersionHasBeenSet = false;
425 bool m_vpcConfigHasBeenSet = false;
426 bool m_resourcesToReplicateTagsHasBeenSet = false;
427 bool m_provisionedResourceCleanupHasBeenSet = false;
428 bool m_browserConfigsHasBeenSet = false;
429 bool m_tagsHasBeenSet = false;
430 bool m_artifactConfigHasBeenSet = false;
431};
432
433} // namespace Model
434} // namespace Synthetics
435} // namespace Aws
const ArtifactConfigInput & GetArtifactConfig() const
const CanaryScheduleInput & GetSchedule() const
void SetArtifactS3Location(ArtifactS3LocationT &&value)
CreateCanaryRequest & WithName(NameT &&value)
CreateCanaryRequest & AddTags(TagsKeyT &&key, TagsValueT &&value)
const Aws::Vector< BrowserConfig > & GetBrowserConfigs() const
CreateCanaryRequest & AddBrowserConfigs(BrowserConfigsT &&value)
CreateCanaryRequest & WithBrowserConfigs(BrowserConfigsT &&value)
CreateCanaryRequest & WithSchedule(ScheduleT &&value)
CreateCanaryRequest & WithVpcConfig(VpcConfigT &&value)
CreateCanaryRequest & AddResourcesToReplicateTags(ResourceToTag value)
const Aws::String & GetArtifactS3Location() const
CreateCanaryRequest & WithProvisionedResourceCleanup(ProvisionedResourceCleanupSetting value)
const Aws::Map< Aws::String, Aws::String > & GetTags() const
CreateCanaryRequest & WithExecutionRoleArn(ExecutionRoleArnT &&value)
CreateCanaryRequest & WithTags(TagsT &&value)
void SetExecutionRoleArn(ExecutionRoleArnT &&value)
CreateCanaryRequest & WithResourcesToReplicateTags(ResourcesToReplicateTagsT &&value)
void SetProvisionedResourceCleanup(ProvisionedResourceCleanupSetting value)
CreateCanaryRequest & WithFailureRetentionPeriodInDays(int value)
AWS_SYNTHETICS_API CreateCanaryRequest()=default
const Aws::Vector< ResourceToTag > & GetResourcesToReplicateTags() const
CreateCanaryRequest & WithCode(CodeT &&value)
CreateCanaryRequest & WithRuntimeVersion(RuntimeVersionT &&value)
void SetBrowserConfigs(BrowserConfigsT &&value)
CreateCanaryRequest & WithArtifactConfig(ArtifactConfigT &&value)
AWS_SYNTHETICS_API Aws::String SerializePayload() const override
const CanaryRunConfigInput & GetRunConfig() const
void SetResourcesToReplicateTags(ResourcesToReplicateTagsT &&value)
virtual const char * GetServiceRequestName() const override
void SetArtifactConfig(ArtifactConfigT &&value)
CreateCanaryRequest & WithArtifactS3Location(ArtifactS3LocationT &&value)
void SetRuntimeVersion(RuntimeVersionT &&value)
CreateCanaryRequest & WithSuccessRetentionPeriodInDays(int value)
CreateCanaryRequest & WithRunConfig(RunConfigT &&value)
ProvisionedResourceCleanupSetting GetProvisionedResourceCleanup() const
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