AWS SDK for C++

AWS SDK for C++ Version 1.11.907

Loading...
Searching...
No Matches
UpdateServerRequest.h
1
6#pragma once
7#include <aws/awstransfer/TransferRequest.h>
8#include <aws/awstransfer/Transfer_EXPORTS.h>
9#include <aws/awstransfer/model/EndpointDetails.h>
10#include <aws/awstransfer/model/EndpointType.h>
11#include <aws/awstransfer/model/IdentityProviderDetails.h>
12#include <aws/awstransfer/model/IdentityProviderType.h>
13#include <aws/awstransfer/model/IpAddressType.h>
14#include <aws/awstransfer/model/Protocol.h>
15#include <aws/awstransfer/model/ProtocolDetails.h>
16#include <aws/awstransfer/model/S3StorageOptions.h>
17#include <aws/awstransfer/model/WorkflowDetails.h>
18#include <aws/core/utils/memory/stl/AWSString.h>
19#include <aws/core/utils/memory/stl/AWSVector.h>
20
21#include <utility>
22
23namespace Aws {
24namespace Transfer {
25namespace Model {
26
30 public:
31 AWS_TRANSFER_API UpdateServerRequest() = 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 "UpdateServer"; }
38
39 AWS_TRANSFER_API Aws::String SerializePayload() const override;
40
42
44
66 inline const Aws::String& GetCertificate() const { return m_certificate; }
67 inline bool CertificateHasBeenSet() const { return m_certificateHasBeenSet; }
68 template <typename CertificateT = Aws::String>
69 void SetCertificate(CertificateT&& value) {
70 m_certificateHasBeenSet = true;
71 m_certificate = std::forward<CertificateT>(value);
72 }
73 template <typename CertificateT = Aws::String>
74 UpdateServerRequest& WithCertificate(CertificateT&& value) {
75 SetCertificate(std::forward<CertificateT>(value));
76 return *this;
77 }
79
81
107 inline const ProtocolDetails& GetProtocolDetails() const { return m_protocolDetails; }
108 inline bool ProtocolDetailsHasBeenSet() const { return m_protocolDetailsHasBeenSet; }
109 template <typename ProtocolDetailsT = ProtocolDetails>
110 void SetProtocolDetails(ProtocolDetailsT&& value) {
111 m_protocolDetailsHasBeenSet = true;
112 m_protocolDetails = std::forward<ProtocolDetailsT>(value);
113 }
114 template <typename ProtocolDetailsT = ProtocolDetails>
115 UpdateServerRequest& WithProtocolDetails(ProtocolDetailsT&& value) {
116 SetProtocolDetails(std::forward<ProtocolDetailsT>(value));
117 return *this;
118 }
120
122
130 inline const EndpointDetails& GetEndpointDetails() const { return m_endpointDetails; }
131 inline bool EndpointDetailsHasBeenSet() const { return m_endpointDetailsHasBeenSet; }
132 template <typename EndpointDetailsT = EndpointDetails>
133 void SetEndpointDetails(EndpointDetailsT&& value) {
134 m_endpointDetailsHasBeenSet = true;
135 m_endpointDetails = std::forward<EndpointDetailsT>(value);
136 }
137 template <typename EndpointDetailsT = EndpointDetails>
138 UpdateServerRequest& WithEndpointDetails(EndpointDetailsT&& value) {
139 SetEndpointDetails(std::forward<EndpointDetailsT>(value));
140 return *this;
141 }
143
145
166 inline EndpointType GetEndpointType() const { return m_endpointType; }
167 inline bool EndpointTypeHasBeenSet() const { return m_endpointTypeHasBeenSet; }
168 inline void SetEndpointType(EndpointType value) {
169 m_endpointTypeHasBeenSet = true;
170 m_endpointType = value;
171 }
173 SetEndpointType(value);
174 return *this;
175 }
177
179
200 inline const Aws::String& GetHostKey() const { return m_hostKey; }
201 inline bool HostKeyHasBeenSet() const { return m_hostKeyHasBeenSet; }
202 template <typename HostKeyT = Aws::String>
203 void SetHostKey(HostKeyT&& value) {
204 m_hostKeyHasBeenSet = true;
205 m_hostKey = std::forward<HostKeyT>(value);
206 }
207 template <typename HostKeyT = Aws::String>
208 UpdateServerRequest& WithHostKey(HostKeyT&& value) {
209 SetHostKey(std::forward<HostKeyT>(value));
210 return *this;
211 }
213
215
219 inline const IdentityProviderDetails& GetIdentityProviderDetails() const { return m_identityProviderDetails; }
220 inline bool IdentityProviderDetailsHasBeenSet() const { return m_identityProviderDetailsHasBeenSet; }
221 template <typename IdentityProviderDetailsT = IdentityProviderDetails>
222 void SetIdentityProviderDetails(IdentityProviderDetailsT&& value) {
223 m_identityProviderDetailsHasBeenSet = true;
224 m_identityProviderDetails = std::forward<IdentityProviderDetailsT>(value);
225 }
226 template <typename IdentityProviderDetailsT = IdentityProviderDetails>
227 UpdateServerRequest& WithIdentityProviderDetails(IdentityProviderDetailsT&& value) {
228 SetIdentityProviderDetails(std::forward<IdentityProviderDetailsT>(value));
229 return *this;
230 }
232
234
240 inline const Aws::String& GetLoggingRole() const { return m_loggingRole; }
241 inline bool LoggingRoleHasBeenSet() const { return m_loggingRoleHasBeenSet; }
242 template <typename LoggingRoleT = Aws::String>
243 void SetLoggingRole(LoggingRoleT&& value) {
244 m_loggingRoleHasBeenSet = true;
245 m_loggingRole = std::forward<LoggingRoleT>(value);
246 }
247 template <typename LoggingRoleT = Aws::String>
248 UpdateServerRequest& WithLoggingRole(LoggingRoleT&& value) {
249 SetLoggingRole(std::forward<LoggingRoleT>(value));
250 return *this;
251 }
253
255
260 inline const Aws::String& GetPostAuthenticationLoginBanner() const { return m_postAuthenticationLoginBanner; }
261 inline bool PostAuthenticationLoginBannerHasBeenSet() const { return m_postAuthenticationLoginBannerHasBeenSet; }
262 template <typename PostAuthenticationLoginBannerT = Aws::String>
263 void SetPostAuthenticationLoginBanner(PostAuthenticationLoginBannerT&& value) {
264 m_postAuthenticationLoginBannerHasBeenSet = true;
265 m_postAuthenticationLoginBanner = std::forward<PostAuthenticationLoginBannerT>(value);
266 }
267 template <typename PostAuthenticationLoginBannerT = Aws::String>
268 UpdateServerRequest& WithPostAuthenticationLoginBanner(PostAuthenticationLoginBannerT&& value) {
269 SetPostAuthenticationLoginBanner(std::forward<PostAuthenticationLoginBannerT>(value));
270 return *this;
271 }
273
275
284 inline const Aws::String& GetPreAuthenticationLoginBanner() const { return m_preAuthenticationLoginBanner; }
285 inline bool PreAuthenticationLoginBannerHasBeenSet() const { return m_preAuthenticationLoginBannerHasBeenSet; }
286 template <typename PreAuthenticationLoginBannerT = Aws::String>
287 void SetPreAuthenticationLoginBanner(PreAuthenticationLoginBannerT&& value) {
288 m_preAuthenticationLoginBannerHasBeenSet = true;
289 m_preAuthenticationLoginBanner = std::forward<PreAuthenticationLoginBannerT>(value);
290 }
291 template <typename PreAuthenticationLoginBannerT = Aws::String>
292 UpdateServerRequest& WithPreAuthenticationLoginBanner(PreAuthenticationLoginBannerT&& value) {
293 SetPreAuthenticationLoginBanner(std::forward<PreAuthenticationLoginBannerT>(value));
294 return *this;
295 }
297
299
326 inline const Aws::Vector<Protocol>& GetProtocols() const { return m_protocols; }
327 inline bool ProtocolsHasBeenSet() const { return m_protocolsHasBeenSet; }
328 template <typename ProtocolsT = Aws::Vector<Protocol>>
329 void SetProtocols(ProtocolsT&& value) {
330 m_protocolsHasBeenSet = true;
331 m_protocols = std::forward<ProtocolsT>(value);
332 }
333 template <typename ProtocolsT = Aws::Vector<Protocol>>
334 UpdateServerRequest& WithProtocols(ProtocolsT&& value) {
335 SetProtocols(std::forward<ProtocolsT>(value));
336 return *this;
337 }
339 m_protocolsHasBeenSet = true;
340 m_protocols.push_back(value);
341 return *this;
342 }
344
346
349 inline const Aws::String& GetSecurityPolicyName() const { return m_securityPolicyName; }
350 inline bool SecurityPolicyNameHasBeenSet() const { return m_securityPolicyNameHasBeenSet; }
351 template <typename SecurityPolicyNameT = Aws::String>
352 void SetSecurityPolicyName(SecurityPolicyNameT&& value) {
353 m_securityPolicyNameHasBeenSet = true;
354 m_securityPolicyName = std::forward<SecurityPolicyNameT>(value);
355 }
356 template <typename SecurityPolicyNameT = Aws::String>
357 UpdateServerRequest& WithSecurityPolicyName(SecurityPolicyNameT&& value) {
358 SetSecurityPolicyName(std::forward<SecurityPolicyNameT>(value));
359 return *this;
360 }
362
364
368 inline const Aws::String& GetServerId() const { return m_serverId; }
369 inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; }
370 template <typename ServerIdT = Aws::String>
371 void SetServerId(ServerIdT&& value) {
372 m_serverIdHasBeenSet = true;
373 m_serverId = std::forward<ServerIdT>(value);
374 }
375 template <typename ServerIdT = Aws::String>
376 UpdateServerRequest& WithServerId(ServerIdT&& value) {
377 SetServerId(std::forward<ServerIdT>(value));
378 return *this;
379 }
381
383
394 inline const WorkflowDetails& GetWorkflowDetails() const { return m_workflowDetails; }
395 inline bool WorkflowDetailsHasBeenSet() const { return m_workflowDetailsHasBeenSet; }
396 template <typename WorkflowDetailsT = WorkflowDetails>
397 void SetWorkflowDetails(WorkflowDetailsT&& value) {
398 m_workflowDetailsHasBeenSet = true;
399 m_workflowDetails = std::forward<WorkflowDetailsT>(value);
400 }
401 template <typename WorkflowDetailsT = WorkflowDetails>
402 UpdateServerRequest& WithWorkflowDetails(WorkflowDetailsT&& value) {
403 SetWorkflowDetails(std::forward<WorkflowDetailsT>(value));
404 return *this;
405 }
407
409
422 inline const Aws::Vector<Aws::String>& GetStructuredLogDestinations() const { return m_structuredLogDestinations; }
423 inline bool StructuredLogDestinationsHasBeenSet() const { return m_structuredLogDestinationsHasBeenSet; }
424 template <typename StructuredLogDestinationsT = Aws::Vector<Aws::String>>
425 void SetStructuredLogDestinations(StructuredLogDestinationsT&& value) {
426 m_structuredLogDestinationsHasBeenSet = true;
427 m_structuredLogDestinations = std::forward<StructuredLogDestinationsT>(value);
428 }
429 template <typename StructuredLogDestinationsT = Aws::Vector<Aws::String>>
430 UpdateServerRequest& WithStructuredLogDestinations(StructuredLogDestinationsT&& value) {
431 SetStructuredLogDestinations(std::forward<StructuredLogDestinationsT>(value));
432 return *this;
433 }
434 template <typename StructuredLogDestinationsT = Aws::String>
435 UpdateServerRequest& AddStructuredLogDestinations(StructuredLogDestinationsT&& value) {
436 m_structuredLogDestinationsHasBeenSet = true;
437 m_structuredLogDestinations.emplace_back(std::forward<StructuredLogDestinationsT>(value));
438 return *this;
439 }
441
443
453 inline const S3StorageOptions& GetS3StorageOptions() const { return m_s3StorageOptions; }
454 inline bool S3StorageOptionsHasBeenSet() const { return m_s3StorageOptionsHasBeenSet; }
455 template <typename S3StorageOptionsT = S3StorageOptions>
456 void SetS3StorageOptions(S3StorageOptionsT&& value) {
457 m_s3StorageOptionsHasBeenSet = true;
458 m_s3StorageOptions = std::forward<S3StorageOptionsT>(value);
459 }
460 template <typename S3StorageOptionsT = S3StorageOptions>
461 UpdateServerRequest& WithS3StorageOptions(S3StorageOptionsT&& value) {
462 SetS3StorageOptions(std::forward<S3StorageOptionsT>(value));
463 return *this;
464 }
466
468
481 inline IpAddressType GetIpAddressType() const { return m_ipAddressType; }
482 inline bool IpAddressTypeHasBeenSet() const { return m_ipAddressTypeHasBeenSet; }
483 inline void SetIpAddressType(IpAddressType value) {
484 m_ipAddressTypeHasBeenSet = true;
485 m_ipAddressType = value;
486 }
488 SetIpAddressType(value);
489 return *this;
490 }
492
494
512 inline IdentityProviderType GetIdentityProviderType() const { return m_identityProviderType; }
513 inline bool IdentityProviderTypeHasBeenSet() const { return m_identityProviderTypeHasBeenSet; }
515 m_identityProviderTypeHasBeenSet = true;
516 m_identityProviderType = value;
517 }
520 return *this;
521 }
523 private:
524 Aws::String m_certificate;
525
526 ProtocolDetails m_protocolDetails;
527
528 EndpointDetails m_endpointDetails;
529
530 EndpointType m_endpointType{EndpointType::NOT_SET};
531
532 Aws::String m_hostKey;
533
534 IdentityProviderDetails m_identityProviderDetails;
535
536 Aws::String m_loggingRole;
537
538 Aws::String m_postAuthenticationLoginBanner;
539
540 Aws::String m_preAuthenticationLoginBanner;
541
542 Aws::Vector<Protocol> m_protocols;
543
544 Aws::String m_securityPolicyName;
545
546 Aws::String m_serverId;
547
548 WorkflowDetails m_workflowDetails;
549
550 Aws::Vector<Aws::String> m_structuredLogDestinations;
551
552 S3StorageOptions m_s3StorageOptions;
553
554 IpAddressType m_ipAddressType{IpAddressType::NOT_SET};
555
557 bool m_certificateHasBeenSet = false;
558 bool m_protocolDetailsHasBeenSet = false;
559 bool m_endpointDetailsHasBeenSet = false;
560 bool m_endpointTypeHasBeenSet = false;
561 bool m_hostKeyHasBeenSet = false;
562 bool m_identityProviderDetailsHasBeenSet = false;
563 bool m_loggingRoleHasBeenSet = false;
564 bool m_postAuthenticationLoginBannerHasBeenSet = false;
565 bool m_preAuthenticationLoginBannerHasBeenSet = false;
566 bool m_protocolsHasBeenSet = false;
567 bool m_securityPolicyNameHasBeenSet = false;
568 bool m_serverIdHasBeenSet = false;
569 bool m_workflowDetailsHasBeenSet = false;
570 bool m_structuredLogDestinationsHasBeenSet = false;
571 bool m_s3StorageOptionsHasBeenSet = false;
572 bool m_ipAddressTypeHasBeenSet = false;
573 bool m_identityProviderTypeHasBeenSet = false;
574};
575
576} // namespace Model
577} // namespace Transfer
578} // namespace Aws
AWS_TRANSFER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
const Aws::Vector< Protocol > & GetProtocols() const
void SetPostAuthenticationLoginBanner(PostAuthenticationLoginBannerT &&value)
IdentityProviderType GetIdentityProviderType() const
UpdateServerRequest & WithProtocols(ProtocolsT &&value)
const Aws::Vector< Aws::String > & GetStructuredLogDestinations() const
UpdateServerRequest & AddProtocols(Protocol value)
const Aws::String & GetPreAuthenticationLoginBanner() const
UpdateServerRequest & WithServerId(ServerIdT &&value)
void SetEndpointDetails(EndpointDetailsT &&value)
void SetStructuredLogDestinations(StructuredLogDestinationsT &&value)
void SetIdentityProviderType(IdentityProviderType value)
const ProtocolDetails & GetProtocolDetails() const
void SetPreAuthenticationLoginBanner(PreAuthenticationLoginBannerT &&value)
UpdateServerRequest & WithSecurityPolicyName(SecurityPolicyNameT &&value)
void SetS3StorageOptions(S3StorageOptionsT &&value)
UpdateServerRequest & AddStructuredLogDestinations(StructuredLogDestinationsT &&value)
const Aws::String & GetPostAuthenticationLoginBanner() const
UpdateServerRequest & WithIpAddressType(IpAddressType value)
void SetIdentityProviderDetails(IdentityProviderDetailsT &&value)
AWS_TRANSFER_API UpdateServerRequest()=default
UpdateServerRequest & WithS3StorageOptions(S3StorageOptionsT &&value)
const WorkflowDetails & GetWorkflowDetails() const
UpdateServerRequest & WithPostAuthenticationLoginBanner(PostAuthenticationLoginBannerT &&value)
const Aws::String & GetSecurityPolicyName() const
virtual const char * GetServiceRequestName() const override
const S3StorageOptions & GetS3StorageOptions() const
void SetSecurityPolicyName(SecurityPolicyNameT &&value)
UpdateServerRequest & WithCertificate(CertificateT &&value)
AWS_TRANSFER_API Aws::String SerializePayload() const override
UpdateServerRequest & WithLoggingRole(LoggingRoleT &&value)
UpdateServerRequest & WithWorkflowDetails(WorkflowDetailsT &&value)
UpdateServerRequest & WithIdentityProviderType(IdentityProviderType value)
void SetProtocolDetails(ProtocolDetailsT &&value)
UpdateServerRequest & WithIdentityProviderDetails(IdentityProviderDetailsT &&value)
UpdateServerRequest & WithEndpointDetails(EndpointDetailsT &&value)
UpdateServerRequest & WithProtocolDetails(ProtocolDetailsT &&value)
UpdateServerRequest & WithHostKey(HostKeyT &&value)
UpdateServerRequest & WithEndpointType(EndpointType value)
const IdentityProviderDetails & GetIdentityProviderDetails() const
void SetWorkflowDetails(WorkflowDetailsT &&value)
UpdateServerRequest & WithPreAuthenticationLoginBanner(PreAuthenticationLoginBannerT &&value)
const EndpointDetails & GetEndpointDetails() const
UpdateServerRequest & WithStructuredLogDestinations(StructuredLogDestinationsT &&value)
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