AWS SDK for C++

AWS SDK for C++ Version 1.11.550

All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Loading...
Searching...
No Matches
SendCommandRequest.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/AWSVector.h>
10#include <aws/core/utils/memory/stl/AWSString.h>
11#include <aws/ssm/model/DocumentHashType.h>
12#include <aws/core/utils/memory/stl/AWSMap.h>
13#include <aws/ssm/model/NotificationConfig.h>
14#include <aws/ssm/model/CloudWatchOutputConfig.h>
15#include <aws/ssm/model/AlarmConfiguration.h>
16#include <aws/ssm/model/Target.h>
17#include <utility>
18
19namespace Aws
20{
21namespace SSM
22{
23namespace Model
24{
25
29 {
30 public:
31 AWS_SSM_API SendCommandRequest() = 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 "SendCommand"; }
38
39 AWS_SSM_API Aws::String SerializePayload() const override;
40
42
43
45
58 inline const Aws::Vector<Aws::String>& GetInstanceIds() const { return m_instanceIds; }
59 inline bool InstanceIdsHasBeenSet() const { return m_instanceIdsHasBeenSet; }
60 template<typename InstanceIdsT = Aws::Vector<Aws::String>>
61 void SetInstanceIds(InstanceIdsT&& value) { m_instanceIdsHasBeenSet = true; m_instanceIds = std::forward<InstanceIdsT>(value); }
62 template<typename InstanceIdsT = Aws::Vector<Aws::String>>
63 SendCommandRequest& WithInstanceIds(InstanceIdsT&& value) { SetInstanceIds(std::forward<InstanceIdsT>(value)); return *this;}
64 template<typename InstanceIdsT = Aws::String>
65 SendCommandRequest& AddInstanceIds(InstanceIdsT&& value) { m_instanceIdsHasBeenSet = true; m_instanceIds.emplace_back(std::forward<InstanceIdsT>(value)); return *this; }
67
69
82 inline const Aws::Vector<Target>& GetTargets() const { return m_targets; }
83 inline bool TargetsHasBeenSet() const { return m_targetsHasBeenSet; }
84 template<typename TargetsT = Aws::Vector<Target>>
85 void SetTargets(TargetsT&& value) { m_targetsHasBeenSet = true; m_targets = std::forward<TargetsT>(value); }
86 template<typename TargetsT = Aws::Vector<Target>>
87 SendCommandRequest& WithTargets(TargetsT&& value) { SetTargets(std::forward<TargetsT>(value)); return *this;}
88 template<typename TargetsT = Target>
89 SendCommandRequest& AddTargets(TargetsT&& value) { m_targetsHasBeenSet = true; m_targets.emplace_back(std::forward<TargetsT>(value)); return *this; }
91
93
104 inline const Aws::String& GetDocumentName() const { return m_documentName; }
105 inline bool DocumentNameHasBeenSet() const { return m_documentNameHasBeenSet; }
106 template<typename DocumentNameT = Aws::String>
107 void SetDocumentName(DocumentNameT&& value) { m_documentNameHasBeenSet = true; m_documentName = std::forward<DocumentNameT>(value); }
108 template<typename DocumentNameT = Aws::String>
109 SendCommandRequest& WithDocumentName(DocumentNameT&& value) { SetDocumentName(std::forward<DocumentNameT>(value)); return *this;}
111
113
122 inline const Aws::String& GetDocumentVersion() const { return m_documentVersion; }
123 inline bool DocumentVersionHasBeenSet() const { return m_documentVersionHasBeenSet; }
124 template<typename DocumentVersionT = Aws::String>
125 void SetDocumentVersion(DocumentVersionT&& value) { m_documentVersionHasBeenSet = true; m_documentVersion = std::forward<DocumentVersionT>(value); }
126 template<typename DocumentVersionT = Aws::String>
127 SendCommandRequest& WithDocumentVersion(DocumentVersionT&& value) { SetDocumentVersion(std::forward<DocumentVersionT>(value)); return *this;}
129
131
135 inline const Aws::String& GetDocumentHash() const { return m_documentHash; }
136 inline bool DocumentHashHasBeenSet() const { return m_documentHashHasBeenSet; }
137 template<typename DocumentHashT = Aws::String>
138 void SetDocumentHash(DocumentHashT&& value) { m_documentHashHasBeenSet = true; m_documentHash = std::forward<DocumentHashT>(value); }
139 template<typename DocumentHashT = Aws::String>
140 SendCommandRequest& WithDocumentHash(DocumentHashT&& value) { SetDocumentHash(std::forward<DocumentHashT>(value)); return *this;}
142
144
147 inline DocumentHashType GetDocumentHashType() const { return m_documentHashType; }
148 inline bool DocumentHashTypeHasBeenSet() const { return m_documentHashTypeHasBeenSet; }
149 inline void SetDocumentHashType(DocumentHashType value) { m_documentHashTypeHasBeenSet = true; m_documentHashType = value; }
152
154
158 inline int GetTimeoutSeconds() const { return m_timeoutSeconds; }
159 inline bool TimeoutSecondsHasBeenSet() const { return m_timeoutSecondsHasBeenSet; }
160 inline void SetTimeoutSeconds(int value) { m_timeoutSecondsHasBeenSet = true; m_timeoutSeconds = value; }
161 inline SendCommandRequest& WithTimeoutSeconds(int value) { SetTimeoutSeconds(value); return *this;}
163
165
169 inline const Aws::String& GetComment() const { return m_comment; }
170 inline bool CommentHasBeenSet() const { return m_commentHasBeenSet; }
171 template<typename CommentT = Aws::String>
172 void SetComment(CommentT&& value) { m_commentHasBeenSet = true; m_comment = std::forward<CommentT>(value); }
173 template<typename CommentT = Aws::String>
174 SendCommandRequest& WithComment(CommentT&& value) { SetComment(std::forward<CommentT>(value)); return *this;}
176
178
181 inline const Aws::Map<Aws::String, Aws::Vector<Aws::String>>& GetParameters() const { return m_parameters; }
182 inline bool ParametersHasBeenSet() const { return m_parametersHasBeenSet; }
183 template<typename ParametersT = Aws::Map<Aws::String, Aws::Vector<Aws::String>>>
184 void SetParameters(ParametersT&& value) { m_parametersHasBeenSet = true; m_parameters = std::forward<ParametersT>(value); }
185 template<typename ParametersT = Aws::Map<Aws::String, Aws::Vector<Aws::String>>>
186 SendCommandRequest& WithParameters(ParametersT&& value) { SetParameters(std::forward<ParametersT>(value)); return *this;}
187 template<typename ParametersKeyT = Aws::String, typename ParametersValueT = Aws::Vector<Aws::String>>
188 SendCommandRequest& AddParameters(ParametersKeyT&& key, ParametersValueT&& value) {
189 m_parametersHasBeenSet = true; m_parameters.emplace(std::forward<ParametersKeyT>(key), std::forward<ParametersValueT>(value)); return *this;
190 }
192
194
199 inline const Aws::String& GetOutputS3Region() const { return m_outputS3Region; }
200 inline bool OutputS3RegionHasBeenSet() const { return m_outputS3RegionHasBeenSet; }
201 template<typename OutputS3RegionT = Aws::String>
202 void SetOutputS3Region(OutputS3RegionT&& value) { m_outputS3RegionHasBeenSet = true; m_outputS3Region = std::forward<OutputS3RegionT>(value); }
203 template<typename OutputS3RegionT = Aws::String>
204 SendCommandRequest& WithOutputS3Region(OutputS3RegionT&& value) { SetOutputS3Region(std::forward<OutputS3RegionT>(value)); return *this;}
206
208
212 inline const Aws::String& GetOutputS3BucketName() const { return m_outputS3BucketName; }
213 inline bool OutputS3BucketNameHasBeenSet() const { return m_outputS3BucketNameHasBeenSet; }
214 template<typename OutputS3BucketNameT = Aws::String>
215 void SetOutputS3BucketName(OutputS3BucketNameT&& value) { m_outputS3BucketNameHasBeenSet = true; m_outputS3BucketName = std::forward<OutputS3BucketNameT>(value); }
216 template<typename OutputS3BucketNameT = Aws::String>
217 SendCommandRequest& WithOutputS3BucketName(OutputS3BucketNameT&& value) { SetOutputS3BucketName(std::forward<OutputS3BucketNameT>(value)); return *this;}
219
221
225 inline const Aws::String& GetOutputS3KeyPrefix() const { return m_outputS3KeyPrefix; }
226 inline bool OutputS3KeyPrefixHasBeenSet() const { return m_outputS3KeyPrefixHasBeenSet; }
227 template<typename OutputS3KeyPrefixT = Aws::String>
228 void SetOutputS3KeyPrefix(OutputS3KeyPrefixT&& value) { m_outputS3KeyPrefixHasBeenSet = true; m_outputS3KeyPrefix = std::forward<OutputS3KeyPrefixT>(value); }
229 template<typename OutputS3KeyPrefixT = Aws::String>
230 SendCommandRequest& WithOutputS3KeyPrefix(OutputS3KeyPrefixT&& value) { SetOutputS3KeyPrefix(std::forward<OutputS3KeyPrefixT>(value)); return *this;}
232
234
243 inline const Aws::String& GetMaxConcurrency() const { return m_maxConcurrency; }
244 inline bool MaxConcurrencyHasBeenSet() const { return m_maxConcurrencyHasBeenSet; }
245 template<typename MaxConcurrencyT = Aws::String>
246 void SetMaxConcurrency(MaxConcurrencyT&& value) { m_maxConcurrencyHasBeenSet = true; m_maxConcurrency = std::forward<MaxConcurrencyT>(value); }
247 template<typename MaxConcurrencyT = Aws::String>
248 SendCommandRequest& WithMaxConcurrency(MaxConcurrencyT&& value) { SetMaxConcurrency(std::forward<MaxConcurrencyT>(value)); return *this;}
250
252
262 inline const Aws::String& GetMaxErrors() const { return m_maxErrors; }
263 inline bool MaxErrorsHasBeenSet() const { return m_maxErrorsHasBeenSet; }
264 template<typename MaxErrorsT = Aws::String>
265 void SetMaxErrors(MaxErrorsT&& value) { m_maxErrorsHasBeenSet = true; m_maxErrors = std::forward<MaxErrorsT>(value); }
266 template<typename MaxErrorsT = Aws::String>
267 SendCommandRequest& WithMaxErrors(MaxErrorsT&& value) { SetMaxErrors(std::forward<MaxErrorsT>(value)); return *this;}
269
271
281 inline const Aws::String& GetServiceRoleArn() const { return m_serviceRoleArn; }
282 inline bool ServiceRoleArnHasBeenSet() const { return m_serviceRoleArnHasBeenSet; }
283 template<typename ServiceRoleArnT = Aws::String>
284 void SetServiceRoleArn(ServiceRoleArnT&& value) { m_serviceRoleArnHasBeenSet = true; m_serviceRoleArn = std::forward<ServiceRoleArnT>(value); }
285 template<typename ServiceRoleArnT = Aws::String>
286 SendCommandRequest& WithServiceRoleArn(ServiceRoleArnT&& value) { SetServiceRoleArn(std::forward<ServiceRoleArnT>(value)); return *this;}
288
290
293 inline const NotificationConfig& GetNotificationConfig() const { return m_notificationConfig; }
294 inline bool NotificationConfigHasBeenSet() const { return m_notificationConfigHasBeenSet; }
295 template<typename NotificationConfigT = NotificationConfig>
296 void SetNotificationConfig(NotificationConfigT&& value) { m_notificationConfigHasBeenSet = true; m_notificationConfig = std::forward<NotificationConfigT>(value); }
297 template<typename NotificationConfigT = NotificationConfig>
298 SendCommandRequest& WithNotificationConfig(NotificationConfigT&& value) { SetNotificationConfig(std::forward<NotificationConfigT>(value)); return *this;}
300
302
307 inline const CloudWatchOutputConfig& GetCloudWatchOutputConfig() const { return m_cloudWatchOutputConfig; }
308 inline bool CloudWatchOutputConfigHasBeenSet() const { return m_cloudWatchOutputConfigHasBeenSet; }
309 template<typename CloudWatchOutputConfigT = CloudWatchOutputConfig>
310 void SetCloudWatchOutputConfig(CloudWatchOutputConfigT&& value) { m_cloudWatchOutputConfigHasBeenSet = true; m_cloudWatchOutputConfig = std::forward<CloudWatchOutputConfigT>(value); }
311 template<typename CloudWatchOutputConfigT = CloudWatchOutputConfig>
312 SendCommandRequest& WithCloudWatchOutputConfig(CloudWatchOutputConfigT&& value) { SetCloudWatchOutputConfig(std::forward<CloudWatchOutputConfigT>(value)); return *this;}
314
316
319 inline const AlarmConfiguration& GetAlarmConfiguration() const { return m_alarmConfiguration; }
320 inline bool AlarmConfigurationHasBeenSet() const { return m_alarmConfigurationHasBeenSet; }
321 template<typename AlarmConfigurationT = AlarmConfiguration>
322 void SetAlarmConfiguration(AlarmConfigurationT&& value) { m_alarmConfigurationHasBeenSet = true; m_alarmConfiguration = std::forward<AlarmConfigurationT>(value); }
323 template<typename AlarmConfigurationT = AlarmConfiguration>
324 SendCommandRequest& WithAlarmConfiguration(AlarmConfigurationT&& value) { SetAlarmConfiguration(std::forward<AlarmConfigurationT>(value)); return *this;}
326 private:
327
328 Aws::Vector<Aws::String> m_instanceIds;
329 bool m_instanceIdsHasBeenSet = false;
330
331 Aws::Vector<Target> m_targets;
332 bool m_targetsHasBeenSet = false;
333
334 Aws::String m_documentName;
335 bool m_documentNameHasBeenSet = false;
336
337 Aws::String m_documentVersion;
338 bool m_documentVersionHasBeenSet = false;
339
340 Aws::String m_documentHash;
341 bool m_documentHashHasBeenSet = false;
342
344 bool m_documentHashTypeHasBeenSet = false;
345
346 int m_timeoutSeconds{0};
347 bool m_timeoutSecondsHasBeenSet = false;
348
349 Aws::String m_comment;
350 bool m_commentHasBeenSet = false;
351
353 bool m_parametersHasBeenSet = false;
354
355 Aws::String m_outputS3Region;
356 bool m_outputS3RegionHasBeenSet = false;
357
358 Aws::String m_outputS3BucketName;
359 bool m_outputS3BucketNameHasBeenSet = false;
360
361 Aws::String m_outputS3KeyPrefix;
362 bool m_outputS3KeyPrefixHasBeenSet = false;
363
364 Aws::String m_maxConcurrency;
365 bool m_maxConcurrencyHasBeenSet = false;
366
367 Aws::String m_maxErrors;
368 bool m_maxErrorsHasBeenSet = false;
369
370 Aws::String m_serviceRoleArn;
371 bool m_serviceRoleArnHasBeenSet = false;
372
373 NotificationConfig m_notificationConfig;
374 bool m_notificationConfigHasBeenSet = false;
375
376 CloudWatchOutputConfig m_cloudWatchOutputConfig;
377 bool m_cloudWatchOutputConfigHasBeenSet = false;
378
379 AlarmConfiguration m_alarmConfiguration;
380 bool m_alarmConfigurationHasBeenSet = false;
381 };
382
383} // namespace Model
384} // namespace SSM
385} // namespace Aws
DocumentHashType GetDocumentHashType() const
SendCommandRequest & WithComment(CommentT &&value)
SendCommandRequest & WithDocumentName(DocumentNameT &&value)
void SetParameters(ParametersT &&value)
SendCommandRequest & WithServiceRoleArn(ServiceRoleArnT &&value)
SendCommandRequest & WithOutputS3Region(OutputS3RegionT &&value)
void SetAlarmConfiguration(AlarmConfigurationT &&value)
void SetDocumentHash(DocumentHashT &&value)
const Aws::String & GetServiceRoleArn() const
const Aws::Vector< Target > & GetTargets() const
const Aws::String & GetOutputS3Region() const
const AlarmConfiguration & GetAlarmConfiguration() const
void SetCloudWatchOutputConfig(CloudWatchOutputConfigT &&value)
void SetOutputS3BucketName(OutputS3BucketNameT &&value)
const Aws::String & GetOutputS3KeyPrefix() const
const Aws::String & GetComment() const
void SetDocumentVersion(DocumentVersionT &&value)
const Aws::String & GetMaxErrors() const
void SetOutputS3KeyPrefix(OutputS3KeyPrefixT &&value)
SendCommandRequest & AddTargets(TargetsT &&value)
void SetDocumentName(DocumentNameT &&value)
void SetNotificationConfig(NotificationConfigT &&value)
AWS_SSM_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
const Aws::Map< Aws::String, Aws::Vector< Aws::String > > & GetParameters() const
void SetOutputS3Region(OutputS3RegionT &&value)
void SetDocumentHashType(DocumentHashType value)
SendCommandRequest & WithTimeoutSeconds(int value)
const NotificationConfig & GetNotificationConfig() const
SendCommandRequest & WithAlarmConfiguration(AlarmConfigurationT &&value)
const Aws::String & GetDocumentName() const
const Aws::String & GetMaxConcurrency() const
AWS_SSM_API Aws::String SerializePayload() const override
SendCommandRequest & WithMaxErrors(MaxErrorsT &&value)
void SetInstanceIds(InstanceIdsT &&value)
const Aws::String & GetDocumentHash() const
void SetMaxConcurrency(MaxConcurrencyT &&value)
SendCommandRequest & WithCloudWatchOutputConfig(CloudWatchOutputConfigT &&value)
const Aws::String & GetDocumentVersion() const
SendCommandRequest & WithDocumentVersion(DocumentVersionT &&value)
SendCommandRequest & WithInstanceIds(InstanceIdsT &&value)
SendCommandRequest & WithParameters(ParametersT &&value)
void SetServiceRoleArn(ServiceRoleArnT &&value)
const Aws::Vector< Aws::String > & GetInstanceIds() const
const CloudWatchOutputConfig & GetCloudWatchOutputConfig() const
SendCommandRequest & WithDocumentHashType(DocumentHashType value)
SendCommandRequest & WithDocumentHash(DocumentHashT &&value)
SendCommandRequest & WithNotificationConfig(NotificationConfigT &&value)
SendCommandRequest & WithOutputS3KeyPrefix(OutputS3KeyPrefixT &&value)
SendCommandRequest & AddInstanceIds(InstanceIdsT &&value)
const Aws::String & GetOutputS3BucketName() const
SendCommandRequest & WithTargets(TargetsT &&value)
SendCommandRequest & WithOutputS3BucketName(OutputS3BucketNameT &&value)
virtual const char * GetServiceRequestName() const override
AWS_SSM_API SendCommandRequest()=default
SendCommandRequest & AddParameters(ParametersKeyT &&key, ParametersValueT &&value)
SendCommandRequest & WithMaxConcurrency(MaxConcurrencyT &&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