AWS SDK for C++  1.9.129
AWS SDK for C++
Public Member Functions | List of all members
Aws::Transfer::Model::EndpointDetails Class Reference

#include <EndpointDetails.h>

Public Member Functions

 EndpointDetails ()
 
 EndpointDetails (Aws::Utils::Json::JsonView jsonValue)
 
EndpointDetailsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::Vector< Aws::String > & GetAddressAllocationIds () const
 
bool AddressAllocationIdsHasBeenSet () const
 
void SetAddressAllocationIds (const Aws::Vector< Aws::String > &value)
 
void SetAddressAllocationIds (Aws::Vector< Aws::String > &&value)
 
EndpointDetailsWithAddressAllocationIds (const Aws::Vector< Aws::String > &value)
 
EndpointDetailsWithAddressAllocationIds (Aws::Vector< Aws::String > &&value)
 
EndpointDetailsAddAddressAllocationIds (const Aws::String &value)
 
EndpointDetailsAddAddressAllocationIds (Aws::String &&value)
 
EndpointDetailsAddAddressAllocationIds (const char *value)
 
const Aws::Vector< Aws::String > & GetSubnetIds () const
 
bool SubnetIdsHasBeenSet () const
 
void SetSubnetIds (const Aws::Vector< Aws::String > &value)
 
void SetSubnetIds (Aws::Vector< Aws::String > &&value)
 
EndpointDetailsWithSubnetIds (const Aws::Vector< Aws::String > &value)
 
EndpointDetailsWithSubnetIds (Aws::Vector< Aws::String > &&value)
 
EndpointDetailsAddSubnetIds (const Aws::String &value)
 
EndpointDetailsAddSubnetIds (Aws::String &&value)
 
EndpointDetailsAddSubnetIds (const char *value)
 
const Aws::StringGetVpcEndpointId () const
 
bool VpcEndpointIdHasBeenSet () const
 
void SetVpcEndpointId (const Aws::String &value)
 
void SetVpcEndpointId (Aws::String &&value)
 
void SetVpcEndpointId (const char *value)
 
EndpointDetailsWithVpcEndpointId (const Aws::String &value)
 
EndpointDetailsWithVpcEndpointId (Aws::String &&value)
 
EndpointDetailsWithVpcEndpointId (const char *value)
 
const Aws::StringGetVpcId () const
 
bool VpcIdHasBeenSet () const
 
void SetVpcId (const Aws::String &value)
 
void SetVpcId (Aws::String &&value)
 
void SetVpcId (const char *value)
 
EndpointDetailsWithVpcId (const Aws::String &value)
 
EndpointDetailsWithVpcId (Aws::String &&value)
 
EndpointDetailsWithVpcId (const char *value)
 
const Aws::Vector< Aws::String > & GetSecurityGroupIds () const
 
bool SecurityGroupIdsHasBeenSet () const
 
void SetSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
void SetSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
EndpointDetailsWithSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
EndpointDetailsWithSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
EndpointDetailsAddSecurityGroupIds (const Aws::String &value)
 
EndpointDetailsAddSecurityGroupIds (Aws::String &&value)
 
EndpointDetailsAddSecurityGroupIds (const char *value)
 

Detailed Description

The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the UpdateServer API and attach an Elastic IP address to your server's endpoint.

After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

See Also:

AWS API Reference

Definition at line 45 of file EndpointDetails.h.

Constructor & Destructor Documentation

◆ EndpointDetails() [1/2]

Aws::Transfer::Model::EndpointDetails::EndpointDetails ( )

◆ EndpointDetails() [2/2]

Aws::Transfer::Model::EndpointDetails::EndpointDetails ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddAddressAllocationIds() [1/3]

EndpointDetails& Aws::Transfer::Model::EndpointDetails::AddAddressAllocationIds ( Aws::String &&  value)
inline

A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.

This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.

Definition at line 116 of file EndpointDetails.h.

◆ AddAddressAllocationIds() [2/3]

EndpointDetails& Aws::Transfer::Model::EndpointDetails::AddAddressAllocationIds ( const Aws::String value)
inline

A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.

This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.

Definition at line 108 of file EndpointDetails.h.

◆ AddAddressAllocationIds() [3/3]

EndpointDetails& Aws::Transfer::Model::EndpointDetails::AddAddressAllocationIds ( const char *  value)
inline

A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.

This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.

Definition at line 124 of file EndpointDetails.h.

