AWS SDK for C++

AWS SDK for C++ Version 1.11.688

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
105 inline const ProtocolDetails& GetProtocolDetails() const { return m_protocolDetails; }
106 inline bool ProtocolDetailsHasBeenSet() const { return m_protocolDetailsHasBeenSet; }
107 template <typename ProtocolDetailsT = ProtocolDetails>
108 void SetProtocolDetails(ProtocolDetailsT&& value) {
109 m_protocolDetailsHasBeenSet = true;
110 m_protocolDetails = std::forward<ProtocolDetailsT>(value);
111 }
112 template <typename ProtocolDetailsT = ProtocolDetails>
113 UpdateServerRequest& WithProtocolDetails(ProtocolDetailsT&& value) {
114 SetProtocolDetails(std::forward<ProtocolDetailsT>(value));
115 return *this;
116 }
118
120
128 inline const EndpointDetails& GetEndpointDetails() const { return m_endpointDetails; }
129 inline bool EndpointDetailsHasBeenSet() const { return m_endpointDetailsHasBeenSet; }
130 template <typename EndpointDetailsT = EndpointDetails>
131 void SetEndpointDetails(EndpointDetailsT&& value) {
132 m_endpointDetailsHasBeenSet = true;
133 m_endpointDetails = std::forward<EndpointDetailsT>(value);
134 }
135 template <typename EndpointDetailsT = EndpointDetails>
136 UpdateServerRequest& WithEndpointDetails(EndpointDetailsT&& value) {
137 SetEndpointDetails(std::forward<EndpointDetailsT>(value));
138 return *this;
139 }
141
143
164 inline EndpointType GetEndpointType() const { return m_endpointType; }
165 inline bool EndpointTypeHasBeenSet() const { return m_endpointTypeHasBeenSet; }
166 inline void SetEndpointType(EndpointType value) {
167 m_endpointTypeHasBeenSet = true;
168 m_endpointType = value;
169 }
171 SetEndpointType(value);
172 return *this;
173 }
175
177
198 inline const Aws::String& GetHostKey() const { return m_hostKey; }
199 inline bool HostKeyHasBeenSet() const { return m_hostKeyHasBeenSet; }
200 template <typename HostKeyT = Aws::String>
201 void SetHostKey(HostKeyT&& value) {
202 m_hostKeyHasBeenSet = true;
203 m_hostKey = std::forward<HostKeyT>(value);
204 }
205 template <typename HostKeyT = Aws::String>
206 UpdateServerRequest& WithHostKey(HostKeyT&& value) {
207 SetHostKey(std::forward<HostKeyT>(value));
208 return *this;
209 }
211
213
217 inline const IdentityProviderDetails& GetIdentityProviderDetails() const { return m_identityProviderDetails; }
218 inline bool IdentityProviderDetailsHasBeenSet() const { return m_identityProviderDetailsHasBeenSet; }
219 template <typename IdentityProviderDetailsT = IdentityProviderDetails>
220 void SetIdentityProviderDetails(IdentityProviderDetailsT&& value) {
221 m_identityProviderDetailsHasBeenSet = true;
222 m_identityProviderDetails = std::forward<IdentityProviderDetailsT>(value);
223 }
224 template <typename IdentityProviderDetailsT = IdentityProviderDetails>
225 UpdateServerRequest& WithIdentityProviderDetails(IdentityProviderDetailsT&& value) {
226 SetIdentityProviderDetails(std::forward<IdentityProviderDetailsT>(value));
227 return *this;
228 }
230
232
238 inline const Aws::String& GetLoggingRole() const { return m_loggingRole; }
239 inline bool LoggingRoleHasBeenSet() const { return m_loggingRoleHasBeenSet; }
240 template <typename LoggingRoleT = Aws::String>
241 void SetLoggingRole(LoggingRoleT&& value) {
242 m_loggingRoleHasBeenSet = true;
243 m_loggingRole = std::forward<LoggingRoleT>(value);
244 }
245 template <typename LoggingRoleT = Aws::String>
246 UpdateServerRequest& WithLoggingRole(LoggingRoleT&& value) {
247 SetLoggingRole(std::forward<LoggingRoleT>(value));
248 return *this;
249 }
251
253
258 inline const Aws::String& GetPostAuthenticationLoginBanner() const { return m_postAuthenticationLoginBanner; }
259 inline bool PostAuthenticationLoginBannerHasBeenSet() const { return m_postAuthenticationLoginBannerHasBeenSet; }
260 template <typename PostAuthenticationLoginBannerT = Aws::String>
261 void SetPostAuthenticationLoginBanner(PostAuthenticationLoginBannerT&& value) {
262 m_postAuthenticationLoginBannerHasBeenSet = true;
263 m_postAuthenticationLoginBanner = std::forward<PostAuthenticationLoginBannerT>(value);
264 }
265 template <typename PostAuthenticationLoginBannerT = Aws::String>
266 UpdateServerRequest& WithPostAuthenticationLoginBanner(PostAuthenticationLoginBannerT&& value) {
267 SetPostAuthenticationLoginBanner(std::forward<PostAuthenticationLoginBannerT>(value));
268 return *this;
269 }
271
273
282 inline const Aws::String& GetPreAuthenticationLoginBanner() const { return m_preAuthenticationLoginBanner; }
283 inline bool PreAuthenticationLoginBannerHasBeenSet() const { return m_preAuthenticationLoginBannerHasBeenSet; }
284 template <typename PreAuthenticationLoginBannerT = Aws::String>
285 void SetPreAuthenticationLoginBanner(PreAuthenticationLoginBannerT&& value) {
286 m_preAuthenticationLoginBannerHasBeenSet = true;
287 m_preAuthenticationLoginBanner = std::forward<PreAuthenticationLoginBannerT>(value);
288 }
289 template <typename PreAuthenticationLoginBannerT = Aws::String>
290 UpdateServerRequest& WithPreAuthenticationLoginBanner(PreAuthenticationLoginBannerT&& value) {
291 SetPreAuthenticationLoginBanner(std::forward<PreAuthenticationLoginBannerT>(value));
292 return *this;
293 }
295
297
324 inline const Aws::Vector<Protocol>& GetProtocols() const { return m_protocols; }
325 inline bool ProtocolsHasBeenSet() const { return m_protocolsHasBeenSet; }
326 template <typename ProtocolsT = Aws::Vector<Protocol>>
327 void SetProtocols(ProtocolsT&& value) {
328 m_protocolsHasBeenSet = true;
329 m_protocols = std::forward<ProtocolsT>(value);
330 }
331 template <typename ProtocolsT = Aws::Vector<Protocol>>
332 UpdateServerRequest& WithProtocols(ProtocolsT&& value) {
333 SetProtocols(std::forward<ProtocolsT>(value));
334 return *this;
335 }
337 m_protocolsHasBeenSet = true;
338 m_protocols.push_back(value);
339 return *this;
340 }
342
344
347 inline const Aws::String& GetSecurityPolicyName() const { return m_securityPolicyName; }
348 inline bool SecurityPolicyNameHasBeenSet() const { return m_securityPolicyNameHasBeenSet; }
349 template <typename SecurityPolicyNameT = Aws::String>
350 void SetSecurityPolicyName(SecurityPolicyNameT&& value) {
351 m_securityPolicyNameHasBeenSet = true;
352 m_securityPolicyName = std::forward<SecurityPolicyNameT>(value);
353 }
354 template <typename SecurityPolicyNameT = Aws::String>
355 UpdateServerRequest& WithSecurityPolicyName(SecurityPolicyNameT&& value) {
356 SetSecurityPolicyName(std::forward<SecurityPolicyNameT>(value));
357 return *this;
358 }
360
362
366 inline const Aws::String& GetServerId() const { return m_serverId; }
367 inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; }
368 template <typename ServerIdT = Aws::String>
369 void SetServerId(ServerIdT&& value) {
370 m_serverIdHasBeenSet = true;
371 m_serverId = std::forward<ServerIdT>(value);
372 }
373 template <typename ServerIdT = Aws::String>
374 UpdateServerRequest& WithServerId(ServerIdT&& value) {
375 SetServerId(std::forward<ServerIdT>(value));
376 return *this;
377 }
379
381
392 inline const WorkflowDetails& GetWorkflowDetails() const { return m_workflowDetails; }
393 inline bool WorkflowDetailsHasBeenSet() const { return m_workflowDetailsHasBeenSet; }
394 template <typename WorkflowDetailsT = WorkflowDetails>
395 void SetWorkflowDetails(WorkflowDetailsT&& value) {
396 m_workflowDetailsHasBeenSet = true;
397 m_workflowDetails = std::forward<WorkflowDetailsT>(value);
398 }
399 template <typename WorkflowDetailsT = WorkflowDetails>
400 UpdateServerRequest& WithWorkflowDetails(WorkflowDetailsT&& value) {
401 SetWorkflowDetails(std::forward<WorkflowDetailsT>(value));
402 return *this;
403 }
405
407
420 inline const Aws::Vector<Aws::String>& GetStructuredLogDestinations() const { return m_structuredLogDestinations; }
421 inline bool StructuredLogDestinationsHasBeenSet() const { return m_structuredLogDestinationsHasBeenSet; }
422 template <typename StructuredLogDestinationsT = Aws::Vector<Aws::String>>
423 void SetStructuredLogDestinations(StructuredLogDestinationsT&& value) {
424 m_structuredLogDestinationsHasBeenSet = true;
425 m_structuredLogDestinations = std::forward<StructuredLogDestinationsT>(value);
426 }
427 template <typename StructuredLogDestinationsT = Aws::Vector<Aws::String>>
428 UpdateServerRequest& WithStructuredLogDestinations(StructuredLogDestinationsT&& value) {
429 SetStructuredLogDestinations(std::forward<StructuredLogDestinationsT>(value));
430 return *this;
431 }
432 template <typename StructuredLogDestinationsT = Aws::String>
433 UpdateServerRequest& AddStructuredLogDestinations(StructuredLogDestinationsT&& value) {
434 m_structuredLogDestinationsHasBeenSet = true;
435 m_structuredLogDestinations.emplace_back(std::forward<StructuredLogDestinationsT>(value));
436 return *this;
437 }
439
441
451 inline const S3StorageOptions& GetS3StorageOptions() const { return m_s3StorageOptions; }
452 inline bool S3StorageOptionsHasBeenSet() const { return m_s3StorageOptionsHasBeenSet; }
453 template <typename S3StorageOptionsT = S3StorageOptions>
454 void SetS3StorageOptions(S3StorageOptionsT&& value) {
455 m_s3StorageOptionsHasBeenSet = true;
456 m_s3StorageOptions = std::forward<S3StorageOptionsT>(value);
457 }
458 template <typename S3StorageOptionsT = S3StorageOptions>
459 UpdateServerRequest& WithS3StorageOptions(S3StorageOptionsT&& value) {
460 SetS3StorageOptions(std::forward<S3StorageOptionsT>(value));
461 return *this;
462 }
464
466
479 inline IpAddressType GetIpAddressType() const { return m_ipAddressType; }
480 inline bool IpAddressTypeHasBeenSet() const { return m_ipAddressTypeHasBeenSet; }
481 inline void SetIpAddressType(IpAddressType value) {
482 m_ipAddressTypeHasBeenSet = true;
483 m_ipAddressType = value;
484 }
486 SetIpAddressType(value);
487 return *this;
488 }
490
492
510 inline IdentityProviderType GetIdentityProviderType() const { return m_identityProviderType; }
511 inline bool IdentityProviderTypeHasBeenSet() const { return m_identityProviderTypeHasBeenSet; }
513 m_identityProviderTypeHasBeenSet = true;
514 m_identityProviderType = value;
515 }
518 return *this;
519 }
521 private:
522 Aws::String m_certificate;
523 bool m_certificateHasBeenSet = false;
524
525 ProtocolDetails m_protocolDetails;
526 bool m_protocolDetailsHasBeenSet = false;
527
528 EndpointDetails m_endpointDetails;
529 bool m_endpointDetailsHasBeenSet = false;
530
531 EndpointType m_endpointType{EndpointType::NOT_SET};
532 bool m_endpointTypeHasBeenSet = false;
533
534 Aws::String m_hostKey;
535 bool m_hostKeyHasBeenSet = false;
536
537 IdentityProviderDetails m_identityProviderDetails;
538 bool m_identityProviderDetailsHasBeenSet = false;
539
540 Aws::String m_loggingRole;
541 bool m_loggingRoleHasBeenSet = false;
542
543 Aws::String m_postAuthenticationLoginBanner;
544 bool m_postAuthenticationLoginBannerHasBeenSet = false;
545
546 Aws::String m_preAuthenticationLoginBanner;
547 bool m_preAuthenticationLoginBannerHasBeenSet = false;
548
549 Aws::Vector<Protocol> m_protocols;
550 bool m_protocolsHasBeenSet = false;
551
552 Aws::String m_securityPolicyName;
553 bool m_securityPolicyNameHasBeenSet = false;
554
555 Aws::String m_serverId;
556 bool m_serverIdHasBeenSet = false;
557
558 WorkflowDetails m_workflowDetails;
559 bool m_workflowDetailsHasBeenSet = false;
560
561 Aws::Vector<Aws::String> m_structuredLogDestinations;
562 bool m_structuredLogDestinationsHasBeenSet = false;
563
564 S3StorageOptions m_s3StorageOptions;
565 bool m_s3StorageOptionsHasBeenSet = false;
566
567 IpAddressType m_ipAddressType{IpAddressType::NOT_SET};
568 bool m_ipAddressTypeHasBeenSet = false;
569
571 bool m_identityProviderTypeHasBeenSet = false;
572};
573
574} // namespace Model
575} // namespace Transfer
576} // 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