AWS SDK for C++

AWS SDK for C++ Version 1.11.606

Loading...
Searching...
No Matches
StepExecution.h
1
6#pragma once
7#include <aws/ssm/SSM_EXPORTS.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/core/utils/DateTime.h>
10#include <aws/ssm/model/AutomationExecutionStatus.h>
11#include <aws/core/utils/memory/stl/AWSMap.h>
12#include <aws/ssm/model/FailureDetails.h>
13#include <aws/core/utils/memory/stl/AWSVector.h>
14#include <aws/ssm/model/TargetLocation.h>
15#include <aws/ssm/model/ParentStepDetails.h>
16#include <aws/ssm/model/Target.h>
17#include <aws/ssm/model/AlarmStateInformation.h>
18#include <utility>
19
20namespace Aws
21{
22namespace Utils
23{
24namespace Json
25{
26 class JsonValue;
27 class JsonView;
28} // namespace Json
29} // namespace Utils
30namespace SSM
31{
32namespace Model
33{
34
42 {
43 public:
44 AWS_SSM_API StepExecution() = default;
48
49
51
54 inline const Aws::String& GetStepName() const { return m_stepName; }
55 inline bool StepNameHasBeenSet() const { return m_stepNameHasBeenSet; }
56 template<typename StepNameT = Aws::String>
57 void SetStepName(StepNameT&& value) { m_stepNameHasBeenSet = true; m_stepName = std::forward<StepNameT>(value); }
58 template<typename StepNameT = Aws::String>
59 StepExecution& WithStepName(StepNameT&& value) { SetStepName(std::forward<StepNameT>(value)); return *this;}
61
63
67 inline const Aws::String& GetAction() const { return m_action; }
68 inline bool ActionHasBeenSet() const { return m_actionHasBeenSet; }
69 template<typename ActionT = Aws::String>
70 void SetAction(ActionT&& value) { m_actionHasBeenSet = true; m_action = std::forward<ActionT>(value); }
71 template<typename ActionT = Aws::String>
72 StepExecution& WithAction(ActionT&& value) { SetAction(std::forward<ActionT>(value)); return *this;}
74
76
79 inline long long GetTimeoutSeconds() const { return m_timeoutSeconds; }
80 inline bool TimeoutSecondsHasBeenSet() const { return m_timeoutSecondsHasBeenSet; }
81 inline void SetTimeoutSeconds(long long value) { m_timeoutSecondsHasBeenSet = true; m_timeoutSeconds = value; }
82 inline StepExecution& WithTimeoutSeconds(long long value) { SetTimeoutSeconds(value); return *this;}
84
86
90 inline const Aws::String& GetOnFailure() const { return m_onFailure; }
91 inline bool OnFailureHasBeenSet() const { return m_onFailureHasBeenSet; }
92 template<typename OnFailureT = Aws::String>
93 void SetOnFailure(OnFailureT&& value) { m_onFailureHasBeenSet = true; m_onFailure = std::forward<OnFailureT>(value); }
94 template<typename OnFailureT = Aws::String>
95 StepExecution& WithOnFailure(OnFailureT&& value) { SetOnFailure(std::forward<OnFailureT>(value)); return *this;}
97
99
103 inline int GetMaxAttempts() const { return m_maxAttempts; }
104 inline bool MaxAttemptsHasBeenSet() const { return m_maxAttemptsHasBeenSet; }
105 inline void SetMaxAttempts(int value) { m_maxAttemptsHasBeenSet = true; m_maxAttempts = value; }
106 inline StepExecution& WithMaxAttempts(int value) { SetMaxAttempts(value); return *this;}
108
110
114 inline const Aws::Utils::DateTime& GetExecutionStartTime() const { return m_executionStartTime; }
115 inline bool ExecutionStartTimeHasBeenSet() const { return m_executionStartTimeHasBeenSet; }
116 template<typename ExecutionStartTimeT = Aws::Utils::DateTime>
117 void SetExecutionStartTime(ExecutionStartTimeT&& value) { m_executionStartTimeHasBeenSet = true; m_executionStartTime = std::forward<ExecutionStartTimeT>(value); }
118 template<typename ExecutionStartTimeT = Aws::Utils::DateTime>
119 StepExecution& WithExecutionStartTime(ExecutionStartTimeT&& value) { SetExecutionStartTime(std::forward<ExecutionStartTimeT>(value)); return *this;}
121
123
127 inline const Aws::Utils::DateTime& GetExecutionEndTime() const { return m_executionEndTime; }
128 inline bool ExecutionEndTimeHasBeenSet() const { return m_executionEndTimeHasBeenSet; }
129 template<typename ExecutionEndTimeT = Aws::Utils::DateTime>
130 void SetExecutionEndTime(ExecutionEndTimeT&& value) { m_executionEndTimeHasBeenSet = true; m_executionEndTime = std::forward<ExecutionEndTimeT>(value); }
131 template<typename ExecutionEndTimeT = Aws::Utils::DateTime>
132 StepExecution& WithExecutionEndTime(ExecutionEndTimeT&& value) { SetExecutionEndTime(std::forward<ExecutionEndTimeT>(value)); return *this;}
134
136
139 inline AutomationExecutionStatus GetStepStatus() const { return m_stepStatus; }
140 inline bool StepStatusHasBeenSet() const { return m_stepStatusHasBeenSet; }
141 inline void SetStepStatus(AutomationExecutionStatus value) { m_stepStatusHasBeenSet = true; m_stepStatus = value; }
144
146
149 inline const Aws::String& GetResponseCode() const { return m_responseCode; }
150 inline bool ResponseCodeHasBeenSet() const { return m_responseCodeHasBeenSet; }
151 template<typename ResponseCodeT = Aws::String>
152 void SetResponseCode(ResponseCodeT&& value) { m_responseCodeHasBeenSet = true; m_responseCode = std::forward<ResponseCodeT>(value); }
153 template<typename ResponseCodeT = Aws::String>
154 StepExecution& WithResponseCode(ResponseCodeT&& value) { SetResponseCode(std::forward<ResponseCodeT>(value)); return *this;}
156
158
161 inline const Aws::Map<Aws::String, Aws::String>& GetInputs() const { return m_inputs; }
162 inline bool InputsHasBeenSet() const { return m_inputsHasBeenSet; }
163 template<typename InputsT = Aws::Map<Aws::String, Aws::String>>
164 void SetInputs(InputsT&& value) { m_inputsHasBeenSet = true; m_inputs = std::forward<InputsT>(value); }
165 template<typename InputsT = Aws::Map<Aws::String, Aws::String>>
166 StepExecution& WithInputs(InputsT&& value) { SetInputs(std::forward<InputsT>(value)); return *this;}
167 template<typename InputsKeyT = Aws::String, typename InputsValueT = Aws::String>
168 StepExecution& AddInputs(InputsKeyT&& key, InputsValueT&& value) {
169 m_inputsHasBeenSet = true; m_inputs.emplace(std::forward<InputsKeyT>(key), std::forward<InputsValueT>(value)); return *this;
170 }
172
174
177 inline const Aws::Map<Aws::String, Aws::Vector<Aws::String>>& GetOutputs() const { return m_outputs; }
178 inline bool OutputsHasBeenSet() const { return m_outputsHasBeenSet; }
179 template<typename OutputsT = Aws::Map<Aws::String, Aws::Vector<Aws::String>>>
180 void SetOutputs(OutputsT&& value) { m_outputsHasBeenSet = true; m_outputs = std::forward<OutputsT>(value); }
181 template<typename OutputsT = Aws::Map<Aws::String, Aws::Vector<Aws::String>>>
182 StepExecution& WithOutputs(OutputsT&& value) { SetOutputs(std::forward<OutputsT>(value)); return *this;}
183 template<typename OutputsKeyT = Aws::String, typename OutputsValueT = Aws::Vector<Aws::String>>
184 StepExecution& AddOutputs(OutputsKeyT&& key, OutputsValueT&& value) {
185 m_outputsHasBeenSet = true; m_outputs.emplace(std::forward<OutputsKeyT>(key), std::forward<OutputsValueT>(value)); return *this;
186 }
188
190
193 inline const Aws::String& GetResponse() const { return m_response; }
194 inline bool ResponseHasBeenSet() const { return m_responseHasBeenSet; }
195 template<typename ResponseT = Aws::String>
196 void SetResponse(ResponseT&& value) { m_responseHasBeenSet = true; m_response = std::forward<ResponseT>(value); }
197 template<typename ResponseT = Aws::String>
198 StepExecution& WithResponse(ResponseT&& value) { SetResponse(std::forward<ResponseT>(value)); return *this;}
200
202
205 inline const Aws::String& GetFailureMessage() const { return m_failureMessage; }
206 inline bool FailureMessageHasBeenSet() const { return m_failureMessageHasBeenSet; }
207 template<typename FailureMessageT = Aws::String>
208 void SetFailureMessage(FailureMessageT&& value) { m_failureMessageHasBeenSet = true; m_failureMessage = std::forward<FailureMessageT>(value); }
209 template<typename FailureMessageT = Aws::String>
210 StepExecution& WithFailureMessage(FailureMessageT&& value) { SetFailureMessage(std::forward<FailureMessageT>(value)); return *this;}
212
214
217 inline const FailureDetails& GetFailureDetails() const { return m_failureDetails; }
218 inline bool FailureDetailsHasBeenSet() const { return m_failureDetailsHasBeenSet; }
219 template<typename FailureDetailsT = FailureDetails>
220 void SetFailureDetails(FailureDetailsT&& value) { m_failureDetailsHasBeenSet = true; m_failureDetails = std::forward<FailureDetailsT>(value); }
221 template<typename FailureDetailsT = FailureDetails>
222 StepExecution& WithFailureDetails(FailureDetailsT&& value) { SetFailureDetails(std::forward<FailureDetailsT>(value)); return *this;}
224
226
229 inline const Aws::String& GetStepExecutionId() const { return m_stepExecutionId; }
230 inline bool StepExecutionIdHasBeenSet() const { return m_stepExecutionIdHasBeenSet; }
231 template<typename StepExecutionIdT = Aws::String>
232 void SetStepExecutionId(StepExecutionIdT&& value) { m_stepExecutionIdHasBeenSet = true; m_stepExecutionId = std::forward<StepExecutionIdT>(value); }
233 template<typename StepExecutionIdT = Aws::String>
234 StepExecution& WithStepExecutionId(StepExecutionIdT&& value) { SetStepExecutionId(std::forward<StepExecutionIdT>(value)); return *this;}
236
238
241 inline const Aws::Map<Aws::String, Aws::Vector<Aws::String>>& GetOverriddenParameters() const { return m_overriddenParameters; }
242 inline bool OverriddenParametersHasBeenSet() const { return m_overriddenParametersHasBeenSet; }
243 template<typename OverriddenParametersT = Aws::Map<Aws::String, Aws::Vector<Aws::String>>>
244 void SetOverriddenParameters(OverriddenParametersT&& value) { m_overriddenParametersHasBeenSet = true; m_overriddenParameters = std::forward<OverriddenParametersT>(value); }
245 template<typename OverriddenParametersT = Aws::Map<Aws::String, Aws::Vector<Aws::String>>>
246 StepExecution& WithOverriddenParameters(OverriddenParametersT&& value) { SetOverriddenParameters(std::forward<OverriddenParametersT>(value)); return *this;}
247 template<typename OverriddenParametersKeyT = Aws::String, typename OverriddenParametersValueT = Aws::Vector<Aws::String>>
248 StepExecution& AddOverriddenParameters(OverriddenParametersKeyT&& key, OverriddenParametersValueT&& value) {
249 m_overriddenParametersHasBeenSet = true; m_overriddenParameters.emplace(std::forward<OverriddenParametersKeyT>(key), std::forward<OverriddenParametersValueT>(value)); return *this;
250 }
252
254
258 inline bool GetIsEnd() const { return m_isEnd; }
259 inline bool IsEndHasBeenSet() const { return m_isEndHasBeenSet; }
260 inline void SetIsEnd(bool value) { m_isEndHasBeenSet = true; m_isEnd = value; }
261 inline StepExecution& WithIsEnd(bool value) { SetIsEnd(value); return *this;}
263
265
268 inline const Aws::String& GetNextStep() const { return m_nextStep; }
269 inline bool NextStepHasBeenSet() const { return m_nextStepHasBeenSet; }
270 template<typename NextStepT = Aws::String>
271 void SetNextStep(NextStepT&& value) { m_nextStepHasBeenSet = true; m_nextStep = std::forward<NextStepT>(value); }
272 template<typename NextStepT = Aws::String>
273 StepExecution& WithNextStep(NextStepT&& value) { SetNextStep(std::forward<NextStepT>(value)); return *this;}
275
277
281 inline bool GetIsCritical() const { return m_isCritical; }
282 inline bool IsCriticalHasBeenSet() const { return m_isCriticalHasBeenSet; }
283 inline void SetIsCritical(bool value) { m_isCriticalHasBeenSet = true; m_isCritical = value; }
284 inline StepExecution& WithIsCritical(bool value) { SetIsCritical(value); return *this;}
286
288
295 inline const Aws::Vector<Aws::String>& GetValidNextSteps() const { return m_validNextSteps; }
296 inline bool ValidNextStepsHasBeenSet() const { return m_validNextStepsHasBeenSet; }
297 template<typename ValidNextStepsT = Aws::Vector<Aws::String>>
298 void SetValidNextSteps(ValidNextStepsT&& value) { m_validNextStepsHasBeenSet = true; m_validNextSteps = std::forward<ValidNextStepsT>(value); }
299 template<typename ValidNextStepsT = Aws::Vector<Aws::String>>
300 StepExecution& WithValidNextSteps(ValidNextStepsT&& value) { SetValidNextSteps(std::forward<ValidNextStepsT>(value)); return *this;}
301 template<typename ValidNextStepsT = Aws::String>
302 StepExecution& AddValidNextSteps(ValidNextStepsT&& value) { m_validNextStepsHasBeenSet = true; m_validNextSteps.emplace_back(std::forward<ValidNextStepsT>(value)); return *this; }
304
306
309 inline const Aws::Vector<Target>& GetTargets() const { return m_targets; }
310 inline bool TargetsHasBeenSet() const { return m_targetsHasBeenSet; }
311 template<typename TargetsT = Aws::Vector<Target>>
312 void SetTargets(TargetsT&& value) { m_targetsHasBeenSet = true; m_targets = std::forward<TargetsT>(value); }
313 template<typename TargetsT = Aws::Vector<Target>>
314 StepExecution& WithTargets(TargetsT&& value) { SetTargets(std::forward<TargetsT>(value)); return *this;}
315 template<typename TargetsT = Target>
316 StepExecution& AddTargets(TargetsT&& value) { m_targetsHasBeenSet = true; m_targets.emplace_back(std::forward<TargetsT>(value)); return *this; }
318
320
324 inline const TargetLocation& GetTargetLocation() const { return m_targetLocation; }
325 inline bool TargetLocationHasBeenSet() const { return m_targetLocationHasBeenSet; }
326 template<typename TargetLocationT = TargetLocation>
327 void SetTargetLocation(TargetLocationT&& value) { m_targetLocationHasBeenSet = true; m_targetLocation = std::forward<TargetLocationT>(value); }
328 template<typename TargetLocationT = TargetLocation>
329 StepExecution& WithTargetLocation(TargetLocationT&& value) { SetTargetLocation(std::forward<TargetLocationT>(value)); return *this;}
331
333
336 inline const Aws::Vector<AlarmStateInformation>& GetTriggeredAlarms() const { return m_triggeredAlarms; }
337 inline bool TriggeredAlarmsHasBeenSet() const { return m_triggeredAlarmsHasBeenSet; }
338 template<typename TriggeredAlarmsT = Aws::Vector<AlarmStateInformation>>
339 void SetTriggeredAlarms(TriggeredAlarmsT&& value) { m_triggeredAlarmsHasBeenSet = true; m_triggeredAlarms = std::forward<TriggeredAlarmsT>(value); }
340 template<typename TriggeredAlarmsT = Aws::Vector<AlarmStateInformation>>
341 StepExecution& WithTriggeredAlarms(TriggeredAlarmsT&& value) { SetTriggeredAlarms(std::forward<TriggeredAlarmsT>(value)); return *this;}
342 template<typename TriggeredAlarmsT = AlarmStateInformation>
343 StepExecution& AddTriggeredAlarms(TriggeredAlarmsT&& value) { m_triggeredAlarmsHasBeenSet = true; m_triggeredAlarms.emplace_back(std::forward<TriggeredAlarmsT>(value)); return *this; }
345
347
350 inline const ParentStepDetails& GetParentStepDetails() const { return m_parentStepDetails; }
351 inline bool ParentStepDetailsHasBeenSet() const { return m_parentStepDetailsHasBeenSet; }
352 template<typename ParentStepDetailsT = ParentStepDetails>
353 void SetParentStepDetails(ParentStepDetailsT&& value) { m_parentStepDetailsHasBeenSet = true; m_parentStepDetails = std::forward<ParentStepDetailsT>(value); }
354 template<typename ParentStepDetailsT = ParentStepDetails>
355 StepExecution& WithParentStepDetails(ParentStepDetailsT&& value) { SetParentStepDetails(std::forward<ParentStepDetailsT>(value)); return *this;}
357 private:
358
359 Aws::String m_stepName;
360 bool m_stepNameHasBeenSet = false;
361
362 Aws::String m_action;
363 bool m_actionHasBeenSet = false;
364
365 long long m_timeoutSeconds{0};
366 bool m_timeoutSecondsHasBeenSet = false;
367
368 Aws::String m_onFailure;
369 bool m_onFailureHasBeenSet = false;
370
371 int m_maxAttempts{0};
372 bool m_maxAttemptsHasBeenSet = false;
373
374 Aws::Utils::DateTime m_executionStartTime{};
375 bool m_executionStartTimeHasBeenSet = false;
376
377 Aws::Utils::DateTime m_executionEndTime{};
378 bool m_executionEndTimeHasBeenSet = false;
379
381 bool m_stepStatusHasBeenSet = false;
382
383 Aws::String m_responseCode;
384 bool m_responseCodeHasBeenSet = false;
385
387 bool m_inputsHasBeenSet = false;
388
390 bool m_outputsHasBeenSet = false;
391
392 Aws::String m_response;
393 bool m_responseHasBeenSet = false;
394
395 Aws::String m_failureMessage;
396 bool m_failureMessageHasBeenSet = false;
397
398 FailureDetails m_failureDetails;
399 bool m_failureDetailsHasBeenSet = false;
400
401 Aws::String m_stepExecutionId;
402 bool m_stepExecutionIdHasBeenSet = false;
403
405 bool m_overriddenParametersHasBeenSet = false;
406
407 bool m_isEnd{false};
408 bool m_isEndHasBeenSet = false;
409
410 Aws::String m_nextStep;
411 bool m_nextStepHasBeenSet = false;
412
413 bool m_isCritical{false};
414 bool m_isCriticalHasBeenSet = false;
415
416 Aws::Vector<Aws::String> m_validNextSteps;
417 bool m_validNextStepsHasBeenSet = false;
418
419 Aws::Vector<Target> m_targets;
420 bool m_targetsHasBeenSet = false;
421
422 TargetLocation m_targetLocation;
423 bool m_targetLocationHasBeenSet = false;
424
425 Aws::Vector<AlarmStateInformation> m_triggeredAlarms;
426 bool m_triggeredAlarmsHasBeenSet = false;
427
428 ParentStepDetails m_parentStepDetails;
429 bool m_parentStepDetailsHasBeenSet = false;
430 };
431
432} // namespace Model
433} // namespace SSM
434} // namespace Aws
void SetTargetLocation(TargetLocationT &&value)
const TargetLocation & GetTargetLocation() const
StepExecution & WithTargets(TargetsT &&value)
long long GetTimeoutSeconds() const
StepExecution & WithValidNextSteps(ValidNextStepsT &&value)
const FailureDetails & GetFailureDetails() const
void SetAction(ActionT &&value)
const Aws::String & GetOnFailure() const
const ParentStepDetails & GetParentStepDetails() const
const Aws::String & GetAction() const
StepExecution & WithIsEnd(bool value)
StepExecution & AddOverriddenParameters(OverriddenParametersKeyT &&key, OverriddenParametersValueT &&value)
StepExecution & WithParentStepDetails(ParentStepDetailsT &&value)
void SetTriggeredAlarms(TriggeredAlarmsT &&value)
StepExecution & AddValidNextSteps(ValidNextStepsT &&value)
void SetOverriddenParameters(OverriddenParametersT &&value)
AutomationExecutionStatus GetStepStatus() const
void SetValidNextSteps(ValidNextStepsT &&value)
StepExecution & WithResponse(ResponseT &&value)
StepExecution & WithAction(ActionT &&value)
const Aws::Vector< Aws::String > & GetValidNextSteps() const
StepExecution & WithStepName(StepNameT &&value)
StepExecution & WithStepExecutionId(StepExecutionIdT &&value)
StepExecution & WithExecutionEndTime(ExecutionEndTimeT &&value)
StepExecution & AddInputs(InputsKeyT &&key, InputsValueT &&value)
AWS_SSM_API StepExecution()=default
void SetFailureDetails(FailureDetailsT &&value)
void SetTimeoutSeconds(long long value)
const Aws::Vector< Target > & GetTargets() const
void SetParentStepDetails(ParentStepDetailsT &&value)
void SetResponse(ResponseT &&value)
const Aws::Map< Aws::String, Aws::String > & GetInputs() const
StepExecution & WithOnFailure(OnFailureT &&value)
const Aws::Map< Aws::String, Aws::Vector< Aws::String > > & GetOverriddenParameters() const
const Aws::String & GetResponseCode() const
StepExecution & WithMaxAttempts(int value)
const Aws::String & GetStepName() const
const Aws::String & GetNextStep() const
const Aws::String & GetResponse() const
void SetStepStatus(AutomationExecutionStatus value)
void SetResponseCode(ResponseCodeT &&value)
StepExecution & WithOutputs(OutputsT &&value)
StepExecution & WithNextStep(NextStepT &&value)
void SetExecutionStartTime(ExecutionStartTimeT &&value)
StepExecution & AddTargets(TargetsT &&value)
StepExecution & WithFailureDetails(FailureDetailsT &&value)
StepExecution & AddOutputs(OutputsKeyT &&key, OutputsValueT &&value)
StepExecution & AddTriggeredAlarms(TriggeredAlarmsT &&value)
void SetExecutionEndTime(ExecutionEndTimeT &&value)
void SetFailureMessage(FailureMessageT &&value)
const Aws::Vector< AlarmStateInformation > & GetTriggeredAlarms() const
StepExecution & WithTriggeredAlarms(TriggeredAlarmsT &&value)
StepExecution & WithFailureMessage(FailureMessageT &&value)
const Aws::Utils::DateTime & GetExecutionStartTime() const
void SetOutputs(OutputsT &&value)
StepExecution & WithInputs(InputsT &&value)
StepExecution & WithOverriddenParameters(OverriddenParametersT &&value)
void SetOnFailure(OnFailureT &&value)
StepExecution & WithResponseCode(ResponseCodeT &&value)
void SetNextStep(NextStepT &&value)
AWS_SSM_API StepExecution(Aws::Utils::Json::JsonView jsonValue)
void SetInputs(InputsT &&value)
StepExecution & WithStepStatus(AutomationExecutionStatus value)
void SetStepName(StepNameT &&value)
const Aws::Map< Aws::String, Aws::Vector< Aws::String > > & GetOutputs() const
const Aws::String & GetFailureMessage() const
StepExecution & WithTimeoutSeconds(long long value)
const Aws::String & GetStepExecutionId() const
AWS_SSM_API StepExecution & operator=(Aws::Utils::Json::JsonView jsonValue)
void SetStepExecutionId(StepExecutionIdT &&value)
AWS_SSM_API Aws::Utils::Json::JsonValue Jsonize() const
const Aws::Utils::DateTime & GetExecutionEndTime() const
StepExecution & WithExecutionStartTime(ExecutionStartTimeT &&value)
void SetTargets(TargetsT &&value)
StepExecution & WithTargetLocation(TargetLocationT &&value)
bool OverriddenParametersHasBeenSet() const
StepExecution & WithIsCritical(bool value)
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
Aws::Utils::Json::JsonValue JsonValue