◆ AddressAllocationIdsHasBeenSet()

bool Aws::Transfer::Model::EndpointDetails::AddressAllocationIdsHasBeenSet ( ) const
inline

A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.

This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.

Definition at line 68 of file EndpointDetails.h.

◆ AddSecurityGroupIds() [1/3]

EndpointDetails& Aws::Transfer::Model::EndpointDetails::AddSecurityGroupIds ( Aws::String &&  value)
inline

A list of security groups IDs that are available to attach to your server's endpoint.

This property can only be set when EndpointType is set to VPC.

You can edit the SecurityGroupIds property in the UpdateServer API only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.

Definition at line 439 of file EndpointDetails.h.

◆ AddSecurityGroupIds() [2/3]

EndpointDetails& Aws::Transfer::Model::EndpointDetails::AddSecurityGroupIds ( const Aws::String value)
inline

A list of security groups IDs that are available to attach to your server's endpoint.

This property can only be set when EndpointType is set to VPC.

You can edit the SecurityGroupIds property in the UpdateServer API only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.

Definition at line 424 of file EndpointDetails.h.

◆ AddSecurityGroupIds() [3/3]

EndpointDetails& Aws::Transfer::Model::EndpointDetails::AddSecurityGroupIds ( const char *  value)
inline

A list of security groups IDs that are available to attach to your server's endpoint.

This property can only be set when EndpointType is set to VPC.

You can edit the SecurityGroupIds property in the UpdateServer API only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.

Definition at line 454 of file EndpointDetails.h.

◆ AddSubnetIds() [1/3]

EndpointDetails& Aws::Transfer::Model::EndpointDetails::AddSubnetIds ( Aws::String &&  value)
inline

A list of subnet IDs that are required to host your server endpoint in your VPC.

This property can only be set when EndpointType is set to VPC.

Definition at line 181 of file EndpointDetails.h.

◆ AddSubnetIds() [2/3]

EndpointDetails& Aws::Transfer::Model::EndpointDetails::AddSubnetIds ( const Aws::String value)
inline

A list of subnet IDs that are required to host your server endpoint in your VPC.

This property can only be set when EndpointType is set to VPC.

Definition at line 174 of file EndpointDetails.h.

◆ AddSubnetIds() [3/3]

EndpointDetails& Aws::Transfer::Model::EndpointDetails::AddSubnetIds ( const char *  value)
inline

A list of subnet IDs that are required to host your server endpoint in your VPC.

This property can only be set when EndpointType is set to VPC.

Definition at line 188 of file EndpointDetails.h.

◆ GetAddressAllocationIds()

const Aws::Vector<Aws::String>& Aws::Transfer::Model::EndpointDetails::GetAddressAllocationIds ( ) const
inline

A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.

This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.

Definition at line 60 of file EndpointDetails.h.

◆ GetSecurityGroupIds()

const Aws::Vector<Aws::String>& Aws::Transfer::Model::EndpointDetails::GetSecurityGroupIds ( ) const
inline

A list of security groups IDs that are available to attach to your server's endpoint.

This property can only be set when EndpointType is set to VPC.

You can edit the SecurityGroupIds property in the UpdateServer API only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.

Definition at line 334 of file EndpointDetails.h.

◆ GetSubnetIds()

const Aws::Vector<Aws::String>& Aws::Transfer::Model::EndpointDetails::GetSubnetIds ( ) const
inline

A list of subnet IDs that are required to host your server endpoint in your VPC.

This property can only be set when EndpointType is set to VPC.

Definition at line 132 of file EndpointDetails.h.

◆ GetVpcEndpointId()

const Aws::String& Aws::Transfer::Model::EndpointDetails::GetVpcEndpointId ( ) const
inline

The ID of the VPC endpoint.

This property can only be set when EndpointType is set to VPC_ENDPOINT.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

Definition at line 198 of file EndpointDetails.h.

◆ GetVpcId()

const Aws::String& Aws::Transfer::Model::EndpointDetails::GetVpcId ( ) const
inline

The VPC ID of the VPC in which a server's endpoint will be hosted.

This property can only be set when EndpointType is set to VPC.

Definition at line 269 of file EndpointDetails.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Transfer::Model::EndpointDetails::Jsonize ( ) const

◆ operator=()

EndpointDetails& Aws::Transfer::Model::EndpointDetails::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SecurityGroupIdsHasBeenSet()

