AWS SDK for C++

AWS SDK for C++ Version 1.11.689

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/IdentityProviderDetails.h>
13#include <aws/awstransfer/model/IdentityProviderType.h>
14#include <aws/awstransfer/model/IpAddressType.h>
15#include <aws/awstransfer/model/Protocol.h>
16#include <aws/awstransfer/model/ProtocolDetails.h>
17#include <aws/awstransfer/model/S3StorageOptions.h>
18#include <aws/awstransfer/model/Tag.h>
19#include <aws/awstransfer/model/WorkflowDetails.h>
20#include <aws/core/utils/memory/stl/AWSString.h>
21#include <aws/core/utils/memory/stl/AWSVector.h>
22
23#include <utility>
24
25namespace Aws {
26namespace Transfer {
27namespace Model {
28
32 public:
33 AWS_TRANSFER_API CreateServerRequest() = default;
34
35 // Service request name is the Operation name which will send this request out,
36 // each operation should has unique request name, so that we can get operation's name from this request.
37 // Note: this is not true for response, multiple operations may have the same response name,
38 // so we can not get operation's name from response.
39 inline virtual const char* GetServiceRequestName() const override { return "CreateServer"; }
40
41 AWS_TRANSFER_API Aws::String SerializePayload() const override;
42
44
46
68 inline const Aws::String& GetCertificate() const { return m_certificate; }
69 inline bool CertificateHasBeenSet() const { return m_certificateHasBeenSet; }
70 template <typename CertificateT = Aws::String>
71 void SetCertificate(CertificateT&& value) {
72 m_certificateHasBeenSet = true;
73 m_certificate = std::forward<CertificateT>(value);
74 }
75 template <typename CertificateT = Aws::String>
76 CreateServerRequest& WithCertificate(CertificateT&& value) {
77 SetCertificate(std::forward<CertificateT>(value));
78 return *this;
79 }
81
83
89 inline Domain GetDomain() const { return m_domain; }
90 inline bool DomainHasBeenSet() const { return m_domainHasBeenSet; }
91 inline void SetDomain(Domain value) {
92 m_domainHasBeenSet = true;
93 m_domain = value;
94 }
96 SetDomain(value);
97 return *this;
98 }
100
102
110 inline const EndpointDetails& GetEndpointDetails() const { return m_endpointDetails; }
111 inline bool EndpointDetailsHasBeenSet() const { return m_endpointDetailsHasBeenSet; }
112 template <typename EndpointDetailsT = EndpointDetails>
113 void SetEndpointDetails(EndpointDetailsT&& value) {
114 m_endpointDetailsHasBeenSet = true;
115 m_endpointDetails = std::forward<EndpointDetailsT>(value);
116 }
117 template <typename EndpointDetailsT = EndpointDetails>
118 CreateServerRequest& WithEndpointDetails(EndpointDetailsT&& value) {
119 SetEndpointDetails(std::forward<EndpointDetailsT>(value));
120 return *this;
121 }
123
125
146 inline EndpointType GetEndpointType() const { return m_endpointType; }
147 inline bool EndpointTypeHasBeenSet() const { return m_endpointTypeHasBeenSet; }
148 inline void SetEndpointType(EndpointType value) {
149 m_endpointTypeHasBeenSet = true;
150 m_endpointType = value;
151 }
153 SetEndpointType(value);
154 return *this;
155 }
157
159
180 inline const Aws::String& GetHostKey() const { return m_hostKey; }
181 inline bool HostKeyHasBeenSet() const { return m_hostKeyHasBeenSet; }
182 template <typename HostKeyT = Aws::String>
183 void SetHostKey(HostKeyT&& value) {
184 m_hostKeyHasBeenSet = true;
185 m_hostKey = std::forward<HostKeyT>(value);
186 }
187 template <typename HostKeyT = Aws::String>
188 CreateServerRequest& WithHostKey(HostKeyT&& value) {
189 SetHostKey(std::forward<HostKeyT>(value));
190 return *this;
191 }
193
195
204 inline const IdentityProviderDetails& GetIdentityProviderDetails() const { return m_identityProviderDetails; }
205 inline bool IdentityProviderDetailsHasBeenSet() const { return m_identityProviderDetailsHasBeenSet; }
206 template <typename IdentityProviderDetailsT = IdentityProviderDetails>
207 void SetIdentityProviderDetails(IdentityProviderDetailsT&& value) {
208 m_identityProviderDetailsHasBeenSet = true;
209 m_identityProviderDetails = std::forward<IdentityProviderDetailsT>(value);
210 }
211 template <typename IdentityProviderDetailsT = IdentityProviderDetails>
212 CreateServerRequest& WithIdentityProviderDetails(IdentityProviderDetailsT&& value) {
213 SetIdentityProviderDetails(std::forward<IdentityProviderDetailsT>(value));
214 return *this;
215 }
217
219
237 inline IdentityProviderType GetIdentityProviderType() const { return m_identityProviderType; }
238 inline bool IdentityProviderTypeHasBeenSet() const { return m_identityProviderTypeHasBeenSet; }
240 m_identityProviderTypeHasBeenSet = true;
241 m_identityProviderType = value;
242 }
245 return *this;
246 }
248
250
256 inline const Aws::String& GetLoggingRole() const { return m_loggingRole; }
257 inline bool LoggingRoleHasBeenSet() const { return m_loggingRoleHasBeenSet; }
258 template <typename LoggingRoleT = Aws::String>
259 void SetLoggingRole(LoggingRoleT&& value) {
260 m_loggingRoleHasBeenSet = true;
261 m_loggingRole = std::forward<LoggingRoleT>(value);
262 }
263 template <typename LoggingRoleT = Aws::String>
264 CreateServerRequest& WithLoggingRole(LoggingRoleT&& value) {
265 SetLoggingRole(std::forward<LoggingRoleT>(value));
266 return *this;
267 }
269
271
276 inline const Aws::String& GetPostAuthenticationLoginBanner() const { return m_postAuthenticationLoginBanner; }
277 inline bool PostAuthenticationLoginBannerHasBeenSet() const { return m_postAuthenticationLoginBannerHasBeenSet; }
278 template <typename PostAuthenticationLoginBannerT = Aws::String>
279 void SetPostAuthenticationLoginBanner(PostAuthenticationLoginBannerT&& value) {
280 m_postAuthenticationLoginBannerHasBeenSet = true;
281 m_postAuthenticationLoginBanner = std::forward<PostAuthenticationLoginBannerT>(value);
282 }
283 template <typename PostAuthenticationLoginBannerT = Aws::String>
284 CreateServerRequest& WithPostAuthenticationLoginBanner(PostAuthenticationLoginBannerT&& value) {
285 SetPostAuthenticationLoginBanner(std::forward<PostAuthenticationLoginBannerT>(value));
286 return *this;
287 }
289
291
300 inline const Aws::String& GetPreAuthenticationLoginBanner() const { return m_preAuthenticationLoginBanner; }
301 inline bool PreAuthenticationLoginBannerHasBeenSet() const { return m_preAuthenticationLoginBannerHasBeenSet; }
302 template <typename PreAuthenticationLoginBannerT = Aws::String>
303 void SetPreAuthenticationLoginBanner(PreAuthenticationLoginBannerT&& value) {
304 m_preAuthenticationLoginBannerHasBeenSet = true;
305 m_preAuthenticationLoginBanner = std::forward<PreAuthenticationLoginBannerT>(value);
306 }
307 template <typename PreAuthenticationLoginBannerT = Aws::String>
308 CreateServerRequest& WithPreAuthenticationLoginBanner(PreAuthenticationLoginBannerT&& value) {
309 SetPreAuthenticationLoginBanner(std::forward<PreAuthenticationLoginBannerT>(value));
310 return *this;
311 }
313
315
342 inline const Aws::Vector<Protocol>& GetProtocols() const { return m_protocols; }
343 inline bool ProtocolsHasBeenSet() const { return m_protocolsHasBeenSet; }
344 template <typename ProtocolsT = Aws::Vector<Protocol>>
345 void SetProtocols(ProtocolsT&& value) {
346 m_protocolsHasBeenSet = true;
347 m_protocols = std::forward<ProtocolsT>(value);
348 }
349 template <typename ProtocolsT = Aws::Vector<Protocol>>
350 CreateServerRequest& WithProtocols(ProtocolsT&& value) {
351 SetProtocols(std::forward<ProtocolsT>(value));
352 return *this;
353 }
355 m_protocolsHasBeenSet = true;
356 m_protocols.push_back(value);
357 return *this;
358 }
360
362
386 inline const ProtocolDetails& GetProtocolDetails() const { return m_protocolDetails; }
387 inline bool ProtocolDetailsHasBeenSet() const { return m_protocolDetailsHasBeenSet; }
388 template <typename ProtocolDetailsT = ProtocolDetails>
389 void SetProtocolDetails(ProtocolDetailsT&& value) {
390 m_protocolDetailsHasBeenSet = true;
391 m_protocolDetails = std::forward<ProtocolDetailsT>(value);
392 }
393 template <typename ProtocolDetailsT = ProtocolDetails>
394 CreateServerRequest& WithProtocolDetails(ProtocolDetailsT&& value) {
395 SetProtocolDetails(std::forward<ProtocolDetailsT>(value));
396 return *this;
397 }
399
401
404 inline const Aws::String& GetSecurityPolicyName() const { return m_securityPolicyName; }
405 inline bool SecurityPolicyNameHasBeenSet() const { return m_securityPolicyNameHasBeenSet; }
406 template <typename SecurityPolicyNameT = Aws::String>
407 void SetSecurityPolicyName(SecurityPolicyNameT&& value) {
408 m_securityPolicyNameHasBeenSet = true;
409 m_securityPolicyName = std::forward<SecurityPolicyNameT>(value);
410 }
411 template <typename SecurityPolicyNameT = Aws::String>
412 CreateServerRequest& WithSecurityPolicyName(SecurityPolicyNameT&& value) {
413 SetSecurityPolicyName(std::forward<SecurityPolicyNameT>(value));
414 return *this;
415 }
417
419
422 inline const Aws::Vector<Tag>& GetTags() const { return m_tags; }
423 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
424 template <typename TagsT = Aws::Vector<Tag>>
425 void SetTags(TagsT&& value) {
426 m_tagsHasBeenSet = true;
427 m_tags = std::forward<TagsT>(value);
428 }
429 template <typename TagsT = Aws::Vector<Tag>>
431 SetTags(std::forward<TagsT>(value));
432 return *this;
433 }
434 template <typename TagsT = Tag>
435 CreateServerRequest& AddTags(TagsT&& value) {
436 m_tagsHasBeenSet = true;
437 m_tags.emplace_back(std::forward<TagsT>(value));
438 return *this;
439 }
441
443
451 inline const WorkflowDetails& GetWorkflowDetails() const { return m_workflowDetails; }
452 inline bool WorkflowDetailsHasBeenSet() const { return m_workflowDetailsHasBeenSet; }
453 template <typename WorkflowDetailsT = WorkflowDetails>
454 void SetWorkflowDetails(WorkflowDetailsT&& value) {
455 m_workflowDetailsHasBeenSet = true;
456 m_workflowDetails = std::forward<WorkflowDetailsT>(value);
457 }
458 template <typename WorkflowDetailsT = WorkflowDetails>
459 CreateServerRequest& WithWorkflowDetails(WorkflowDetailsT&& value) {
460 SetWorkflowDetails(std::forward<WorkflowDetailsT>(value));
461 return *this;
462 }
464
466
479 inline const Aws::Vector<Aws::String>& GetStructuredLogDestinations() const { return m_structuredLogDestinations; }
480 inline bool StructuredLogDestinationsHasBeenSet() const { return m_structuredLogDestinationsHasBeenSet; }
481 template <typename StructuredLogDestinationsT = Aws::Vector<Aws::String>>
482 void SetStructuredLogDestinations(StructuredLogDestinationsT&& value) {
483 m_structuredLogDestinationsHasBeenSet = true;
484 m_structuredLogDestinations = std::forward<StructuredLogDestinationsT>(value);
485 }
486 template <typename StructuredLogDestinationsT = Aws::Vector<Aws::String>>
487 CreateServerRequest& WithStructuredLogDestinations(StructuredLogDestinationsT&& value) {
488 SetStructuredLogDestinations(std::forward<StructuredLogDestinationsT>(value));
489 return *this;
490 }
491 template <typename StructuredLogDestinationsT = Aws::String>
492 CreateServerRequest& AddStructuredLogDestinations(StructuredLogDestinationsT&& value) {
493 m_structuredLogDestinationsHasBeenSet = true;
494 m_structuredLogDestinations.emplace_back(std::forward<StructuredLogDestinationsT>(value));
495 return *this;
496 }
498
500
510 inline const S3StorageOptions& GetS3StorageOptions() const { return m_s3StorageOptions; }
511 inline bool S3StorageOptionsHasBeenSet() const { return m_s3StorageOptionsHasBeenSet; }
512 template <typename S3StorageOptionsT = S3StorageOptions>
513 void SetS3StorageOptions(S3StorageOptionsT&& value) {
514 m_s3StorageOptionsHasBeenSet = true;
515 m_s3StorageOptions = std::forward<S3StorageOptionsT>(value);
516 }
517 template <typename S3StorageOptionsT = S3StorageOptions>
518 CreateServerRequest& WithS3StorageOptions(S3StorageOptionsT&& value) {
519 SetS3StorageOptions(std::forward<S3StorageOptionsT>(value));
520 return *this;
521 }
523
525
538 inline IpAddressType GetIpAddressType() const { return m_ipAddressType; }
539 inline bool IpAddressTypeHasBeenSet() const { return m_ipAddressTypeHasBeenSet; }
540 inline void SetIpAddressType(IpAddressType value) {
541 m_ipAddressTypeHasBeenSet = true;
542 m_ipAddressType = value;
543 }
545 SetIpAddressType(value);
546 return *this;
547 }
549 private:
550 Aws::String m_certificate;
551 bool m_certificateHasBeenSet = false;
552
553 Domain m_domain{Domain::NOT_SET};
554 bool m_domainHasBeenSet = false;
555
556 EndpointDetails m_endpointDetails;
557 bool m_endpointDetailsHasBeenSet = false;
558
559 EndpointType m_endpointType{EndpointType::NOT_SET};
560 bool m_endpointTypeHasBeenSet = false;
561
562 Aws::String m_hostKey;
563 bool m_hostKeyHasBeenSet = false;
564
565 IdentityProviderDetails m_identityProviderDetails;
566 bool m_identityProviderDetailsHasBeenSet = false;
567
569 bool m_identityProviderTypeHasBeenSet = false;
570
571 Aws::String m_loggingRole;
572 bool m_loggingRoleHasBeenSet = false;
573
574 Aws::String m_postAuthenticationLoginBanner;
575 bool m_postAuthenticationLoginBannerHasBeenSet = false;
576
577 Aws::String m_preAuthenticationLoginBanner;
578 bool m_preAuthenticationLoginBannerHasBeenSet = false;
579
580 Aws::Vector<Protocol> m_protocols;
581 bool m_protocolsHasBeenSet = false;
582
583 ProtocolDetails m_protocolDetails;
584 bool m_protocolDetailsHasBeenSet = false;
585
586 Aws::String m_securityPolicyName;
587 bool m_securityPolicyNameHasBeenSet = false;
588
589 Aws::Vector<Tag> m_tags;
590 bool m_tagsHasBeenSet = false;
591
592 WorkflowDetails m_workflowDetails;
593 bool m_workflowDetailsHasBeenSet = false;
594
595 Aws::Vector<Aws::String> m_structuredLogDestinations;
596 bool m_structuredLogDestinationsHasBeenSet = false;
597
598 S3StorageOptions m_s3StorageOptions;
599 bool m_s3StorageOptionsHasBeenSet = false;
600
601 IpAddressType m_ipAddressType{IpAddressType::NOT_SET};
602 bool m_ipAddressTypeHasBeenSet = false;
603};
604
605} // namespace Model
606} // namespace Transfer
607} // 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)
CreateServerRequest & WithIdentityProviderDetails(IdentityProviderDetailsT &&value)
CreateServerRequest & WithStructuredLogDestinations(StructuredLogDestinationsT &&value)
AWS_TRANSFER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
CreateServerRequest & AddStructuredLogDestinations(StructuredLogDestinationsT &&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