AWS SDK for C++

AWS SDK for C++ Version 1.11.606

Loading...
Searching...
No Matches
RunTaskRequest.h
1
6#pragma once
7#include <aws/ecs/ECS_EXPORTS.h>
8#include <aws/ecs/ECSRequest.h>
9#include <aws/core/utils/memory/stl/AWSVector.h>
10#include <aws/core/utils/memory/stl/AWSString.h>
11#include <aws/ecs/model/LaunchType.h>
12#include <aws/ecs/model/NetworkConfiguration.h>
13#include <aws/ecs/model/TaskOverride.h>
14#include <aws/ecs/model/PropagateTags.h>
15#include <aws/ecs/model/CapacityProviderStrategyItem.h>
16#include <aws/ecs/model/PlacementConstraint.h>
17#include <aws/ecs/model/PlacementStrategy.h>
18#include <aws/ecs/model/Tag.h>
19#include <aws/ecs/model/TaskVolumeConfiguration.h>
20#include <utility>
21#include <aws/core/utils/UUID.h>
22
23namespace Aws
24{
25namespace ECS
26{
27namespace Model
28{
29
33 {
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
47
49
59 inline const Aws::Vector<CapacityProviderStrategyItem>& GetCapacityProviderStrategy() const { return m_capacityProviderStrategy; }
60 inline bool CapacityProviderStrategyHasBeenSet() const { return m_capacityProviderStrategyHasBeenSet; }
61 template<typename CapacityProviderStrategyT = Aws::Vector<CapacityProviderStrategyItem>>
62 void SetCapacityProviderStrategy(CapacityProviderStrategyT&& value) { m_capacityProviderStrategyHasBeenSet = true; m_capacityProviderStrategy = std::forward<CapacityProviderStrategyT>(value); }
63 template<typename CapacityProviderStrategyT = Aws::Vector<CapacityProviderStrategyItem>>
64 RunTaskRequest& WithCapacityProviderStrategy(CapacityProviderStrategyT&& value) { SetCapacityProviderStrategy(std::forward<CapacityProviderStrategyT>(value)); return *this;}
65 template<typename CapacityProviderStrategyT = CapacityProviderStrategyItem>
66 RunTaskRequest& AddCapacityProviderStrategy(CapacityProviderStrategyT&& value) { m_capacityProviderStrategyHasBeenSet = true; m_capacityProviderStrategy.emplace_back(std::forward<CapacityProviderStrategyT>(value)); return *this; }
68
70
76 inline const Aws::String& GetCluster() const { return m_cluster; }
77 inline bool ClusterHasBeenSet() const { return m_clusterHasBeenSet; }
78 template<typename ClusterT = Aws::String>
79 void SetCluster(ClusterT&& value) { m_clusterHasBeenSet = true; m_cluster = std::forward<ClusterT>(value); }
80 template<typename ClusterT = Aws::String>
81 RunTaskRequest& WithCluster(ClusterT&& value) { SetCluster(std::forward<ClusterT>(value)); return *this;}
83
85
89 inline int GetCount() const { return m_count; }
90 inline bool CountHasBeenSet() const { return m_countHasBeenSet; }
91 inline void SetCount(int value) { m_countHasBeenSet = true; m_count = value; }
92 inline RunTaskRequest& WithCount(int value) { SetCount(value); return *this;}
94
96
103 inline bool GetEnableECSManagedTags() const { return m_enableECSManagedTags; }
104 inline bool EnableECSManagedTagsHasBeenSet() const { return m_enableECSManagedTagsHasBeenSet; }
105 inline void SetEnableECSManagedTags(bool value) { m_enableECSManagedTagsHasBeenSet = true; m_enableECSManagedTags = value; }
106 inline RunTaskRequest& WithEnableECSManagedTags(bool value) { SetEnableECSManagedTags(value); return *this;}
108
110
117 inline bool GetEnableExecuteCommand() const { return m_enableExecuteCommand; }
118 inline bool EnableExecuteCommandHasBeenSet() const { return m_enableExecuteCommandHasBeenSet; }
119 inline void SetEnableExecuteCommand(bool value) { m_enableExecuteCommandHasBeenSet = true; m_enableExecuteCommand = value; }
120 inline RunTaskRequest& WithEnableExecuteCommand(bool value) { SetEnableExecuteCommand(value); return *this;}
122
124
129 inline const Aws::String& GetGroup() const { return m_group; }
130 inline bool GroupHasBeenSet() const { return m_groupHasBeenSet; }
131 template<typename GroupT = Aws::String>
132 void SetGroup(GroupT&& value) { m_groupHasBeenSet = true; m_group = std::forward<GroupT>(value); }
133 template<typename GroupT = Aws::String>
134 RunTaskRequest& WithGroup(GroupT&& value) { SetGroup(std::forward<GroupT>(value)); return *this;}
136
138
158 inline LaunchType GetLaunchType() const { return m_launchType; }
159 inline bool LaunchTypeHasBeenSet() const { return m_launchTypeHasBeenSet; }
160 inline void SetLaunchType(LaunchType value) { m_launchTypeHasBeenSet = true; m_launchType = value; }
161 inline RunTaskRequest& WithLaunchType(LaunchType value) { SetLaunchType(value); return *this;}
163
165
174 inline const NetworkConfiguration& GetNetworkConfiguration() const { return m_networkConfiguration; }
175 inline bool NetworkConfigurationHasBeenSet() const { return m_networkConfigurationHasBeenSet; }
176 template<typename NetworkConfigurationT = NetworkConfiguration>
177 void SetNetworkConfiguration(NetworkConfigurationT&& value) { m_networkConfigurationHasBeenSet = true; m_networkConfiguration = std::forward<NetworkConfigurationT>(value); }
178 template<typename NetworkConfigurationT = NetworkConfiguration>
179 RunTaskRequest& WithNetworkConfiguration(NetworkConfigurationT&& value) { SetNetworkConfiguration(std::forward<NetworkConfigurationT>(value)); return *this;}
181
183
194 inline const TaskOverride& GetOverrides() const { return m_overrides; }
195 inline bool OverridesHasBeenSet() const { return m_overridesHasBeenSet; }
196 template<typename OverridesT = TaskOverride>
197 void SetOverrides(OverridesT&& value) { m_overridesHasBeenSet = true; m_overrides = std::forward<OverridesT>(value); }
198 template<typename OverridesT = TaskOverride>
199 RunTaskRequest& WithOverrides(OverridesT&& value) { SetOverrides(std::forward<OverridesT>(value)); return *this;}
201
203
208 inline const Aws::Vector<PlacementConstraint>& GetPlacementConstraints() const { return m_placementConstraints; }
209 inline bool PlacementConstraintsHasBeenSet() const { return m_placementConstraintsHasBeenSet; }
210 template<typename PlacementConstraintsT = Aws::Vector<PlacementConstraint>>
211 void SetPlacementConstraints(PlacementConstraintsT&& value) { m_placementConstraintsHasBeenSet = true; m_placementConstraints = std::forward<PlacementConstraintsT>(value); }
212 template<typename PlacementConstraintsT = Aws::Vector<PlacementConstraint>>
213 RunTaskRequest& WithPlacementConstraints(PlacementConstraintsT&& value) { SetPlacementConstraints(std::forward<PlacementConstraintsT>(value)); return *this;}
214 template<typename PlacementConstraintsT = PlacementConstraint>
215 RunTaskRequest& AddPlacementConstraints(PlacementConstraintsT&& value) { m_placementConstraintsHasBeenSet = true; m_placementConstraints.emplace_back(std::forward<PlacementConstraintsT>(value)); return *this; }
217
219
223 inline const Aws::Vector<PlacementStrategy>& GetPlacementStrategy() const { return m_placementStrategy; }
224 inline bool PlacementStrategyHasBeenSet() const { return m_placementStrategyHasBeenSet; }
225 template<typename PlacementStrategyT = Aws::Vector<PlacementStrategy>>
226 void SetPlacementStrategy(PlacementStrategyT&& value) { m_placementStrategyHasBeenSet = true; m_placementStrategy = std::forward<PlacementStrategyT>(value); }
227 template<typename PlacementStrategyT = Aws::Vector<PlacementStrategy>>
228 RunTaskRequest& WithPlacementStrategy(PlacementStrategyT&& value) { SetPlacementStrategy(std::forward<PlacementStrategyT>(value)); return *this;}
229 template<typename PlacementStrategyT = PlacementStrategy>
230 RunTaskRequest& AddPlacementStrategy(PlacementStrategyT&& value) { m_placementStrategyHasBeenSet = true; m_placementStrategy.emplace_back(std::forward<PlacementStrategyT>(value)); return *this; }
232
234
242 inline const Aws::String& GetPlatformVersion() const { return m_platformVersion; }
243 inline bool PlatformVersionHasBeenSet() const { return m_platformVersionHasBeenSet; }
244 template<typename PlatformVersionT = Aws::String>
245 void SetPlatformVersion(PlatformVersionT&& value) { m_platformVersionHasBeenSet = true; m_platformVersion = std::forward<PlatformVersionT>(value); }
246 template<typename PlatformVersionT = Aws::String>
247 RunTaskRequest& WithPlatformVersion(PlatformVersionT&& value) { SetPlatformVersion(std::forward<PlatformVersionT>(value)); return *this;}
249
251
260 inline PropagateTags GetPropagateTags() const { return m_propagateTags; }
261 inline bool PropagateTagsHasBeenSet() const { return m_propagateTagsHasBeenSet; }
262 inline void SetPropagateTags(PropagateTags value) { m_propagateTagsHasBeenSet = true; m_propagateTags = value; }
263 inline RunTaskRequest& WithPropagateTags(PropagateTags value) { SetPropagateTags(value); return *this;}
265
267
271 inline const Aws::String& GetReferenceId() const { return m_referenceId; }
272 inline bool ReferenceIdHasBeenSet() const { return m_referenceIdHasBeenSet; }
273 template<typename ReferenceIdT = Aws::String>
274 void SetReferenceId(ReferenceIdT&& value) { m_referenceIdHasBeenSet = true; m_referenceId = std::forward<ReferenceIdT>(value); }
275 template<typename ReferenceIdT = Aws::String>
276 RunTaskRequest& WithReferenceId(ReferenceIdT&& value) { SetReferenceId(std::forward<ReferenceIdT>(value)); return *this;}
278
280
293 inline const Aws::String& GetStartedBy() const { return m_startedBy; }
294 inline bool StartedByHasBeenSet() const { return m_startedByHasBeenSet; }
295 template<typename StartedByT = Aws::String>
296 void SetStartedBy(StartedByT&& value) { m_startedByHasBeenSet = true; m_startedBy = std::forward<StartedByT>(value); }
297 template<typename StartedByT = Aws::String>
298 RunTaskRequest& WithStartedBy(StartedByT&& value) { SetStartedBy(std::forward<StartedByT>(value)); return *this;}
300
302
320 inline const Aws::Vector<Tag>& GetTags() const { return m_tags; }
321 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
322 template<typename TagsT = Aws::Vector<Tag>>
323 void SetTags(TagsT&& value) { m_tagsHasBeenSet = true; m_tags = std::forward<TagsT>(value); }
324 template<typename TagsT = Aws::Vector<Tag>>
325 RunTaskRequest& WithTags(TagsT&& value) { SetTags(std::forward<TagsT>(value)); return *this;}
326 template<typename TagsT = Tag>
327 RunTaskRequest& AddTags(TagsT&& value) { m_tagsHasBeenSet = true; m_tags.emplace_back(std::forward<TagsT>(value)); return *this; }
329
331
349 inline const Aws::String& GetTaskDefinition() const { return m_taskDefinition; }
350 inline bool TaskDefinitionHasBeenSet() const { return m_taskDefinitionHasBeenSet; }
351 template<typename TaskDefinitionT = Aws::String>
352 void SetTaskDefinition(TaskDefinitionT&& value) { m_taskDefinitionHasBeenSet = true; m_taskDefinition = std::forward<TaskDefinitionT>(value); }
353 template<typename TaskDefinitionT = Aws::String>
354 RunTaskRequest& WithTaskDefinition(TaskDefinitionT&& value) { SetTaskDefinition(std::forward<TaskDefinitionT>(value)); return *this;}
356
358
366 inline const Aws::String& GetClientToken() const { return m_clientToken; }
367 inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; }
368 template<typename ClientTokenT = Aws::String>
369 void SetClientToken(ClientTokenT&& value) { m_clientTokenHasBeenSet = true; m_clientToken = std::forward<ClientTokenT>(value); }
370 template<typename ClientTokenT = Aws::String>
371 RunTaskRequest& WithClientToken(ClientTokenT&& value) { SetClientToken(std::forward<ClientTokenT>(value)); return *this;}
373
375
383 inline const Aws::Vector<TaskVolumeConfiguration>& GetVolumeConfigurations() const { return m_volumeConfigurations; }
384 inline bool VolumeConfigurationsHasBeenSet() const { return m_volumeConfigurationsHasBeenSet; }
385 template<typename VolumeConfigurationsT = Aws::Vector<TaskVolumeConfiguration>>
386 void SetVolumeConfigurations(VolumeConfigurationsT&& value) { m_volumeConfigurationsHasBeenSet = true; m_volumeConfigurations = std::forward<VolumeConfigurationsT>(value); }
387 template<typename VolumeConfigurationsT = Aws::Vector<TaskVolumeConfiguration>>
388 RunTaskRequest& WithVolumeConfigurations(VolumeConfigurationsT&& value) { SetVolumeConfigurations(std::forward<VolumeConfigurationsT>(value)); return *this;}
389 template<typename VolumeConfigurationsT = TaskVolumeConfiguration>
390 RunTaskRequest& AddVolumeConfigurations(VolumeConfigurationsT&& value) { m_volumeConfigurationsHasBeenSet = true; m_volumeConfigurations.emplace_back(std::forward<VolumeConfigurationsT>(value)); return *this; }
392 private:
393
394 Aws::Vector<CapacityProviderStrategyItem> m_capacityProviderStrategy;
395 bool m_capacityProviderStrategyHasBeenSet = false;
396
397 Aws::String m_cluster;
398 bool m_clusterHasBeenSet = false;
399
400 int m_count{0};
401 bool m_countHasBeenSet = false;
402
403 bool m_enableECSManagedTags{false};
404 bool m_enableECSManagedTagsHasBeenSet = false;
405
406 bool m_enableExecuteCommand{false};
407 bool m_enableExecuteCommandHasBeenSet = false;
408
409 Aws::String m_group;
410 bool m_groupHasBeenSet = false;
411
412 LaunchType m_launchType{LaunchType::NOT_SET};
413 bool m_launchTypeHasBeenSet = false;
414
415 NetworkConfiguration m_networkConfiguration;
416 bool m_networkConfigurationHasBeenSet = false;
417
418 TaskOverride m_overrides;
419 bool m_overridesHasBeenSet = false;
420
421 Aws::Vector<PlacementConstraint> m_placementConstraints;
422 bool m_placementConstraintsHasBeenSet = false;
423
424 Aws::Vector<PlacementStrategy> m_placementStrategy;
425 bool m_placementStrategyHasBeenSet = false;
426
427 Aws::String m_platformVersion;
428 bool m_platformVersionHasBeenSet = false;
429
430 PropagateTags m_propagateTags{PropagateTags::NOT_SET};
431 bool m_propagateTagsHasBeenSet = false;
432
433 Aws::String m_referenceId;
434 bool m_referenceIdHasBeenSet = false;
435
436 Aws::String m_startedBy;
437 bool m_startedByHasBeenSet = false;
438
439 Aws::Vector<Tag> m_tags;
440 bool m_tagsHasBeenSet = false;
441
442 Aws::String m_taskDefinition;
443 bool m_taskDefinitionHasBeenSet = false;
444
446 bool m_clientTokenHasBeenSet = true;
447
448 Aws::Vector<TaskVolumeConfiguration> m_volumeConfigurations;
449 bool m_volumeConfigurationsHasBeenSet = false;
450 };
451
452} // namespace Model
453} // namespace ECS
454} // 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