bool Aws::Transfer::Model::EndpointDetails::SecurityGroupIdsHasBeenSet ( ) const
inline

A list of security groups IDs that are available to attach to your server's endpoint.

This property can only be set when EndpointType is set to VPC.

You can edit the SecurityGroupIds property in the UpdateServer API only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.

Definition at line 349 of file EndpointDetails.h.

◆ SetAddressAllocationIds() [1/2]

void Aws::Transfer::Model::EndpointDetails::SetAddressAllocationIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.

This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.

Definition at line 84 of file EndpointDetails.h.

◆ SetAddressAllocationIds() [2/2]

void Aws::Transfer::Model::EndpointDetails::SetAddressAllocationIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.

This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.

Definition at line 76 of file EndpointDetails.h.

◆ SetSecurityGroupIds() [1/2]

void Aws::Transfer::Model::EndpointDetails::SetSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of security groups IDs that are available to attach to your server's endpoint.

This property can only be set when EndpointType is set to VPC.

You can edit the SecurityGroupIds property in the UpdateServer API only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.

Definition at line 379 of file EndpointDetails.h.

◆ SetSecurityGroupIds() [2/2]

void Aws::Transfer::Model::EndpointDetails::SetSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of security groups IDs that are available to attach to your server's endpoint.

This property can only be set when EndpointType is set to VPC.

You can edit the SecurityGroupIds property in the UpdateServer API only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.

Definition at line 364 of file EndpointDetails.h.

◆ SetSubnetIds() [1/2]

void Aws::Transfer::Model::EndpointDetails::SetSubnetIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of subnet IDs that are required to host your server endpoint in your VPC.

This property can only be set when EndpointType is set to VPC.

Definition at line 153 of file EndpointDetails.h.

◆ SetSubnetIds() [2/2]

void Aws::Transfer::Model::EndpointDetails::SetSubnetIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of subnet IDs that are required to host your server endpoint in your VPC.

This property can only be set when EndpointType is set to VPC.

Definition at line 146 of file EndpointDetails.h.

◆ SetVpcEndpointId() [1/3]

void Aws::Transfer::Model::EndpointDetails::SetVpcEndpointId ( Aws::String &&  value)
inline

The ID of the VPC endpoint.

This property can only be set when EndpointType is set to VPC_ENDPOINT.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

Definition at line 225 of file EndpointDetails.h.

◆ SetVpcEndpointId() [2/3]

void Aws::Transfer::Model::EndpointDetails::SetVpcEndpointId ( const Aws::String value)
inline

The ID of the VPC endpoint.

This property can only be set when EndpointType is set to VPC_ENDPOINT.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

Definition at line 216 of file EndpointDetails.h.

◆ SetVpcEndpointId() [3/3]

void Aws::Transfer::Model::EndpointDetails::SetVpcEndpointId ( const char *  value)
inline

The ID of the VPC endpoint.

This property can only be set when EndpointType is set to VPC_ENDPOINT.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

Definition at line 234 of file EndpointDetails.h.

◆ SetVpcId() [1/3]

void Aws::Transfer::Model::EndpointDetails::SetVpcId ( Aws::String &&  value)
inline

The VPC ID of the VPC in which a server's endpoint will be hosted.

This property can only be set when EndpointType is set to VPC.

Definition at line 290 of file EndpointDetails.h.

◆ SetVpcId() [2/3]

void Aws::Transfer::Model::EndpointDetails::SetVpcId ( const Aws::String value)
inline

The VPC ID of the VPC in which a server's endpoint will be hosted.

This property can only be set when EndpointType is set to VPC.

Definition at line 283 of file EndpointDetails.h.

◆ SetVpcId() [3/3]

void Aws::Transfer::Model::EndpointDetails::SetVpcId ( const char *  value)
inline

The VPC ID of the VPC in which a server's endpoint will be hosted.

This property can only be set when EndpointType is set to VPC.

Definition at line 297 of file EndpointDetails.h.

◆ SubnetIdsHasBeenSet()

bool Aws::Transfer::Model::EndpointDetails::SubnetIdsHasBeenSet ( ) const
inline

A list of subnet IDs that are required to host your server endpoint in your VPC.

This property can only be set when EndpointType is set to VPC.

Definition at line 139 of file EndpointDetails.h.

◆ VpcEndpointIdHasBeenSet()

