AWS SDK for C++

AWS SDK for C++ Version 1.11.554

All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Loading...
Searching...
No Matches
StartAutomationExecutionRequest.h
1
6#pragma once
7#include <aws/ssm/SSM_EXPORTS.h>
8#include <aws/ssm/SSMRequest.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/core/utils/memory/stl/AWSMap.h>
11#include <aws/ssm/model/ExecutionMode.h>
12#include <aws/core/utils/memory/stl/AWSVector.h>
13#include <aws/ssm/model/AlarmConfiguration.h>
14#include <aws/ssm/model/Target.h>
15#include <aws/ssm/model/TargetLocation.h>
16#include <aws/ssm/model/Tag.h>
17#include <utility>
18
19namespace Aws
20{
21namespace SSM
22{
23namespace Model
24{
25
29 {
30 public:
31 AWS_SSM_API StartAutomationExecutionRequest() = 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 "StartAutomationExecution"; }
38
39 AWS_SSM_API Aws::String SerializePayload() const override;
40
42
43
45
53 inline const Aws::String& GetDocumentName() const { return m_documentName; }
54 inline bool DocumentNameHasBeenSet() const { return m_documentNameHasBeenSet; }
55 template<typename DocumentNameT = Aws::String>
56 void SetDocumentName(DocumentNameT&& value) { m_documentNameHasBeenSet = true; m_documentName = std::forward<DocumentNameT>(value); }
57 template<typename DocumentNameT = Aws::String>
58 StartAutomationExecutionRequest& WithDocumentName(DocumentNameT&& value) { SetDocumentName(std::forward<DocumentNameT>(value)); return *this;}
60
62
65 inline const Aws::String& GetDocumentVersion() const { return m_documentVersion; }
66 inline bool DocumentVersionHasBeenSet() const { return m_documentVersionHasBeenSet; }
67 template<typename DocumentVersionT = Aws::String>
68 void SetDocumentVersion(DocumentVersionT&& value) { m_documentVersionHasBeenSet = true; m_documentVersion = std::forward<DocumentVersionT>(value); }
69 template<typename DocumentVersionT = Aws::String>
70 StartAutomationExecutionRequest& WithDocumentVersion(DocumentVersionT&& value) { SetDocumentVersion(std::forward<DocumentVersionT>(value)); return *this;}
72
74
78 inline const Aws::Map<Aws::String, Aws::Vector<Aws::String>>& GetParameters() const { return m_parameters; }
79 inline bool ParametersHasBeenSet() const { return m_parametersHasBeenSet; }
80 template<typename ParametersT = Aws::Map<Aws::String, Aws::Vector<Aws::String>>>
81 void SetParameters(ParametersT&& value) { m_parametersHasBeenSet = true; m_parameters = std::forward<ParametersT>(value); }
82 template<typename ParametersT = Aws::Map<Aws::String, Aws::Vector<Aws::String>>>
83 StartAutomationExecutionRequest& WithParameters(ParametersT&& value) { SetParameters(std::forward<ParametersT>(value)); return *this;}
84 template<typename ParametersKeyT = Aws::String, typename ParametersValueT = Aws::Vector<Aws::String>>
85 StartAutomationExecutionRequest& AddParameters(ParametersKeyT&& key, ParametersValueT&& value) {
86 m_parametersHasBeenSet = true; m_parameters.emplace(std::forward<ParametersKeyT>(key), std::forward<ParametersValueT>(value)); return *this;
87 }
89
91
95 inline const Aws::String& GetClientToken() const { return m_clientToken; }
96 inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; }
97 template<typename ClientTokenT = Aws::String>
98 void SetClientToken(ClientTokenT&& value) { m_clientTokenHasBeenSet = true; m_clientToken = std::forward<ClientTokenT>(value); }
99 template<typename ClientTokenT = Aws::String>
100 StartAutomationExecutionRequest& WithClientToken(ClientTokenT&& value) { SetClientToken(std::forward<ClientTokenT>(value)); return *this;}
102
104
108 inline ExecutionMode GetMode() const { return m_mode; }
109 inline bool ModeHasBeenSet() const { return m_modeHasBeenSet; }
110 inline void SetMode(ExecutionMode value) { m_modeHasBeenSet = true; m_mode = value; }
111 inline StartAutomationExecutionRequest& WithMode(ExecutionMode value) { SetMode(value); return *this;}
113
115
119 inline const Aws::String& GetTargetParameterName() const { return m_targetParameterName; }
120 inline bool TargetParameterNameHasBeenSet() const { return m_targetParameterNameHasBeenSet; }
121 template<typename TargetParameterNameT = Aws::String>
122 void SetTargetParameterName(TargetParameterNameT&& value) { m_targetParameterNameHasBeenSet = true; m_targetParameterName = std::forward<TargetParameterNameT>(value); }
123 template<typename TargetParameterNameT = Aws::String>
124 StartAutomationExecutionRequest& WithTargetParameterName(TargetParameterNameT&& value) { SetTargetParameterName(std::forward<TargetParameterNameT>(value)); return *this;}
126
128
134 inline const Aws::Vector<Target>& GetTargets() const { return m_targets; }
135 inline bool TargetsHasBeenSet() const { return m_targetsHasBeenSet; }
136 template<typename TargetsT = Aws::Vector<Target>>
137 void SetTargets(TargetsT&& value) { m_targetsHasBeenSet = true; m_targets = std::forward<TargetsT>(value); }
138 template<typename TargetsT = Aws::Vector<Target>>
139 StartAutomationExecutionRequest& WithTargets(TargetsT&& value) { SetTargets(std::forward<TargetsT>(value)); return *this;}
140 template<typename TargetsT = Target>
141 StartAutomationExecutionRequest& AddTargets(TargetsT&& value) { m_targetsHasBeenSet = true; m_targets.emplace_back(std::forward<TargetsT>(value)); return *this; }
143
145
149 inline const Aws::Vector<Aws::Map<Aws::String, Aws::Vector<Aws::String>>>& GetTargetMaps() const { return m_targetMaps; }
150 inline bool TargetMapsHasBeenSet() const { return m_targetMapsHasBeenSet; }
151 template<typename TargetMapsT = Aws::Vector<Aws::Map<Aws::String, Aws::Vector<Aws::String>>>>
152 void SetTargetMaps(TargetMapsT&& value) { m_targetMapsHasBeenSet = true; m_targetMaps = std::forward<TargetMapsT>(value); }
153 template<typename TargetMapsT = Aws::Vector<Aws::Map<Aws::String, Aws::Vector<Aws::String>>>>
154 StartAutomationExecutionRequest& WithTargetMaps(TargetMapsT&& value) { SetTargetMaps(std::forward<TargetMapsT>(value)); return *this;}
155 template<typename TargetMapsT = Aws::Map<Aws::String, Aws::Vector<Aws::String>>>
156 StartAutomationExecutionRequest& AddTargetMaps(TargetMapsT&& value) { m_targetMapsHasBeenSet = true; m_targetMaps.emplace_back(std::forward<TargetMapsT>(value)); return *this; }
158
160
167 inline const Aws::String& GetMaxConcurrency() const { return m_maxConcurrency; }
168 inline bool MaxConcurrencyHasBeenSet() const { return m_maxConcurrencyHasBeenSet; }
169 template<typename MaxConcurrencyT = Aws::String>
170 void SetMaxConcurrency(MaxConcurrencyT&& value) { m_maxConcurrencyHasBeenSet = true; m_maxConcurrency = std::forward<MaxConcurrencyT>(value); }
171 template<typename MaxConcurrencyT = Aws::String>
172 StartAutomationExecutionRequest& WithMaxConcurrency(MaxConcurrencyT&& value) { SetMaxConcurrency(std::forward<MaxConcurrencyT>(value)); return *this;}
174
176
193 inline const Aws::String& GetMaxErrors() const { return m_maxErrors; }
194 inline bool MaxErrorsHasBeenSet() const { return m_maxErrorsHasBeenSet; }
195 template<typename MaxErrorsT = Aws::String>
196 void SetMaxErrors(MaxErrorsT&& value) { m_maxErrorsHasBeenSet = true; m_maxErrors = std::forward<MaxErrorsT>(value); }
197 template<typename MaxErrorsT = Aws::String>
198 StartAutomationExecutionRequest& WithMaxErrors(MaxErrorsT&& value) { SetMaxErrors(std::forward<MaxErrorsT>(value)); return *this;}
200
202
211 inline const Aws::Vector<TargetLocation>& GetTargetLocations() const { return m_targetLocations; }
212 inline bool TargetLocationsHasBeenSet() const { return m_targetLocationsHasBeenSet; }
213 template<typename TargetLocationsT = Aws::Vector<TargetLocation>>
214 void SetTargetLocations(TargetLocationsT&& value) { m_targetLocationsHasBeenSet = true; m_targetLocations = std::forward<TargetLocationsT>(value); }
215 template<typename TargetLocationsT = Aws::Vector<TargetLocation>>
216 StartAutomationExecutionRequest& WithTargetLocations(TargetLocationsT&& value) { SetTargetLocations(std::forward<TargetLocationsT>(value)); return *this;}
217 template<typename TargetLocationsT = TargetLocation>
218 StartAutomationExecutionRequest& AddTargetLocations(TargetLocationsT&& value) { m_targetLocationsHasBeenSet = true; m_targetLocations.emplace_back(std::forward<TargetLocationsT>(value)); return *this; }
220
222
236 inline const Aws::Vector<Tag>& GetTags() const { return m_tags; }
237 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
238 template<typename TagsT = Aws::Vector<Tag>>
239 void SetTags(TagsT&& value) { m_tagsHasBeenSet = true; m_tags = std::forward<TagsT>(value); }
240 template<typename TagsT = Aws::Vector<Tag>>
241 StartAutomationExecutionRequest& WithTags(TagsT&& value) { SetTags(std::forward<TagsT>(value)); return *this;}
242 template<typename TagsT = Tag>
243 StartAutomationExecutionRequest& AddTags(TagsT&& value) { m_tagsHasBeenSet = true; m_tags.emplace_back(std::forward<TagsT>(value)); return *this; }
245
247
250 inline const AlarmConfiguration& GetAlarmConfiguration() const { return m_alarmConfiguration; }
251 inline bool AlarmConfigurationHasBeenSet() const { return m_alarmConfigurationHasBeenSet; }
252 template<typename AlarmConfigurationT = AlarmConfiguration>
253 void SetAlarmConfiguration(AlarmConfigurationT&& value) { m_alarmConfigurationHasBeenSet = true; m_alarmConfiguration = std::forward<AlarmConfigurationT>(value); }
254 template<typename AlarmConfigurationT = AlarmConfiguration>
255 StartAutomationExecutionRequest& WithAlarmConfiguration(AlarmConfigurationT&& value) { SetAlarmConfiguration(std::forward<AlarmConfigurationT>(value)); return *this;}
257
259
264 inline const Aws::String& GetTargetLocationsURL() const { return m_targetLocationsURL; }
265 inline bool TargetLocationsURLHasBeenSet() const { return m_targetLocationsURLHasBeenSet; }
266 template<typename TargetLocationsURLT = Aws::String>
267 void SetTargetLocationsURL(TargetLocationsURLT&& value) { m_targetLocationsURLHasBeenSet = true; m_targetLocationsURL = std::forward<TargetLocationsURLT>(value); }
268 template<typename TargetLocationsURLT = Aws::String>
269 StartAutomationExecutionRequest& WithTargetLocationsURL(TargetLocationsURLT&& value) { SetTargetLocationsURL(std::forward<TargetLocationsURLT>(value)); return *this;}
271 private:
272
273 Aws::String m_documentName;
274 bool m_documentNameHasBeenSet = false;
275
276 Aws::String m_documentVersion;
277 bool m_documentVersionHasBeenSet = false;
278
280 bool m_parametersHasBeenSet = false;
281
282 Aws::String m_clientToken;
283 bool m_clientTokenHasBeenSet = false;
284
286 bool m_modeHasBeenSet = false;
287
288 Aws::String m_targetParameterName;
289 bool m_targetParameterNameHasBeenSet = false;
290
291 Aws::Vector<Target> m_targets;
292 bool m_targetsHasBeenSet = false;
293
295 bool m_targetMapsHasBeenSet = false;
296
297 Aws::String m_maxConcurrency;
298 bool m_maxConcurrencyHasBeenSet = false;
299
300 Aws::String m_maxErrors;
301 bool m_maxErrorsHasBeenSet = false;
302
303 Aws::Vector<TargetLocation> m_targetLocations;
304 bool m_targetLocationsHasBeenSet = false;
305
306 Aws::Vector<Tag> m_tags;
307 bool m_tagsHasBeenSet = false;
308
309 AlarmConfiguration m_alarmConfiguration;
310 bool m_alarmConfigurationHasBeenSet = false;
311
312 Aws::String m_targetLocationsURL;
313 bool m_targetLocationsURLHasBeenSet = false;
314 };
315
316} // namespace Model
317} // namespace SSM
318} // namespace Aws
StartAutomationExecutionRequest & WithParameters(ParametersT &&value)
StartAutomationExecutionRequest & WithMode(ExecutionMode value)
const Aws::Vector< Aws::Map< Aws::String, Aws::Vector< Aws::String > > > & GetTargetMaps() const
AWS_SSM_API Aws::String SerializePayload() const override
StartAutomationExecutionRequest & WithDocumentName(DocumentNameT &&value)
StartAutomationExecutionRequest & WithTargetMaps(TargetMapsT &&value)
StartAutomationExecutionRequest & WithTargetLocations(TargetLocationsT &&value)
StartAutomationExecutionRequest & WithTargetParameterName(TargetParameterNameT &&value)
StartAutomationExecutionRequest & AddParameters(ParametersKeyT &&key, ParametersValueT &&value)
StartAutomationExecutionRequest & AddTargetLocations(TargetLocationsT &&value)
StartAutomationExecutionRequest & WithTags(TagsT &&value)
StartAutomationExecutionRequest & WithClientToken(ClientTokenT &&value)
AWS_SSM_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
StartAutomationExecutionRequest & AddTargets(TargetsT &&value)
StartAutomationExecutionRequest & WithMaxErrors(MaxErrorsT &&value)
StartAutomationExecutionRequest & AddTags(TagsT &&value)
StartAutomationExecutionRequest & WithAlarmConfiguration(AlarmConfigurationT &&value)
StartAutomationExecutionRequest & WithTargetLocationsURL(TargetLocationsURLT &&value)
const Aws::Map< Aws::String, Aws::Vector< Aws::String > > & GetParameters() const
StartAutomationExecutionRequest & WithMaxConcurrency(MaxConcurrencyT &&value)
const Aws::Vector< TargetLocation > & GetTargetLocations() const
StartAutomationExecutionRequest & AddTargetMaps(TargetMapsT &&value)
StartAutomationExecutionRequest & WithTargets(TargetsT &&value)
StartAutomationExecutionRequest & WithDocumentVersion(DocumentVersionT &&value)
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
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