AWS SDK for C++

AWS SDK for C++ Version 1.11.607

Loading...
Searching...
No Matches
DescribedServer.h
1
6#pragma once
7#include <aws/awstransfer/Transfer_EXPORTS.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/awstransfer/model/ProtocolDetails.h>
10#include <aws/awstransfer/model/Domain.h>
11#include <aws/awstransfer/model/EndpointDetails.h>
12#include <aws/awstransfer/model/EndpointType.h>
13#include <aws/awstransfer/model/IdentityProviderDetails.h>
14#include <aws/awstransfer/model/IdentityProviderType.h>
15#include <aws/core/utils/memory/stl/AWSVector.h>
16#include <aws/awstransfer/model/State.h>
17#include <aws/awstransfer/model/WorkflowDetails.h>
18#include <aws/awstransfer/model/S3StorageOptions.h>
19#include <aws/awstransfer/model/IpAddressType.h>
20#include <aws/awstransfer/model/Protocol.h>
21#include <aws/awstransfer/model/Tag.h>
22#include <utility>
23
24namespace Aws
25{
26namespace Utils
27{
28namespace Json
29{
30 class JsonValue;
31 class JsonView;
32} // namespace Json
33} // namespace Utils
34namespace Transfer
35{
36namespace Model
37{
38
46 {
47 public:
48 AWS_TRANSFER_API DescribedServer() = default;
49 AWS_TRANSFER_API DescribedServer(Aws::Utils::Json::JsonView jsonValue);
51 AWS_TRANSFER_API Aws::Utils::Json::JsonValue Jsonize() const;
52
53
55
58 inline const Aws::String& GetArn() const { return m_arn; }
59 inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; }
60 template<typename ArnT = Aws::String>
61 void SetArn(ArnT&& value) { m_arnHasBeenSet = true; m_arn = std::forward<ArnT>(value); }
62 template<typename ArnT = Aws::String>
63 DescribedServer& WithArn(ArnT&& value) { SetArn(std::forward<ArnT>(value)); return *this;}
65
67
72 inline const Aws::String& GetCertificate() const { return m_certificate; }
73 inline bool CertificateHasBeenSet() const { return m_certificateHasBeenSet; }
74 template<typename CertificateT = Aws::String>
75 void SetCertificate(CertificateT&& value) { m_certificateHasBeenSet = true; m_certificate = std::forward<CertificateT>(value); }
76 template<typename CertificateT = Aws::String>
77 DescribedServer& WithCertificate(CertificateT&& value) { SetCertificate(std::forward<CertificateT>(value)); return *this;}
79
81
100 inline const ProtocolDetails& GetProtocolDetails() const { return m_protocolDetails; }
101 inline bool ProtocolDetailsHasBeenSet() const { return m_protocolDetailsHasBeenSet; }
102 template<typename ProtocolDetailsT = ProtocolDetails>
103 void SetProtocolDetails(ProtocolDetailsT&& value) { m_protocolDetailsHasBeenSet = true; m_protocolDetails = std::forward<ProtocolDetailsT>(value); }
104 template<typename ProtocolDetailsT = ProtocolDetails>
105 DescribedServer& WithProtocolDetails(ProtocolDetailsT&& value) { SetProtocolDetails(std::forward<ProtocolDetailsT>(value)); return *this;}
107
109
114 inline Domain GetDomain() const { return m_domain; }
115 inline bool DomainHasBeenSet() const { return m_domainHasBeenSet; }
116 inline void SetDomain(Domain value) { m_domainHasBeenSet = true; m_domain = value; }
117 inline DescribedServer& WithDomain(Domain value) { SetDomain(value); return *this;}
119
121
129 inline const EndpointDetails& GetEndpointDetails() const { return m_endpointDetails; }
130 inline bool EndpointDetailsHasBeenSet() const { return m_endpointDetailsHasBeenSet; }
131 template<typename EndpointDetailsT = EndpointDetails>
132 void SetEndpointDetails(EndpointDetailsT&& value) { m_endpointDetailsHasBeenSet = true; m_endpointDetails = std::forward<EndpointDetailsT>(value); }
133 template<typename EndpointDetailsT = EndpointDetails>
134 DescribedServer& WithEndpointDetails(EndpointDetailsT&& value) { SetEndpointDetails(std::forward<EndpointDetailsT>(value)); return *this;}
136
138
143 inline EndpointType GetEndpointType() const { return m_endpointType; }
144 inline bool EndpointTypeHasBeenSet() const { return m_endpointTypeHasBeenSet; }
145 inline void SetEndpointType(EndpointType value) { m_endpointTypeHasBeenSet = true; m_endpointType = value; }
146 inline DescribedServer& WithEndpointType(EndpointType value) { SetEndpointType(value); return *this;}
148
150
155 inline const Aws::String& GetHostKeyFingerprint() const { return m_hostKeyFingerprint; }
156 inline bool HostKeyFingerprintHasBeenSet() const { return m_hostKeyFingerprintHasBeenSet; }
157 template<typename HostKeyFingerprintT = Aws::String>
158 void SetHostKeyFingerprint(HostKeyFingerprintT&& value) { m_hostKeyFingerprintHasBeenSet = true; m_hostKeyFingerprint = std::forward<HostKeyFingerprintT>(value); }
159 template<typename HostKeyFingerprintT = Aws::String>
160 DescribedServer& WithHostKeyFingerprint(HostKeyFingerprintT&& value) { SetHostKeyFingerprint(std::forward<HostKeyFingerprintT>(value)); return *this;}
162
164
169 inline const IdentityProviderDetails& GetIdentityProviderDetails() const { return m_identityProviderDetails; }
170 inline bool IdentityProviderDetailsHasBeenSet() const { return m_identityProviderDetailsHasBeenSet; }
171 template<typename IdentityProviderDetailsT = IdentityProviderDetails>
172 void SetIdentityProviderDetails(IdentityProviderDetailsT&& value) { m_identityProviderDetailsHasBeenSet = true; m_identityProviderDetails = std::forward<IdentityProviderDetailsT>(value); }
173 template<typename IdentityProviderDetailsT = IdentityProviderDetails>
174 DescribedServer& WithIdentityProviderDetails(IdentityProviderDetailsT&& value) { SetIdentityProviderDetails(std::forward<IdentityProviderDetailsT>(value)); return *this;}
176
178
196 inline IdentityProviderType GetIdentityProviderType() const { return m_identityProviderType; }
197 inline bool IdentityProviderTypeHasBeenSet() const { return m_identityProviderTypeHasBeenSet; }
198 inline void SetIdentityProviderType(IdentityProviderType value) { m_identityProviderTypeHasBeenSet = true; m_identityProviderType = value; }
201
203
209 inline const Aws::String& GetLoggingRole() const { return m_loggingRole; }
210 inline bool LoggingRoleHasBeenSet() const { return m_loggingRoleHasBeenSet; }
211 template<typename LoggingRoleT = Aws::String>
212 void SetLoggingRole(LoggingRoleT&& value) { m_loggingRoleHasBeenSet = true; m_loggingRole = std::forward<LoggingRoleT>(value); }
213 template<typename LoggingRoleT = Aws::String>
214 DescribedServer& WithLoggingRole(LoggingRoleT&& value) { SetLoggingRole(std::forward<LoggingRoleT>(value)); return *this;}
216
218
223 inline const Aws::String& GetPostAuthenticationLoginBanner() const { return m_postAuthenticationLoginBanner; }
224 inline bool PostAuthenticationLoginBannerHasBeenSet() const { return m_postAuthenticationLoginBannerHasBeenSet; }
225 template<typename PostAuthenticationLoginBannerT = Aws::String>
226 void SetPostAuthenticationLoginBanner(PostAuthenticationLoginBannerT&& value) { m_postAuthenticationLoginBannerHasBeenSet = true; m_postAuthenticationLoginBanner = std::forward<PostAuthenticationLoginBannerT>(value); }
227 template<typename PostAuthenticationLoginBannerT = Aws::String>
228 DescribedServer& WithPostAuthenticationLoginBanner(PostAuthenticationLoginBannerT&& value) { SetPostAuthenticationLoginBanner(std::forward<PostAuthenticationLoginBannerT>(value)); return *this;}
230
232
241 inline const Aws::String& GetPreAuthenticationLoginBanner() const { return m_preAuthenticationLoginBanner; }
242 inline bool PreAuthenticationLoginBannerHasBeenSet() const { return m_preAuthenticationLoginBannerHasBeenSet; }
243 template<typename PreAuthenticationLoginBannerT = Aws::String>
244 void SetPreAuthenticationLoginBanner(PreAuthenticationLoginBannerT&& value) { m_preAuthenticationLoginBannerHasBeenSet = true; m_preAuthenticationLoginBanner = std::forward<PreAuthenticationLoginBannerT>(value); }
245 template<typename PreAuthenticationLoginBannerT = Aws::String>
246 DescribedServer& WithPreAuthenticationLoginBanner(PreAuthenticationLoginBannerT&& value) { SetPreAuthenticationLoginBanner(std::forward<PreAuthenticationLoginBannerT>(value)); return *this;}
248
250
277 inline const Aws::Vector<Protocol>& GetProtocols() const { return m_protocols; }
278 inline bool ProtocolsHasBeenSet() const { return m_protocolsHasBeenSet; }
279 template<typename ProtocolsT = Aws::Vector<Protocol>>
280 void SetProtocols(ProtocolsT&& value) { m_protocolsHasBeenSet = true; m_protocols = std::forward<ProtocolsT>(value); }
281 template<typename ProtocolsT = Aws::Vector<Protocol>>
282 DescribedServer& WithProtocols(ProtocolsT&& value) { SetProtocols(std::forward<ProtocolsT>(value)); return *this;}
283 inline DescribedServer& AddProtocols(Protocol value) { m_protocolsHasBeenSet = true; m_protocols.push_back(value); return *this; }
285
287
290 inline const Aws::String& GetSecurityPolicyName() const { return m_securityPolicyName; }
291 inline bool SecurityPolicyNameHasBeenSet() const { return m_securityPolicyNameHasBeenSet; }
292 template<typename SecurityPolicyNameT = Aws::String>
293 void SetSecurityPolicyName(SecurityPolicyNameT&& value) { m_securityPolicyNameHasBeenSet = true; m_securityPolicyName = std::forward<SecurityPolicyNameT>(value); }
294 template<typename SecurityPolicyNameT = Aws::String>
295 DescribedServer& WithSecurityPolicyName(SecurityPolicyNameT&& value) { SetSecurityPolicyName(std::forward<SecurityPolicyNameT>(value)); return *this;}
297
299
303 inline const Aws::String& GetServerId() const { return m_serverId; }
304 inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; }
305 template<typename ServerIdT = Aws::String>
306 void SetServerId(ServerIdT&& value) { m_serverIdHasBeenSet = true; m_serverId = std::forward<ServerIdT>(value); }
307 template<typename ServerIdT = Aws::String>
308 DescribedServer& WithServerId(ServerIdT&& value) { SetServerId(std::forward<ServerIdT>(value)); return *this;}
310
312
322 inline State GetState() const { return m_state; }
323 inline bool StateHasBeenSet() const { return m_stateHasBeenSet; }
324 inline void SetState(State value) { m_stateHasBeenSet = true; m_state = value; }
325 inline DescribedServer& WithState(State value) { SetState(value); return *this;}
327
329
333 inline const Aws::Vector<Tag>& GetTags() const { return m_tags; }
334 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
335 template<typename TagsT = Aws::Vector<Tag>>
336 void SetTags(TagsT&& value) { m_tagsHasBeenSet = true; m_tags = std::forward<TagsT>(value); }
337 template<typename TagsT = Aws::Vector<Tag>>
338 DescribedServer& WithTags(TagsT&& value) { SetTags(std::forward<TagsT>(value)); return *this;}
339 template<typename TagsT = Tag>
340 DescribedServer& AddTags(TagsT&& value) { m_tagsHasBeenSet = true; m_tags.emplace_back(std::forward<TagsT>(value)); return *this; }
342
344
348 inline int GetUserCount() const { return m_userCount; }
349 inline bool UserCountHasBeenSet() const { return m_userCountHasBeenSet; }
350 inline void SetUserCount(int value) { m_userCountHasBeenSet = true; m_userCount = value; }
351 inline DescribedServer& WithUserCount(int value) { SetUserCount(value); return *this;}
353
355
363 inline const WorkflowDetails& GetWorkflowDetails() const { return m_workflowDetails; }
364 inline bool WorkflowDetailsHasBeenSet() const { return m_workflowDetailsHasBeenSet; }
365 template<typename WorkflowDetailsT = WorkflowDetails>
366 void SetWorkflowDetails(WorkflowDetailsT&& value) { m_workflowDetailsHasBeenSet = true; m_workflowDetails = std::forward<WorkflowDetailsT>(value); }
367 template<typename WorkflowDetailsT = WorkflowDetails>
368 DescribedServer& WithWorkflowDetails(WorkflowDetailsT&& value) { SetWorkflowDetails(std::forward<WorkflowDetailsT>(value)); return *this;}
370
372
385 inline const Aws::Vector<Aws::String>& GetStructuredLogDestinations() const { return m_structuredLogDestinations; }
386 inline bool StructuredLogDestinationsHasBeenSet() const { return m_structuredLogDestinationsHasBeenSet; }
387 template<typename StructuredLogDestinationsT = Aws::Vector<Aws::String>>
388 void SetStructuredLogDestinations(StructuredLogDestinationsT&& value) { m_structuredLogDestinationsHasBeenSet = true; m_structuredLogDestinations = std::forward<StructuredLogDestinationsT>(value); }
389 template<typename StructuredLogDestinationsT = Aws::Vector<Aws::String>>
390 DescribedServer& WithStructuredLogDestinations(StructuredLogDestinationsT&& value) { SetStructuredLogDestinations(std::forward<StructuredLogDestinationsT>(value)); return *this;}
391 template<typename StructuredLogDestinationsT = Aws::String>
392 DescribedServer& AddStructuredLogDestinations(StructuredLogDestinationsT&& value) { m_structuredLogDestinationsHasBeenSet = true; m_structuredLogDestinations.emplace_back(std::forward<StructuredLogDestinationsT>(value)); return *this; }
394
396
404 inline const S3StorageOptions& GetS3StorageOptions() const { return m_s3StorageOptions; }
405 inline bool S3StorageOptionsHasBeenSet() const { return m_s3StorageOptionsHasBeenSet; }
406 template<typename S3StorageOptionsT = S3StorageOptions>
407 void SetS3StorageOptions(S3StorageOptionsT&& value) { m_s3StorageOptionsHasBeenSet = true; m_s3StorageOptions = std::forward<S3StorageOptionsT>(value); }
408 template<typename S3StorageOptionsT = S3StorageOptions>
409 DescribedServer& WithS3StorageOptions(S3StorageOptionsT&& value) { SetS3StorageOptions(std::forward<S3StorageOptionsT>(value)); return *this;}
411
413
420 inline const Aws::Vector<Aws::String>& GetAs2ServiceManagedEgressIpAddresses() const { return m_as2ServiceManagedEgressIpAddresses; }
421 inline bool As2ServiceManagedEgressIpAddressesHasBeenSet() const { return m_as2ServiceManagedEgressIpAddressesHasBeenSet; }
422 template<typename As2ServiceManagedEgressIpAddressesT = Aws::Vector<Aws::String>>
423 void SetAs2ServiceManagedEgressIpAddresses(As2ServiceManagedEgressIpAddressesT&& value) { m_as2ServiceManagedEgressIpAddressesHasBeenSet = true; m_as2ServiceManagedEgressIpAddresses = std::forward<As2ServiceManagedEgressIpAddressesT>(value); }
424 template<typename As2ServiceManagedEgressIpAddressesT = Aws::Vector<Aws::String>>
425 DescribedServer& WithAs2ServiceManagedEgressIpAddresses(As2ServiceManagedEgressIpAddressesT&& value) { SetAs2ServiceManagedEgressIpAddresses(std::forward<As2ServiceManagedEgressIpAddressesT>(value)); return *this;}
426 template<typename As2ServiceManagedEgressIpAddressesT = Aws::String>
427 DescribedServer& AddAs2ServiceManagedEgressIpAddresses(As2ServiceManagedEgressIpAddressesT&& value) { m_as2ServiceManagedEgressIpAddressesHasBeenSet = true; m_as2ServiceManagedEgressIpAddresses.emplace_back(std::forward<As2ServiceManagedEgressIpAddressesT>(value)); return *this; }
429
431
444 inline IpAddressType GetIpAddressType() const { return m_ipAddressType; }
445 inline bool IpAddressTypeHasBeenSet() const { return m_ipAddressTypeHasBeenSet; }
446 inline void SetIpAddressType(IpAddressType value) { m_ipAddressTypeHasBeenSet = true; m_ipAddressType = value; }
447 inline DescribedServer& WithIpAddressType(IpAddressType value) { SetIpAddressType(value); return *this;}
449 private:
450
451 Aws::String m_arn;
452 bool m_arnHasBeenSet = false;
453
454 Aws::String m_certificate;
455 bool m_certificateHasBeenSet = false;
456
457 ProtocolDetails m_protocolDetails;
458 bool m_protocolDetailsHasBeenSet = false;
459
460 Domain m_domain{Domain::NOT_SET};
461 bool m_domainHasBeenSet = false;
462
463 EndpointDetails m_endpointDetails;
464 bool m_endpointDetailsHasBeenSet = false;
465
466 EndpointType m_endpointType{EndpointType::NOT_SET};
467 bool m_endpointTypeHasBeenSet = false;
468
469 Aws::String m_hostKeyFingerprint;
470 bool m_hostKeyFingerprintHasBeenSet = false;
471
472 IdentityProviderDetails m_identityProviderDetails;
473 bool m_identityProviderDetailsHasBeenSet = false;
474
476 bool m_identityProviderTypeHasBeenSet = false;
477
478 Aws::String m_loggingRole;
479 bool m_loggingRoleHasBeenSet = false;
480
481 Aws::String m_postAuthenticationLoginBanner;
482 bool m_postAuthenticationLoginBannerHasBeenSet = false;
483
484 Aws::String m_preAuthenticationLoginBanner;
485 bool m_preAuthenticationLoginBannerHasBeenSet = false;
486
487 Aws::Vector<Protocol> m_protocols;
488 bool m_protocolsHasBeenSet = false;
489
490 Aws::String m_securityPolicyName;
491 bool m_securityPolicyNameHasBeenSet = false;
492
493 Aws::String m_serverId;
494 bool m_serverIdHasBeenSet = false;
495
496 State m_state{State::NOT_SET};
497 bool m_stateHasBeenSet = false;
498
499 Aws::Vector<Tag> m_tags;
500 bool m_tagsHasBeenSet = false;
501
502 int m_userCount{0};
503 bool m_userCountHasBeenSet = false;
504
505 WorkflowDetails m_workflowDetails;
506 bool m_workflowDetailsHasBeenSet = false;
507
508 Aws::Vector<Aws::String> m_structuredLogDestinations;
509 bool m_structuredLogDestinationsHasBeenSet = false;
510
511 S3StorageOptions m_s3StorageOptions;
512 bool m_s3StorageOptionsHasBeenSet = false;
513
514 Aws::Vector<Aws::String> m_as2ServiceManagedEgressIpAddresses;
515 bool m_as2ServiceManagedEgressIpAddressesHasBeenSet = false;
516
517 IpAddressType m_ipAddressType{IpAddressType::NOT_SET};
518 bool m_ipAddressTypeHasBeenSet = false;
519 };
520
521} // namespace Model
522} // namespace Transfer
523} // namespace Aws
AWS_TRANSFER_API DescribedServer()=default
void SetLoggingRole(LoggingRoleT &&value)
DescribedServer & WithUserCount(int value)
DescribedServer & WithArn(ArnT &&value)
DescribedServer & WithTags(TagsT &&value)
DescribedServer & WithAs2ServiceManagedEgressIpAddresses(As2ServiceManagedEgressIpAddressesT &&value)
const Aws::String & GetHostKeyFingerprint() const
DescribedServer & AddAs2ServiceManagedEgressIpAddresses(As2ServiceManagedEgressIpAddressesT &&value)
DescribedServer & WithPreAuthenticationLoginBanner(PreAuthenticationLoginBannerT &&value)
void SetProtocols(ProtocolsT &&value)
const Aws::String & GetServerId() const
const Aws::String & GetSecurityPolicyName() const
DescribedServer & WithS3StorageOptions(S3StorageOptionsT &&value)
DescribedServer & AddTags(TagsT &&value)
const Aws::String & GetCertificate() const
DescribedServer & WithProtocols(ProtocolsT &&value)
DescribedServer & WithServerId(ServerIdT &&value)
const Aws::Vector< Aws::String > & GetAs2ServiceManagedEgressIpAddresses() const
void SetPreAuthenticationLoginBanner(PreAuthenticationLoginBannerT &&value)
DescribedServer & WithProtocolDetails(ProtocolDetailsT &&value)
const IdentityProviderDetails & GetIdentityProviderDetails() const
DescribedServer & WithIpAddressType(IpAddressType value)
DescribedServer & WithPostAuthenticationLoginBanner(PostAuthenticationLoginBannerT &&value)
void SetIdentityProviderType(IdentityProviderType value)
AWS_TRANSFER_API DescribedServer(Aws::Utils::Json::JsonView jsonValue)
void SetIdentityProviderDetails(IdentityProviderDetailsT &&value)
void SetIpAddressType(IpAddressType value)
DescribedServer & WithCertificate(CertificateT &&value)
DescribedServer & WithHostKeyFingerprint(HostKeyFingerprintT &&value)
DescribedServer & WithSecurityPolicyName(SecurityPolicyNameT &&value)
const Aws::Vector< Tag > & GetTags() const
void SetHostKeyFingerprint(HostKeyFingerprintT &&value)
void SetStructuredLogDestinations(StructuredLogDestinationsT &&value)
DescribedServer & AddStructuredLogDestinations(StructuredLogDestinationsT &&value)
void SetAs2ServiceManagedEgressIpAddresses(As2ServiceManagedEgressIpAddressesT &&value)
const Aws::String & GetArn() const
void SetProtocolDetails(ProtocolDetailsT &&value)
const Aws::Vector< Protocol > & GetProtocols() const
IdentityProviderType GetIdentityProviderType() const
const ProtocolDetails & GetProtocolDetails() const
AWS_TRANSFER_API Aws::Utils::Json::JsonValue Jsonize() const
DescribedServer & WithEndpointType(EndpointType value)
const Aws::Vector< Aws::String > & GetStructuredLogDestinations() const
const WorkflowDetails & GetWorkflowDetails() const
AWS_TRANSFER_API DescribedServer & operator=(Aws::Utils::Json::JsonView jsonValue)
DescribedServer & WithIdentityProviderDetails(IdentityProviderDetailsT &&value)
DescribedServer & WithIdentityProviderType(IdentityProviderType value)
DescribedServer & WithEndpointDetails(EndpointDetailsT &&value)
void SetEndpointType(EndpointType value)
void SetWorkflowDetails(WorkflowDetailsT &&value)
const Aws::String & GetPreAuthenticationLoginBanner() const
void SetCertificate(CertificateT &&value)
DescribedServer & WithLoggingRole(LoggingRoleT &&value)
void SetSecurityPolicyName(SecurityPolicyNameT &&value)
DescribedServer & WithState(State value)
DescribedServer & WithWorkflowDetails(WorkflowDetailsT &&value)
DescribedServer & WithDomain(Domain value)
const Aws::String & GetLoggingRole() const
const EndpointDetails & GetEndpointDetails() const
void SetEndpointDetails(EndpointDetailsT &&value)
void SetS3StorageOptions(S3StorageOptionsT &&value)
void SetPostAuthenticationLoginBanner(PostAuthenticationLoginBannerT &&value)
const S3StorageOptions & GetS3StorageOptions() const
DescribedServer & WithStructuredLogDestinations(StructuredLogDestinationsT &&value)
DescribedServer & AddProtocols(Protocol value)
const Aws::String & GetPostAuthenticationLoginBanner() const
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector
Aws::Utils::Json::JsonValue JsonValue