bool Aws::Transfer::Model::EndpointDetails::VpcEndpointIdHasBeenSet ( ) const
inline

The ID of the VPC endpoint.

This property can only be set when EndpointType is set to VPC_ENDPOINT.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

Definition at line 207 of file EndpointDetails.h.

◆ VpcIdHasBeenSet()

bool Aws::Transfer::Model::EndpointDetails::VpcIdHasBeenSet ( ) const
inline

The VPC ID of the VPC in which a server's endpoint will be hosted.

This property can only be set when EndpointType is set to VPC.

Definition at line 276 of file EndpointDetails.h.

◆ WithAddressAllocationIds() [1/2]

EndpointDetails& Aws::Transfer::Model::EndpointDetails::WithAddressAllocationIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.

This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.

Definition at line 100 of file EndpointDetails.h.

◆ WithAddressAllocationIds() [2/2]

EndpointDetails& Aws::Transfer::Model::EndpointDetails::WithAddressAllocationIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.

This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.

Definition at line 92 of file EndpointDetails.h.

◆ WithSecurityGroupIds() [1/2]

EndpointDetails& Aws::Transfer::Model::EndpointDetails::WithSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of security groups IDs that are available to attach to your server's endpoint.

This property can only be set when EndpointType is set to VPC.

You can edit the SecurityGroupIds property in the UpdateServer API only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.

Definition at line 409 of file EndpointDetails.h.

◆ WithSecurityGroupIds() [2/2]

EndpointDetails& Aws::Transfer::Model::EndpointDetails::WithSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of security groups IDs that are available to attach to your server's endpoint.

This property can only be set when EndpointType is set to VPC.

You can edit the SecurityGroupIds property in the UpdateServer API only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.

Definition at line 394 of file EndpointDetails.h.

◆ WithSubnetIds() [1/2]

EndpointDetails& Aws::Transfer::Model::EndpointDetails::WithSubnetIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of subnet IDs that are required to host your server endpoint in your VPC.

This property can only be set when EndpointType is set to VPC.

Definition at line 167 of file EndpointDetails.h.

◆ WithSubnetIds() [2/2]

EndpointDetails& Aws::Transfer::Model::EndpointDetails::WithSubnetIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of subnet IDs that are required to host your server endpoint in your VPC.

This property can only be set when EndpointType is set to VPC.

Definition at line 160 of file EndpointDetails.h.

◆ WithVpcEndpointId() [1/3]

EndpointDetails& Aws::Transfer::Model::EndpointDetails::WithVpcEndpointId ( Aws::String &&  value)
inline

The ID of the VPC endpoint.

This property can only be set when EndpointType is set to VPC_ENDPOINT.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

Definition at line 252 of file EndpointDetails.h.

◆ WithVpcEndpointId() [2/3]

EndpointDetails& Aws::Transfer::Model::EndpointDetails::WithVpcEndpointId ( const Aws::String value)
inline

The ID of the VPC endpoint.

This property can only be set when EndpointType is set to VPC_ENDPOINT.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

Definition at line 243 of file EndpointDetails.h.

◆ WithVpcEndpointId() [3/3]

EndpointDetails& Aws::Transfer::Model::EndpointDetails::WithVpcEndpointId ( const char *  value)
inline

The ID of the VPC endpoint.

This property can only be set when EndpointType is set to VPC_ENDPOINT.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

Definition at line 261 of file EndpointDetails.h.

◆ WithVpcId() [1/3]

EndpointDetails& Aws::Transfer::Model::EndpointDetails::WithVpcId ( Aws::String &&  value)
inline

The VPC ID of the VPC in which a server's endpoint will be hosted.

This property can only be set when EndpointType is set to VPC.

Definition at line 311 of file EndpointDetails.h.

◆ WithVpcId() [2/3]

EndpointDetails& Aws::Transfer::Model::EndpointDetails::WithVpcId ( const Aws::String value)
inline

The VPC ID of the VPC in which a server's endpoint will be hosted.

This property can only be set when EndpointType is set to VPC.

Definition at line 304 of file EndpointDetails.h.

◆ WithVpcId() [3/3]

EndpointDetails& Aws::Transfer::Model::EndpointDetails::WithVpcId ( const char *  value)
inline

The VPC ID of the VPC in which a server's endpoint will be hosted.

This property can only be set when EndpointType is set to VPC.

Definition at line 318 of file EndpointDetails.h.


The documentation for this class was generated from the following file: