AWS SDK for C++

AWS SDK for C++ Version 1.11.743

Loading...
Searching...
No Matches
RunTaskRequest.h
1
6#pragma once
7#include <aws/core/utils/UUID.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/core/utils/memory/stl/AWSVector.h>
10#include <aws/ecs/ECSRequest.h>
11#include <aws/ecs/ECS_EXPORTS.h>
12#include <aws/ecs/model/CapacityProviderStrategyItem.h>
13#include <aws/ecs/model/LaunchType.h>
14#include <aws/ecs/model/NetworkConfiguration.h>
15#include <aws/ecs/model/PlacementConstraint.h>
16#include <aws/ecs/model/PlacementStrategy.h>
17#include <aws/ecs/model/PropagateTags.h>
18#include <aws/ecs/model/Tag.h>
19#include <aws/ecs/model/TaskOverride.h>
20#include <aws/ecs/model/TaskVolumeConfiguration.h>
21
22#include <utility>
23
24namespace Aws {
25namespace ECS {
26namespace Model {
27
30class RunTaskRequest : public ECSRequest {
31 public:
32 AWS_ECS_API RunTaskRequest() = default;
33
34 // Service request name is the Operation name which will send this request out,
35 // each operation should has unique request name, so that we can get operation's name from this request.
36 // Note: this is not true for response, multiple operations may have the same response name,
37 // so we can not get operation's name from response.
38 inline virtual const char* GetServiceRequestName() const override { return "RunTask"; }
39
40 AWS_ECS_API Aws::String SerializePayload() const override;
41
43
45
58 inline const Aws::Vector<CapacityProviderStrategyItem>& GetCapacityProviderStrategy() const { return m_capacityProviderStrategy; }
59 inline bool CapacityProviderStrategyHasBeenSet() const { return m_capacityProviderStrategyHasBeenSet; }
60 template <typename CapacityProviderStrategyT = Aws::Vector<CapacityProviderStrategyItem>>
61 void SetCapacityProviderStrategy(CapacityProviderStrategyT&& value) {
62 m_capacityProviderStrategyHasBeenSet = true;
63 m_capacityProviderStrategy = std::forward<CapacityProviderStrategyT>(value);
64 }
65 template <typename CapacityProviderStrategyT = Aws::Vector<CapacityProviderStrategyItem>>
66 RunTaskRequest& WithCapacityProviderStrategy(CapacityProviderStrategyT&& value) {
67 SetCapacityProviderStrategy(std::forward<CapacityProviderStrategyT>(value));
68 return *this;
69 }
70 template <typename CapacityProviderStrategyT = CapacityProviderStrategyItem>
71 RunTaskRequest& AddCapacityProviderStrategy(CapacityProviderStrategyT&& value) {
72 m_capacityProviderStrategyHasBeenSet = true;
73 m_capacityProviderStrategy.emplace_back(std::forward<CapacityProviderStrategyT>(value));
74 return *this;
75 }
77
79
85 inline const Aws::String& GetCluster() const { return m_cluster; }
86 inline bool ClusterHasBeenSet() const { return m_clusterHasBeenSet; }
87 template <typename ClusterT = Aws::String>
88 void SetCluster(ClusterT&& value) {
89 m_clusterHasBeenSet = true;
90 m_cluster = std::forward<ClusterT>(value);
91 }
92 template <typename ClusterT = Aws::String>
93 RunTaskRequest& WithCluster(ClusterT&& value) {
94 SetCluster(std::forward<ClusterT>(value));
95 return *this;
96 }
98
100
104 inline int GetCount() const { return m_count; }
105 inline bool CountHasBeenSet() const { return m_countHasBeenSet; }
106 inline void SetCount(int value) {
107 m_countHasBeenSet = true;
108 m_count = value;
109 }
110 inline RunTaskRequest& WithCount(int value) {
111 SetCount(value);
112 return *this;
113 }
115
117
124 inline bool GetEnableECSManagedTags() const { return m_enableECSManagedTags; }
125 inline bool EnableECSManagedTagsHasBeenSet() const { return m_enableECSManagedTagsHasBeenSet; }
126 inline void SetEnableECSManagedTags(bool value) {
127 m_enableECSManagedTagsHasBeenSet = true;
128 m_enableECSManagedTags = value;
129 }
132 return *this;
133 }
135
137
144 inline bool GetEnableExecuteCommand() const { return m_enableExecuteCommand; }
145 inline bool EnableExecuteCommandHasBeenSet() const { return m_enableExecuteCommandHasBeenSet; }
146 inline void SetEnableExecuteCommand(bool value) {
147 m_enableExecuteCommandHasBeenSet = true;
148 m_enableExecuteCommand = value;
149 }
152 return *this;
153 }
155
157
162 inline const Aws::String& GetGroup() const { return m_group; }
163 inline bool GroupHasBeenSet() const { return m_groupHasBeenSet; }
164 template <typename GroupT = Aws::String>
165 void SetGroup(GroupT&& value) {
166 m_groupHasBeenSet = true;
167 m_group = std::forward<GroupT>(value);
168 }
169 template <typename GroupT = Aws::String>
170 RunTaskRequest& WithGroup(GroupT&& value) {
171 SetGroup(std::forward<GroupT>(value));
172 return *this;
173 }
175
177
199 inline LaunchType GetLaunchType() const { return m_launchType; }
200 inline bool LaunchTypeHasBeenSet() const { return m_launchTypeHasBeenSet; }
201 inline void SetLaunchType(LaunchType value) {
202 m_launchTypeHasBeenSet = true;
203 m_launchType = value;
204 }
206 SetLaunchType(value);
207 return *this;
208 }
210
212
221 inline const NetworkConfiguration& GetNetworkConfiguration() const { return m_networkConfiguration; }
222 inline bool NetworkConfigurationHasBeenSet() const { return m_networkConfigurationHasBeenSet; }
223 template <typename NetworkConfigurationT = NetworkConfiguration>
224 void SetNetworkConfiguration(NetworkConfigurationT&& value) {
225 m_networkConfigurationHasBeenSet = true;
226 m_networkConfiguration = std::forward<NetworkConfigurationT>(value);
227 }
228 template <typename NetworkConfigurationT = NetworkConfiguration>
229 RunTaskRequest& WithNetworkConfiguration(NetworkConfigurationT&& value) {
230 SetNetworkConfiguration(std::forward<NetworkConfigurationT>(value));
231 return *this;
232 }
234
236
247 inline const TaskOverride& GetOverrides() const { return m_overrides; }
248 inline bool OverridesHasBeenSet() const { return m_overridesHasBeenSet; }
249 template <typename OverridesT = TaskOverride>
250 void SetOverrides(OverridesT&& value) {
251 m_overridesHasBeenSet = true;
252 m_overrides = std::forward<OverridesT>(value);
253 }
254 template <typename OverridesT = TaskOverride>
255 RunTaskRequest& WithOverrides(OverridesT&& value) {
256 SetOverrides(std::forward<OverridesT>(value));
257 return *this;
258 }
260
262
267 inline const Aws::Vector<PlacementConstraint>& GetPlacementConstraints() const { return m_placementConstraints; }
268 inline bool PlacementConstraintsHasBeenSet() const { return m_placementConstraintsHasBeenSet; }
269 template <typename PlacementConstraintsT = Aws::Vector<PlacementConstraint>>
270 void SetPlacementConstraints(PlacementConstraintsT&& value) {
271 m_placementConstraintsHasBeenSet = true;
272 m_placementConstraints = std::forward<PlacementConstraintsT>(value);
273 }
274 template <typename PlacementConstraintsT = Aws::Vector<PlacementConstraint>>
275 RunTaskRequest& WithPlacementConstraints(PlacementConstraintsT&& value) {
276 SetPlacementConstraints(std::forward<PlacementConstraintsT>(value));
277 return *this;
278 }
279 template <typename PlacementConstraintsT = PlacementConstraint>
280 RunTaskRequest& AddPlacementConstraints(PlacementConstraintsT&& value) {
281 m_placementConstraintsHasBeenSet = true;
282 m_placementConstraints.emplace_back(std::forward<PlacementConstraintsT>(value));
283 return *this;
284 }
286
288
292 inline const Aws::Vector<PlacementStrategy>& GetPlacementStrategy() const { return m_placementStrategy; }
293 inline bool PlacementStrategyHasBeenSet() const { return m_placementStrategyHasBeenSet; }
294 template <typename PlacementStrategyT = Aws::Vector<PlacementStrategy>>
295 void SetPlacementStrategy(PlacementStrategyT&& value) {
296 m_placementStrategyHasBeenSet = true;
297 m_placementStrategy = std::forward<PlacementStrategyT>(value);
298 }
299 template <typename PlacementStrategyT = Aws::Vector<PlacementStrategy>>
300 RunTaskRequest& WithPlacementStrategy(PlacementStrategyT&& value) {
301 SetPlacementStrategy(std::forward<PlacementStrategyT>(value));
302 return *this;
303 }
304 template <typename PlacementStrategyT = PlacementStrategy>
305 RunTaskRequest& AddPlacementStrategy(PlacementStrategyT&& value) {
306 m_placementStrategyHasBeenSet = true;
307 m_placementStrategy.emplace_back(std::forward<PlacementStrategyT>(value));
308 return *this;
309 }
311
313
321 inline const Aws::String& GetPlatformVersion() const { return m_platformVersion; }
322 inline bool PlatformVersionHasBeenSet() const { return m_platformVersionHasBeenSet; }
323 template <typename PlatformVersionT = Aws::String>
324 void SetPlatformVersion(PlatformVersionT&& value) {
325 m_platformVersionHasBeenSet = true;
326 m_platformVersion = std::forward<PlatformVersionT>(value);
327 }
328 template <typename PlatformVersionT = Aws::String>
329 RunTaskRequest& WithPlatformVersion(PlatformVersionT&& value) {
330 SetPlatformVersion(std::forward<PlatformVersionT>(value));
331 return *this;
332 }
334
336
345 inline PropagateTags GetPropagateTags() const { return m_propagateTags; }
346 inline bool PropagateTagsHasBeenSet() const { return m_propagateTagsHasBeenSet; }
347 inline void SetPropagateTags(PropagateTags value) {
348 m_propagateTagsHasBeenSet = true;
349 m_propagateTags = value;
350 }
352 SetPropagateTags(value);
353 return *this;
354 }
356
358
362 inline const Aws::String& GetReferenceId() const { return m_referenceId; }
363 inline bool ReferenceIdHasBeenSet() const { return m_referenceIdHasBeenSet; }
364 template <typename ReferenceIdT = Aws::String>
365 void SetReferenceId(ReferenceIdT&& value) {
366 m_referenceIdHasBeenSet = true;
367 m_referenceId = std::forward<ReferenceIdT>(value);
368 }
369 template <typename ReferenceIdT = Aws::String>
370 RunTaskRequest& WithReferenceId(ReferenceIdT&& value) {
371 SetReferenceId(std::forward<ReferenceIdT>(value));
372 return *this;
373 }
375
377
390 inline const Aws::String& GetStartedBy() const { return m_startedBy; }
391 inline bool StartedByHasBeenSet() const { return m_startedByHasBeenSet; }
392 template <typename StartedByT = Aws::String>
393 void SetStartedBy(StartedByT&& value) {
394 m_startedByHasBeenSet = true;
395 m_startedBy = std::forward<StartedByT>(value);
396 }
397 template <typename StartedByT = Aws::String>
398 RunTaskRequest& WithStartedBy(StartedByT&& value) {
399 SetStartedBy(std::forward<StartedByT>(value));
400 return *this;
401 }
403
405
423 inline const Aws::Vector<Tag>& GetTags() const { return m_tags; }
424 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
425 template <typename TagsT = Aws::Vector<Tag>>
426 void SetTags(TagsT&& value) {
427 m_tagsHasBeenSet = true;
428 m_tags = std::forward<TagsT>(value);
429 }
430 template <typename TagsT = Aws::Vector<Tag>>
431 RunTaskRequest& WithTags(TagsT&& value) {
432 SetTags(std::forward<TagsT>(value));
433 return *this;
434 }
435 template <typename TagsT = Tag>
436 RunTaskRequest& AddTags(TagsT&& value) {
437 m_tagsHasBeenSet = true;
438 m_tags.emplace_back(std::forward<TagsT>(value));
439 return *this;
440 }
442
444
462 inline const Aws::String& GetTaskDefinition() const { return m_taskDefinition; }
463 inline bool TaskDefinitionHasBeenSet() const { return m_taskDefinitionHasBeenSet; }
464 template <typename TaskDefinitionT = Aws::String>
465 void SetTaskDefinition(TaskDefinitionT&& value) {
466 m_taskDefinitionHasBeenSet = true;
467 m_taskDefinition = std::forward<TaskDefinitionT>(value);
468 }
469 template <typename TaskDefinitionT = Aws::String>
470 RunTaskRequest& WithTaskDefinition(TaskDefinitionT&& value) {
471 SetTaskDefinition(std::forward<TaskDefinitionT>(value));
472 return *this;
473 }
475
477
485 inline const Aws::String& GetClientToken() const { return m_clientToken; }
486 inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; }
487 template <typename ClientTokenT = Aws::String>
488 void SetClientToken(ClientTokenT&& value) {
489 m_clientTokenHasBeenSet = true;
490 m_clientToken = std::forward<ClientTokenT>(value);
491 }
492 template <typename ClientTokenT = Aws::String>
493 RunTaskRequest& WithClientToken(ClientTokenT&& value) {
494 SetClientToken(std::forward<ClientTokenT>(value));
495 return *this;
496 }
498
500
507 inline const Aws::Vector<TaskVolumeConfiguration>& GetVolumeConfigurations() const { return m_volumeConfigurations; }
508 inline bool VolumeConfigurationsHasBeenSet() const { return m_volumeConfigurationsHasBeenSet; }
509 template <typename VolumeConfigurationsT = Aws::Vector<TaskVolumeConfiguration>>
510 void SetVolumeConfigurations(VolumeConfigurationsT&& value) {
511 m_volumeConfigurationsHasBeenSet = true;
512 m_volumeConfigurations = std::forward<VolumeConfigurationsT>(value);
513 }
514 template <typename VolumeConfigurationsT = Aws::Vector<TaskVolumeConfiguration>>
515 RunTaskRequest& WithVolumeConfigurations(VolumeConfigurationsT&& value) {
516 SetVolumeConfigurations(std::forward<VolumeConfigurationsT>(value));
517 return *this;
518 }
519 template <typename VolumeConfigurationsT = TaskVolumeConfiguration>
520 RunTaskRequest& AddVolumeConfigurations(VolumeConfigurationsT&& value) {
521 m_volumeConfigurationsHasBeenSet = true;
522 m_volumeConfigurations.emplace_back(std::forward<VolumeConfigurationsT>(value));
523 return *this;
524 }
526 private:
527 Aws::Vector<CapacityProviderStrategyItem> m_capacityProviderStrategy;
528
529 Aws::String m_cluster;
530
531 int m_count{0};
532
533 bool m_enableECSManagedTags{false};
534
535 bool m_enableExecuteCommand{false};
536
537 Aws::String m_group;
538
539 LaunchType m_launchType{LaunchType::NOT_SET};
540
541 NetworkConfiguration m_networkConfiguration;
542
543 TaskOverride m_overrides;
544
545 Aws::Vector<PlacementConstraint> m_placementConstraints;
546
547 Aws::Vector<PlacementStrategy> m_placementStrategy;
548
549 Aws::String m_platformVersion;
550
551 PropagateTags m_propagateTags{PropagateTags::NOT_SET};
552
553 Aws::String m_referenceId;
554
555 Aws::String m_startedBy;
556
557 Aws::Vector<Tag> m_tags;
558
559 Aws::String m_taskDefinition;
560
562
563 Aws::Vector<TaskVolumeConfiguration> m_volumeConfigurations;
564 bool m_capacityProviderStrategyHasBeenSet = false;
565 bool m_clusterHasBeenSet = false;
566 bool m_countHasBeenSet = false;
567 bool m_enableECSManagedTagsHasBeenSet = false;
568 bool m_enableExecuteCommandHasBeenSet = false;
569 bool m_groupHasBeenSet = false;
570 bool m_launchTypeHasBeenSet = false;
571 bool m_networkConfigurationHasBeenSet = false;
572 bool m_overridesHasBeenSet = false;
573 bool m_placementConstraintsHasBeenSet = false;
574 bool m_placementStrategyHasBeenSet = false;
575 bool m_platformVersionHasBeenSet = false;
576 bool m_propagateTagsHasBeenSet = false;
577 bool m_referenceIdHasBeenSet = false;
578 bool m_startedByHasBeenSet = false;
579 bool m_tagsHasBeenSet = false;
580 bool m_taskDefinitionHasBeenSet = false;
581 bool m_clientTokenHasBeenSet = true;
582 bool m_volumeConfigurationsHasBeenSet = false;
583};
584
585} // namespace Model
586} // namespace ECS
587} // namespace Aws
void SetReferenceId(ReferenceIdT &&value)
RunTaskRequest & WithNetworkConfiguration(NetworkConfigurationT &&value)
void SetPlacementStrategy(PlacementStrategyT &&value)
void SetPlatformVersion(PlatformVersionT &&value)
void SetPlacementConstraints(PlacementConstraintsT &&value)
RunTaskRequest & WithCluster(ClusterT &&value)
RunTaskRequest & WithTags(TagsT &&value)
RunTaskRequest & WithClientToken(ClientTokenT &&value)
RunTaskRequest & WithPropagateTags(PropagateTags value)
virtual const char * GetServiceRequestName() const override
const Aws::Vector< Tag > & GetTags() const
const NetworkConfiguration & GetNetworkConfiguration() const
void SetLaunchType(LaunchType value)
void SetCluster(ClusterT &&value)
RunTaskRequest & WithLaunchType(LaunchType value)
RunTaskRequest & WithPlatformVersion(PlatformVersionT &&value)
const TaskOverride & GetOverrides() const
const Aws::String & GetTaskDefinition() const
void SetPropagateTags(PropagateTags value)
void SetOverrides(OverridesT &&value)
const Aws::Vector< CapacityProviderStrategyItem > & GetCapacityProviderStrategy() const
void SetEnableExecuteCommand(bool value)
AWS_ECS_API Aws::String SerializePayload() const override
const Aws::String & GetCluster() const
const Aws::Vector< PlacementStrategy > & GetPlacementStrategy() const
void SetEnableECSManagedTags(bool value)
const Aws::String & GetStartedBy() const
AWS_ECS_API RunTaskRequest()=default
const Aws::String & GetPlatformVersion() const
RunTaskRequest & WithCount(int value)
void SetVolumeConfigurations(VolumeConfigurationsT &&value)
const Aws::Vector< PlacementConstraint > & GetPlacementConstraints() const
RunTaskRequest & WithCapacityProviderStrategy(CapacityProviderStrategyT &&value)
RunTaskRequest & AddCapacityProviderStrategy(CapacityProviderStrategyT &&value)
void SetCapacityProviderStrategy(CapacityProviderStrategyT &&value)
void SetTaskDefinition(TaskDefinitionT &&value)
RunTaskRequest & WithStartedBy(StartedByT &&value)
bool CapacityProviderStrategyHasBeenSet() const
const Aws::String & GetGroup() const
PropagateTags GetPropagateTags() const
void SetStartedBy(StartedByT &&value)
RunTaskRequest & WithEnableExecuteCommand(bool value)
RunTaskRequest & WithOverrides(OverridesT &&value)
RunTaskRequest & WithPlacementConstraints(PlacementConstraintsT &&value)
RunTaskRequest & AddPlacementConstraints(PlacementConstraintsT &&value)
RunTaskRequest & WithVolumeConfigurations(VolumeConfigurationsT &&value)
const Aws::Vector< TaskVolumeConfiguration > & GetVolumeConfigurations() const
const Aws::String & GetReferenceId() const
RunTaskRequest & WithGroup(GroupT &&value)
RunTaskRequest & WithPlacementStrategy(PlacementStrategyT &&value)
RunTaskRequest & WithTaskDefinition(TaskDefinitionT &&value)
RunTaskRequest & WithEnableECSManagedTags(bool value)
RunTaskRequest & AddVolumeConfigurations(VolumeConfigurationsT &&value)
void SetNetworkConfiguration(NetworkConfigurationT &&value)
AWS_ECS_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
const Aws::String & GetClientToken() const
RunTaskRequest & AddTags(TagsT &&value)
void SetClientToken(ClientTokenT &&value)
RunTaskRequest & AddPlacementStrategy(PlacementStrategyT &&value)
RunTaskRequest & WithReferenceId(ReferenceIdT &&value)
static Aws::Utils::UUID PseudoRandomUUID()
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector