AWS SDK for C++

AWS SDK for C++ Version 1.11.929

Loading...
Searching...
No Matches
CreateServerRequest.h
1
6#pragma once
7#include <aws/awstransfer/TransferRequest.h>
8#include <aws/awstransfer/Transfer_EXPORTS.h>
9#include <aws/awstransfer/model/Domain.h>
10#include <aws/awstransfer/model/EndpointDetails.h>
11#include <aws/awstransfer/model/EndpointType.h>
12#include <aws/awstransfer/model/HostKeyStorageType.h>
13#include <aws/awstransfer/model/IdentityProviderDetails.h>
14#include <aws/awstransfer/model/IdentityProviderType.h>
15#include <aws/awstransfer/model/IpAddressType.h>
16#include <aws/awstransfer/model/Protocol.h>
17#include <aws/awstransfer/model/ProtocolDetails.h>
18#include <aws/awstransfer/model/S3StorageOptions.h>
19#include <aws/awstransfer/model/Tag.h>
20#include <aws/awstransfer/model/WorkflowDetails.h>
21#include <aws/core/utils/memory/stl/AWSString.h>
22#include <aws/core/utils/memory/stl/AWSVector.h>
23
24#include <utility>
25
26namespace Aws {
27namespace Transfer {
28namespace Model {
29
33 public:
34 AWS_TRANSFER_API CreateServerRequest() = default;
35
36 // Service request name is the Operation name which will send this request out,
37 // each operation should has unique request name, so that we can get operation's name from this request.
38 // Note: this is not true for response, multiple operations may have the same response name,
39 // so we can not get operation's name from response.
40 inline virtual const char* GetServiceRequestName() const override { return "CreateServer"; }
41
42 AWS_TRANSFER_API Aws::String SerializePayload() const override;
43
45
47
69 inline const Aws::String& GetCertificate() const { return m_certificate; }
70 inline bool CertificateHasBeenSet() const { return m_certificateHasBeenSet; }
71 template <typename CertificateT = Aws::String>
72 void SetCertificate(CertificateT&& value) {
73 m_certificateHasBeenSet = true;
74 m_certificate = std::forward<CertificateT>(value);
75 }
76 template <typename CertificateT = Aws::String>
77 CreateServerRequest& WithCertificate(CertificateT&& value) {
78 SetCertificate(std::forward<CertificateT>(value));
79 return *this;
80 }
82
84
90 inline Domain GetDomain() const { return m_domain; }
91 inline bool DomainHasBeenSet() const { return m_domainHasBeenSet; }
92 inline void SetDomain(Domain value) {
93 m_domainHasBeenSet = true;
94 m_domain = value;
95 }
97 SetDomain(value);
98 return *this;
99 }
101
103
111 inline const EndpointDetails& GetEndpointDetails() const { return m_endpointDetails; }
112 inline bool EndpointDetailsHasBeenSet() const { return m_endpointDetailsHasBeenSet; }
113 template <typename EndpointDetailsT = EndpointDetails>
114 void SetEndpointDetails(EndpointDetailsT&& value) {
115 m_endpointDetailsHasBeenSet = true;
116 m_endpointDetails = std::forward<EndpointDetailsT>(value);
117 }
118 template <typename EndpointDetailsT = EndpointDetails>
119 CreateServerRequest& WithEndpointDetails(EndpointDetailsT&& value) {
120 SetEndpointDetails(std::forward<EndpointDetailsT>(value));
121 return *this;
122 }
124
126
147 inline EndpointType GetEndpointType() const { return m_endpointType; }
148 inline bool EndpointTypeHasBeenSet() const { return m_endpointTypeHasBeenSet; }
149 inline void SetEndpointType(EndpointType value) {
150 m_endpointTypeHasBeenSet = true;
151 m_endpointType = value;
152 }
154 SetEndpointType(value);
155 return *this;
156 }
158
160
181 inline const Aws::String& GetHostKey() const { return m_hostKey; }
182 inline bool HostKeyHasBeenSet() const { return m_hostKeyHasBeenSet; }
183 template <typename HostKeyT = Aws::String>
184 void SetHostKey(HostKeyT&& value) {
185 m_hostKeyHasBeenSet = true;
186 m_hostKey = std::forward<HostKeyT>(value);
187 }
188 template <typename HostKeyT = Aws::String>
189 CreateServerRequest& WithHostKey(HostKeyT&& value) {
190 SetHostKey(std::forward<HostKeyT>(value));
191 return *this;
192 }
194
196
205 inline const IdentityProviderDetails& GetIdentityProviderDetails() const { return m_identityProviderDetails; }
206 inline bool IdentityProviderDetailsHasBeenSet() const { return m_identityProviderDetailsHasBeenSet; }
207 template <typename IdentityProviderDetailsT = IdentityProviderDetails>
208 void SetIdentityProviderDetails(IdentityProviderDetailsT&& value) {
209 m_identityProviderDetailsHasBeenSet = true;
210 m_identityProviderDetails = std::forward<IdentityProviderDetailsT>(value);
211 }
212 template <typename IdentityProviderDetailsT = IdentityProviderDetails>
213 CreateServerRequest& WithIdentityProviderDetails(IdentityProviderDetailsT&& value) {
214 SetIdentityProviderDetails(std::forward<IdentityProviderDetailsT>(value));
215 return *this;
216 }
218
220
238 inline IdentityProviderType GetIdentityProviderType() const { return m_identityProviderType; }
239 inline bool IdentityProviderTypeHasBeenSet() const { return m_identityProviderTypeHasBeenSet; }
241 m_identityProviderTypeHasBeenSet = true;
242 m_identityProviderType = value;
243 }
249
251
257 inline const Aws::String& GetLoggingRole() const { return m_loggingRole; }
258 inline bool LoggingRoleHasBeenSet() const { return m_loggingRoleHasBeenSet; }
259 template <typename LoggingRoleT = Aws::String>
260 void SetLoggingRole(LoggingRoleT&& value) {
261 m_loggingRoleHasBeenSet = true;
262 m_loggingRole = std::forward<LoggingRoleT>(value);
263 }
264 template <typename LoggingRoleT = Aws::String>
265 CreateServerRequest& WithLoggingRole(LoggingRoleT&& value) {
266 SetLoggingRole(std::forward<LoggingRoleT>(value));
267 return *this;
268 }
270
272
277 inline const Aws::String& GetPostAuthenticationLoginBanner() const { return m_postAuthenticationLoginBanner; }
278 inline bool PostAuthenticationLoginBannerHasBeenSet() const { return m_postAuthenticationLoginBannerHasBeenSet; }
279 template <typename PostAuthenticationLoginBannerT = Aws::String>
280 void SetPostAuthenticationLoginBanner(PostAuthenticationLoginBannerT&& value) {
281 m_postAuthenticationLoginBannerHasBeenSet = true;
282 m_postAuthenticationLoginBanner = std::forward<PostAuthenticationLoginBannerT>(value);
283 }
284 template <typename PostAuthenticationLoginBannerT = Aws::String>
285 CreateServerRequest& WithPostAuthenticationLoginBanner(PostAuthenticationLoginBannerT&& value) {
286 SetPostAuthenticationLoginBanner(std::forward<PostAuthenticationLoginBannerT>(value));
287 return *this;
288 }
290
292
301 inline const Aws::String& GetPreAuthenticationLoginBanner() const { return m_preAuthenticationLoginBanner; }
302 inline bool PreAuthenticationLoginBannerHasBeenSet() const { return m_preAuthenticationLoginBannerHasBeenSet; }
303 template <typename PreAuthenticationLoginBannerT = Aws::String>
304 void SetPreAuthenticationLoginBanner(PreAuthenticationLoginBannerT&& value) {
305 m_preAuthenticationLoginBannerHasBeenSet = true;
306 m_preAuthenticationLoginBanner = std::forward<PreAuthenticationLoginBannerT>(value);
307 }
308 template <typename PreAuthenticationLoginBannerT = Aws::String>
309 CreateServerRequest& WithPreAuthenticationLoginBanner(PreAuthenticationLoginBannerT&& value) {
310 SetPreAuthenticationLoginBanner(std::forward<PreAuthenticationLoginBannerT>(value));
311 return *this;
312 }
314
316
343 inline const Aws::Vector<Protocol>& GetProtocols() const { return m_protocols; }
344 inline bool ProtocolsHasBeenSet() const { return m_protocolsHasBeenSet; }
345 template <typename ProtocolsT = Aws::Vector<Protocol>>
346 void SetProtocols(ProtocolsT&& value) {
347 m_protocolsHasBeenSet = true;
348 m_protocols = std::forward<ProtocolsT>(value);
349 }
350 template <typename ProtocolsT = Aws::Vector<Protocol>>
351 CreateServerRequest& WithProtocols(ProtocolsT&& value) {
352 SetProtocols(std::forward<ProtocolsT>(value));
353 return *this;
354 }
356 m_protocolsHasBeenSet = true;
357 m_protocols.push_back(value);
358 return *this;
359 }
361
363
389 inline const ProtocolDetails& GetProtocolDetails() const { return m_protocolDetails; }
390 inline bool ProtocolDetailsHasBeenSet() const { return m_protocolDetailsHasBeenSet; }
391 template <typename ProtocolDetailsT = ProtocolDetails>
392 void SetProtocolDetails(ProtocolDetailsT&& value) {
393 m_protocolDetailsHasBeenSet = true;
394 m_protocolDetails = std::forward<ProtocolDetailsT>(value);
395 }
396 template <typename ProtocolDetailsT = ProtocolDetails>
397 CreateServerRequest& WithProtocolDetails(ProtocolDetailsT&& value) {
398 SetProtocolDetails(std::forward<ProtocolDetailsT>(value));
399 return *this;
400 }
402
404
407 inline const Aws::String& GetSecurityPolicyName() const { return m_securityPolicyName; }
408 inline bool SecurityPolicyNameHasBeenSet() const { return m_securityPolicyNameHasBeenSet; }
409 template <typename SecurityPolicyNameT = Aws::String>
410 void SetSecurityPolicyName(SecurityPolicyNameT&& value) {
411 m_securityPolicyNameHasBeenSet = true;
412 m_securityPolicyName = std::forward<SecurityPolicyNameT>(value);
413 }
414 template <typename SecurityPolicyNameT = Aws::String>
415 CreateServerRequest& WithSecurityPolicyName(SecurityPolicyNameT&& value) {
416 SetSecurityPolicyName(std::forward<SecurityPolicyNameT>(value));
417 return *this;
418 }
420
422
425 inline const Aws::Vector<Tag>& GetTags() const { return m_tags; }
426 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
427 template <typename TagsT = Aws::Vector<Tag>>
428 void SetTags(TagsT&& value) {
429 m_tagsHasBeenSet = true;
430 m_tags = std::forward<TagsT>(value);
431 }
432 template <typename TagsT = Aws::Vector<Tag>>
434 SetTags(std::forward<TagsT>(value));
435 return *this;
436 }
437 template <typename TagsT = Tag>
438 CreateServerRequest& AddTags(TagsT&& value) {
439 m_tagsHasBeenSet = true;
440 m_tags.emplace_back(std::forward<TagsT>(value));
441 return *this;
442 }
444
446
454 inline const WorkflowDetails& GetWorkflowDetails() const { return m_workflowDetails; }
455 inline bool WorkflowDetailsHasBeenSet() const { return m_workflowDetailsHasBeenSet; }
456 template <typename WorkflowDetailsT = WorkflowDetails>
457 void SetWorkflowDetails(WorkflowDetailsT&& value) {
458 m_workflowDetailsHasBeenSet = true;
459 m_workflowDetails = std::forward<WorkflowDetailsT>(value);
460 }
461 template <typename WorkflowDetailsT = WorkflowDetails>
462 CreateServerRequest& WithWorkflowDetails(WorkflowDetailsT&& value) {
463 SetWorkflowDetails(std::forward<WorkflowDetailsT>(value));
464 return *this;
465 }
467
469
482 inline const Aws::Vector<Aws::String>& GetStructuredLogDestinations() const { return m_structuredLogDestinations; }
483 inline bool StructuredLogDestinationsHasBeenSet() const { return m_structuredLogDestinationsHasBeenSet; }
484 template <typename StructuredLogDestinationsT = Aws::Vector<Aws::String>>
485 void SetStructuredLogDestinations(StructuredLogDestinationsT&& value) {
486 m_structuredLogDestinationsHasBeenSet = true;
487 m_structuredLogDestinations = std::forward<StructuredLogDestinationsT>(value);
488 }
489 template <typename StructuredLogDestinationsT = Aws::Vector<Aws::String>>
490 CreateServerRequest& WithStructuredLogDestinations(StructuredLogDestinationsT&& value) {
491 SetStructuredLogDestinations(std::forward<StructuredLogDestinationsT>(value));
492 return *this;
493 }
494 template <typename StructuredLogDestinationsT = Aws::String>
495 CreateServerRequest& AddStructuredLogDestinations(StructuredLogDestinationsT&& value) {
496 m_structuredLogDestinationsHasBeenSet = true;
497 m_structuredLogDestinations.emplace_back(std::forward<StructuredLogDestinationsT>(value));
498 return *this;
499 }
501
503
513 inline const S3StorageOptions& GetS3StorageOptions() const { return m_s3StorageOptions; }
514 inline bool S3StorageOptionsHasBeenSet() const { return m_s3StorageOptionsHasBeenSet; }
515 template <typename S3StorageOptionsT = S3StorageOptions>
516 void SetS3StorageOptions(S3StorageOptionsT&& value) {
517 m_s3StorageOptionsHasBeenSet = true;
518 m_s3StorageOptions = std::forward<S3StorageOptionsT>(value);
519 }
520 template <typename S3StorageOptionsT = S3StorageOptions>
521 CreateServerRequest& WithS3StorageOptions(S3StorageOptionsT&& value) {
522 SetS3StorageOptions(std::forward<S3StorageOptionsT>(value));
523 return *this;
524 }
526
528
541 inline IpAddressType GetIpAddressType() const { return m_ipAddressType; }
542 inline bool IpAddressTypeHasBeenSet() const { return m_ipAddressTypeHasBeenSet; }
543 inline void SetIpAddressType(IpAddressType value) {
544 m_ipAddressTypeHasBeenSet = true;
545 m_ipAddressType = value;
546 }
548 SetIpAddressType(value);
549 return *this;
550 }
552
554
561 inline HostKeyStorageType GetHostKeyStorageType() const { return m_hostKeyStorageType; }
562 inline bool HostKeyStorageTypeHasBeenSet() const { return m_hostKeyStorageTypeHasBeenSet; }
564 m_hostKeyStorageTypeHasBeenSet = true;
565 m_hostKeyStorageType = value;
566 }
569 return *this;
570 }
572 private:
573 Aws::String m_certificate;
574
575 Domain m_domain{Domain::NOT_SET};
576
577 EndpointDetails m_endpointDetails;
578
579 EndpointType m_endpointType{EndpointType::NOT_SET};
580
581 Aws::String m_hostKey;
582
583 IdentityProviderDetails m_identityProviderDetails;
584
586
587 Aws::String m_loggingRole;
588
589 Aws::String m_postAuthenticationLoginBanner;
590
591 Aws::String m_preAuthenticationLoginBanner;
592
593 Aws::Vector<Protocol> m_protocols;
594
595 ProtocolDetails m_protocolDetails;
596
597 Aws::String m_securityPolicyName;
598
599 Aws::Vector<Tag> m_tags;
600
601 WorkflowDetails m_workflowDetails;
602
603 Aws::Vector<Aws::String> m_structuredLogDestinations;
604
605 S3StorageOptions m_s3StorageOptions;
606
607 IpAddressType m_ipAddressType{IpAddressType::NOT_SET};
608
610 bool m_certificateHasBeenSet = false;
611 bool m_domainHasBeenSet = false;
612 bool m_endpointDetailsHasBeenSet = false;
613 bool m_endpointTypeHasBeenSet = false;
614 bool m_hostKeyHasBeenSet = false;
615 bool m_identityProviderDetailsHasBeenSet = false;
616 bool m_identityProviderTypeHasBeenSet = false;
617 bool m_loggingRoleHasBeenSet = false;
618 bool m_postAuthenticationLoginBannerHasBeenSet = false;
619 bool m_preAuthenticationLoginBannerHasBeenSet = false;
620 bool m_protocolsHasBeenSet = false;
621 bool m_protocolDetailsHasBeenSet = false;
622 bool m_securityPolicyNameHasBeenSet = false;
623 bool m_tagsHasBeenSet = false;
624 bool m_workflowDetailsHasBeenSet = false;
625 bool m_structuredLogDestinationsHasBeenSet = false;
626 bool m_s3StorageOptionsHasBeenSet = false;
627 bool m_ipAddressTypeHasBeenSet = false;
628 bool m_hostKeyStorageTypeHasBeenSet = false;
629};
630
631} // namespace Model
632} // namespace Transfer
633} // namespace Aws
CreateServerRequest & WithProtocols(ProtocolsT &&value)
CreateServerRequest & WithPreAuthenticationLoginBanner(PreAuthenticationLoginBannerT &&value)
CreateServerRequest & WithLoggingRole(LoggingRoleT &&value)
const Aws::Vector< Aws::String > & GetStructuredLogDestinations() const
CreateServerRequest & AddTags(TagsT &&value)
CreateServerRequest & WithTags(TagsT &&value)
const IdentityProviderDetails & GetIdentityProviderDetails() const
virtual const char * GetServiceRequestName() const override
CreateServerRequest & WithCertificate(CertificateT &&value)
void SetEndpointDetails(EndpointDetailsT &&value)
CreateServerRequest & WithIdentityProviderType(IdentityProviderType value)
const Aws::String & GetPreAuthenticationLoginBanner() const
void SetProtocolDetails(ProtocolDetailsT &&value)
const Aws::Vector< Protocol > & GetProtocols() const
void SetWorkflowDetails(WorkflowDetailsT &&value)
CreateServerRequest & WithEndpointType(EndpointType value)
void SetIdentityProviderType(IdentityProviderType value)
AWS_TRANSFER_API Aws::String SerializePayload() const override
void SetPostAuthenticationLoginBanner(PostAuthenticationLoginBannerT &&value)
IdentityProviderType GetIdentityProviderType() const
CreateServerRequest & WithDomain(Domain value)
const S3StorageOptions & GetS3StorageOptions() const
const EndpointDetails & GetEndpointDetails() const
void SetIdentityProviderDetails(IdentityProviderDetailsT &&value)
CreateServerRequest & WithHostKey(HostKeyT &&value)
CreateServerRequest & WithPostAuthenticationLoginBanner(PostAuthenticationLoginBannerT &&value)
const Aws::Vector< Tag > & GetTags() const
CreateServerRequest & WithSecurityPolicyName(SecurityPolicyNameT &&value)
void SetStructuredLogDestinations(StructuredLogDestinationsT &&value)
CreateServerRequest & WithIpAddressType(IpAddressType value)
const ProtocolDetails & GetProtocolDetails() const
CreateServerRequest & WithWorkflowDetails(WorkflowDetailsT &&value)
const Aws::String & GetSecurityPolicyName() const
CreateServerRequest & WithEndpointDetails(EndpointDetailsT &&value)
CreateServerRequest & WithProtocolDetails(ProtocolDetailsT &&value)
CreateServerRequest & WithS3StorageOptions(S3StorageOptionsT &&value)
void SetPreAuthenticationLoginBanner(PreAuthenticationLoginBannerT &&value)
const Aws::String & GetPostAuthenticationLoginBanner() const
CreateServerRequest & AddProtocols(Protocol value)
AWS_TRANSFER_API CreateServerRequest()=default
void SetS3StorageOptions(S3StorageOptionsT &&value)
void SetHostKeyStorageType(HostKeyStorageType value)
CreateServerRequest & WithIdentityProviderDetails(IdentityProviderDetailsT &&value)
CreateServerRequest & WithStructuredLogDestinations(StructuredLogDestinationsT &&value)
AWS_TRANSFER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
CreateServerRequest & AddStructuredLogDestinations(StructuredLogDestinationsT &&value)
CreateServerRequest & WithHostKeyStorageType(HostKeyStorageType value)
void SetSecurityPolicyName(SecurityPolicyNameT &&value)
const WorkflowDetails & GetWorkflowDetails() const
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