AWS SDK for C++

AWS SDK for C++ Version 1.11.787

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
33class RunTaskRequest : public ECSRequest {
34 public:
35 AWS_ECS_API RunTaskRequest() = default;
36
37 // Service request name is the Operation name which will send this request out,
38 // each operation should has unique request name, so that we can get operation's name from this request.
39 // Note: this is not true for response, multiple operations may have the same response name,
40 // so we can not get operation's name from response.
41 inline virtual const char* GetServiceRequestName() const override { return "RunTask"; }
42
43 AWS_ECS_API Aws::String SerializePayload() const override;
44
46
48
61 inline const Aws::Vector<CapacityProviderStrategyItem>& GetCapacityProviderStrategy() const { return m_capacityProviderStrategy; }
62 inline bool CapacityProviderStrategyHasBeenSet() const { return m_capacityProviderStrategyHasBeenSet; }
63 template <typename CapacityProviderStrategyT = Aws::Vector<CapacityProviderStrategyItem>>
64 void SetCapacityProviderStrategy(CapacityProviderStrategyT&& value) {
65 m_capacityProviderStrategyHasBeenSet = true;
66 m_capacityProviderStrategy = std::forward<CapacityProviderStrategyT>(value);
67 }
68 template <typename CapacityProviderStrategyT = Aws::Vector<CapacityProviderStrategyItem>>
69 RunTaskRequest& WithCapacityProviderStrategy(CapacityProviderStrategyT&& value) {
70 SetCapacityProviderStrategy(std::forward<CapacityProviderStrategyT>(value));
71 return *this;
72 }
73 template <typename CapacityProviderStrategyT = CapacityProviderStrategyItem>
74 RunTaskRequest& AddCapacityProviderStrategy(CapacityProviderStrategyT&& value) {
75 m_capacityProviderStrategyHasBeenSet = true;
76 m_capacityProviderStrategy.emplace_back(std::forward<CapacityProviderStrategyT>(value));
77 return *this;
78 }
80
82
88 inline const Aws::String& GetCluster() const { return m_cluster; }
89 inline bool ClusterHasBeenSet() const { return m_clusterHasBeenSet; }
90 template <typename ClusterT = Aws::String>
91 void SetCluster(ClusterT&& value) {
92 m_clusterHasBeenSet = true;
93 m_cluster = std::forward<ClusterT>(value);
94 }
95 template <typename ClusterT = Aws::String>
96 RunTaskRequest& WithCluster(ClusterT&& value) {
97 SetCluster(std::forward<ClusterT>(value));
98 return *this;
99 }
101
103
107 inline int GetCount() const { return m_count; }
108 inline bool CountHasBeenSet() const { return m_countHasBeenSet; }
109 inline void SetCount(int value) {
110 m_countHasBeenSet = true;
111 m_count = value;
112 }
113 inline RunTaskRequest& WithCount(int value) {
114 SetCount(value);
115 return *this;
116 }
118
120
127 inline bool GetEnableECSManagedTags() const { return m_enableECSManagedTags; }
128 inline bool EnableECSManagedTagsHasBeenSet() const { return m_enableECSManagedTagsHasBeenSet; }
129 inline void SetEnableECSManagedTags(bool value) {
130 m_enableECSManagedTagsHasBeenSet = true;
131 m_enableECSManagedTags = value;
132 }
135 return *this;
136 }
138
140
147 inline bool GetEnableExecuteCommand() const { return m_enableExecuteCommand; }
148 inline bool EnableExecuteCommandHasBeenSet() const { return m_enableExecuteCommandHasBeenSet; }
149 inline void SetEnableExecuteCommand(bool value) {
150 m_enableExecuteCommandHasBeenSet = true;
151 m_enableExecuteCommand = value;
152 }
155 return *this;
156 }
158
160
165 inline const Aws::String& GetGroup() const { return m_group; }
166 inline bool GroupHasBeenSet() const { return m_groupHasBeenSet; }
167 template <typename GroupT = Aws::String>
168 void SetGroup(GroupT&& value) {
169 m_groupHasBeenSet = true;
170 m_group = std::forward<GroupT>(value);
171 }
172 template <typename GroupT = Aws::String>
173 RunTaskRequest& WithGroup(GroupT&& value) {
174 SetGroup(std::forward<GroupT>(value));
175 return *this;
176 }
178
180
202 inline LaunchType GetLaunchType() const { return m_launchType; }
203 inline bool LaunchTypeHasBeenSet() const { return m_launchTypeHasBeenSet; }
204 inline void SetLaunchType(LaunchType value) {
205 m_launchTypeHasBeenSet = true;
206 m_launchType = value;
207 }
209 SetLaunchType(value);
210 return *this;
211 }
213
215
224 inline const NetworkConfiguration& GetNetworkConfiguration() const { return m_networkConfiguration; }
225 inline bool NetworkConfigurationHasBeenSet() const { return m_networkConfigurationHasBeenSet; }
226 template <typename NetworkConfigurationT = NetworkConfiguration>
227 void SetNetworkConfiguration(NetworkConfigurationT&& value) {
228 m_networkConfigurationHasBeenSet = true;
229 m_networkConfiguration = std::forward<NetworkConfigurationT>(value);
230 }
231 template <typename NetworkConfigurationT = NetworkConfiguration>
232 RunTaskRequest& WithNetworkConfiguration(NetworkConfigurationT&& value) {
233 SetNetworkConfiguration(std::forward<NetworkConfigurationT>(value));
234 return *this;
235 }
237
239
250 inline const TaskOverride& GetOverrides() const { return m_overrides; }
251 inline bool OverridesHasBeenSet() const { return m_overridesHasBeenSet; }
252 template <typename OverridesT = TaskOverride>
253 void SetOverrides(OverridesT&& value) {
254 m_overridesHasBeenSet = true;
255 m_overrides = std::forward<OverridesT>(value);
256 }
257 template <typename OverridesT = TaskOverride>
258 RunTaskRequest& WithOverrides(OverridesT&& value) {
259 SetOverrides(std::forward<OverridesT>(value));
260 return *this;
261 }
263
265
270 inline const Aws::Vector<PlacementConstraint>& GetPlacementConstraints() const { return m_placementConstraints; }
271 inline bool PlacementConstraintsHasBeenSet() const { return m_placementConstraintsHasBeenSet; }
272 template <typename PlacementConstraintsT = Aws::Vector<PlacementConstraint>>
273 void SetPlacementConstraints(PlacementConstraintsT&& value) {
274 m_placementConstraintsHasBeenSet = true;
275 m_placementConstraints = std::forward<PlacementConstraintsT>(value);
276 }
277 template <typename PlacementConstraintsT = Aws::Vector<PlacementConstraint>>
278 RunTaskRequest& WithPlacementConstraints(PlacementConstraintsT&& value) {
279 SetPlacementConstraints(std::forward<PlacementConstraintsT>(value));
280 return *this;
281 }
282 template <typename PlacementConstraintsT = PlacementConstraint>
283 RunTaskRequest& AddPlacementConstraints(PlacementConstraintsT&& value) {
284 m_placementConstraintsHasBeenSet = true;
285 m_placementConstraints.emplace_back(std::forward<PlacementConstraintsT>(value));
286 return *this;
287 }
289
291
295 inline const Aws::Vector<PlacementStrategy>& GetPlacementStrategy() const { return m_placementStrategy; }
296 inline bool PlacementStrategyHasBeenSet() const { return m_placementStrategyHasBeenSet; }
297 template <typename PlacementStrategyT = Aws::Vector<PlacementStrategy>>
298 void SetPlacementStrategy(PlacementStrategyT&& value) {
299 m_placementStrategyHasBeenSet = true;
300 m_placementStrategy = std::forward<PlacementStrategyT>(value);
301 }
302 template <typename PlacementStrategyT = Aws::Vector<PlacementStrategy>>
303 RunTaskRequest& WithPlacementStrategy(PlacementStrategyT&& value) {
304 SetPlacementStrategy(std::forward<PlacementStrategyT>(value));
305 return *this;
306 }
307 template <typename PlacementStrategyT = PlacementStrategy>
308 RunTaskRequest& AddPlacementStrategy(PlacementStrategyT&& value) {
309 m_placementStrategyHasBeenSet = true;
310 m_placementStrategy.emplace_back(std::forward<PlacementStrategyT>(value));
311 return *this;
312 }
314
316
324 inline const Aws::String& GetPlatformVersion() const { return m_platformVersion; }
325 inline bool PlatformVersionHasBeenSet() const { return m_platformVersionHasBeenSet; }
326 template <typename PlatformVersionT = Aws::String>
327 void SetPlatformVersion(PlatformVersionT&& value) {
328 m_platformVersionHasBeenSet = true;
329 m_platformVersion = std::forward<PlatformVersionT>(value);
330 }
331 template <typename PlatformVersionT = Aws::String>
332 RunTaskRequest& WithPlatformVersion(PlatformVersionT&& value) {
333 SetPlatformVersion(std::forward<PlatformVersionT>(value));
334 return *this;
335 }
337
339
348 inline PropagateTags GetPropagateTags() const { return m_propagateTags; }
349 inline bool PropagateTagsHasBeenSet() const { return m_propagateTagsHasBeenSet; }
350 inline void SetPropagateTags(PropagateTags value) {
351 m_propagateTagsHasBeenSet = true;
352 m_propagateTags = value;
353 }
355 SetPropagateTags(value);
356 return *this;
357 }
359
361
365 inline const Aws::String& GetReferenceId() const { return m_referenceId; }
366 inline bool ReferenceIdHasBeenSet() const { return m_referenceIdHasBeenSet; }
367 template <typename ReferenceIdT = Aws::String>
368 void SetReferenceId(ReferenceIdT&& value) {
369 m_referenceIdHasBeenSet = true;
370 m_referenceId = std::forward<ReferenceIdT>(value);
371 }
372 template <typename ReferenceIdT = Aws::String>
373 RunTaskRequest& WithReferenceId(ReferenceIdT&& value) {
374 SetReferenceId(std::forward<ReferenceIdT>(value));
375 return *this;
376 }
378
380
393 inline const Aws::String& GetStartedBy() const { return m_startedBy; }
394 inline bool StartedByHasBeenSet() const { return m_startedByHasBeenSet; }
395 template <typename StartedByT = Aws::String>
396 void SetStartedBy(StartedByT&& value) {
397 m_startedByHasBeenSet = true;
398 m_startedBy = std::forward<StartedByT>(value);
399 }
400 template <typename StartedByT = Aws::String>
401 RunTaskRequest& WithStartedBy(StartedByT&& value) {
402 SetStartedBy(std::forward<StartedByT>(value));
403 return *this;
404 }
406
408
426 inline const Aws::Vector<Tag>& GetTags() const { return m_tags; }
427 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
428 template <typename TagsT = Aws::Vector<Tag>>
429 void SetTags(TagsT&& value) {
430 m_tagsHasBeenSet = true;
431 m_tags = std::forward<TagsT>(value);
432 }
433 template <typename TagsT = Aws::Vector<Tag>>
434 RunTaskRequest& WithTags(TagsT&& value) {
435 SetTags(std::forward<TagsT>(value));
436 return *this;
437 }
438 template <typename TagsT = Tag>
439 RunTaskRequest& AddTags(TagsT&& value) {
440 m_tagsHasBeenSet = true;
441 m_tags.emplace_back(std::forward<TagsT>(value));
442 return *this;
443 }
445
447
465 inline const Aws::String& GetTaskDefinition() const { return m_taskDefinition; }
466 inline bool TaskDefinitionHasBeenSet() const { return m_taskDefinitionHasBeenSet; }
467 template <typename TaskDefinitionT = Aws::String>
468 void SetTaskDefinition(TaskDefinitionT&& value) {
469 m_taskDefinitionHasBeenSet = true;
470 m_taskDefinition = std::forward<TaskDefinitionT>(value);
471 }
472 template <typename TaskDefinitionT = Aws::String>
473 RunTaskRequest& WithTaskDefinition(TaskDefinitionT&& value) {
474 SetTaskDefinition(std::forward<TaskDefinitionT>(value));
475 return *this;
476 }
478
480
488 inline const Aws::String& GetClientToken() const { return m_clientToken; }
489 inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; }
490 template <typename ClientTokenT = Aws::String>
491 void SetClientToken(ClientTokenT&& value) {
492 m_clientTokenHasBeenSet = true;
493 m_clientToken = std::forward<ClientTokenT>(value);
494 }
495 template <typename ClientTokenT = Aws::String>
496 RunTaskRequest& WithClientToken(ClientTokenT&& value) {
497 SetClientToken(std::forward<ClientTokenT>(value));
498 return *this;
499 }
501
503
510 inline const Aws::Vector<TaskVolumeConfiguration>& GetVolumeConfigurations() const { return m_volumeConfigurations; }
511 inline bool VolumeConfigurationsHasBeenSet() const { return m_volumeConfigurationsHasBeenSet; }
512 template <typename VolumeConfigurationsT = Aws::Vector<TaskVolumeConfiguration>>
513 void SetVolumeConfigurations(VolumeConfigurationsT&& value) {
514 m_volumeConfigurationsHasBeenSet = true;
515 m_volumeConfigurations = std::forward<VolumeConfigurationsT>(value);
516 }
517 template <typename VolumeConfigurationsT = Aws::Vector<TaskVolumeConfiguration>>
518 RunTaskRequest& WithVolumeConfigurations(VolumeConfigurationsT&& value) {
519 SetVolumeConfigurations(std::forward<VolumeConfigurationsT>(value));
520 return *this;
521 }
522 template <typename VolumeConfigurationsT = TaskVolumeConfiguration>
523 RunTaskRequest& AddVolumeConfigurations(VolumeConfigurationsT&& value) {
524 m_volumeConfigurationsHasBeenSet = true;
525 m_volumeConfigurations.emplace_back(std::forward<VolumeConfigurationsT>(value));
526 return *this;
527 }
529 private:
530 Aws::Vector<CapacityProviderStrategyItem> m_capacityProviderStrategy;
531
532 Aws::String m_cluster;
533
534 int m_count{0};
535
536 bool m_enableECSManagedTags{false};
537
538 bool m_enableExecuteCommand{false};
539
540 Aws::String m_group;
541
542 LaunchType m_launchType{LaunchType::NOT_SET};
543
544 NetworkConfiguration m_networkConfiguration;
545
546 TaskOverride m_overrides;
547
548 Aws::Vector<PlacementConstraint> m_placementConstraints;
549
550 Aws::Vector<PlacementStrategy> m_placementStrategy;
551
552 Aws::String m_platformVersion;
553
554 PropagateTags m_propagateTags{PropagateTags::NOT_SET};
555
556 Aws::String m_referenceId;
557
558 Aws::String m_startedBy;
559
560 Aws::Vector<Tag> m_tags;
561
562 Aws::String m_taskDefinition;
563
565
566 Aws::Vector<TaskVolumeConfiguration> m_volumeConfigurations;
567 bool m_capacityProviderStrategyHasBeenSet = false;
568 bool m_clusterHasBeenSet = false;
569 bool m_countHasBeenSet = false;
570 bool m_enableECSManagedTagsHasBeenSet = false;
571 bool m_enableExecuteCommandHasBeenSet = false;
572 bool m_groupHasBeenSet = false;
573 bool m_launchTypeHasBeenSet = false;
574 bool m_networkConfigurationHasBeenSet = false;
575 bool m_overridesHasBeenSet = false;
576 bool m_placementConstraintsHasBeenSet = false;
577 bool m_placementStrategyHasBeenSet = false;
578 bool m_platformVersionHasBeenSet = false;
579 bool m_propagateTagsHasBeenSet = false;
580 bool m_referenceIdHasBeenSet = false;
581 bool m_startedByHasBeenSet = false;
582 bool m_tagsHasBeenSet = false;
583 bool m_taskDefinitionHasBeenSet = false;
584 bool m_clientTokenHasBeenSet = true;
585 bool m_volumeConfigurationsHasBeenSet = false;
586};
587
588} // namespace Model
589} // namespace ECS
590} // 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