com.amazonaws.services.transfer.model

Class EndpointDetails

java.lang.Object

com.amazonaws.services.transfer.model.EndpointDetails

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EndpointDetails
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
EndpointDetails()

Method Summary

Modifier and Type	Method and Description
EndpointDetails	clone()
boolean	equals(Object obj)
List<String>	getAddressAllocationIds() A list of address allocation IDs that are required to attach an Elastic IP address to your SFTP server's endpoint.
List<String>	getSubnetIds() A list of subnet IDs that are required to host your SFTP server endpoint in your VPC.
String	getVpcEndpointId() The ID of the VPC endpoint.
String	getVpcId() The VPC ID of the virtual private cloud in which the SFTP server's endpoint will be hosted.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setAddressAllocationIds(Collection<String> addressAllocationIds) A list of address allocation IDs that are required to attach an Elastic IP address to your SFTP server's endpoint.
void	setSubnetIds(Collection<String> subnetIds) A list of subnet IDs that are required to host your SFTP server endpoint in your VPC.
void	setVpcEndpointId(String vpcEndpointId) The ID of the VPC endpoint.
void	setVpcId(String vpcId) The VPC ID of the virtual private cloud in which the SFTP server's endpoint will be hosted.
String	toString() Returns a string representation of this object.
EndpointDetails	withAddressAllocationIds(Collection<String> addressAllocationIds) A list of address allocation IDs that are required to attach an Elastic IP address to your SFTP server's endpoint.
EndpointDetails	withAddressAllocationIds(String... addressAllocationIds) A list of address allocation IDs that are required to attach an Elastic IP address to your SFTP server's endpoint.
EndpointDetails	withSubnetIds(Collection<String> subnetIds) A list of subnet IDs that are required to host your SFTP server endpoint in your VPC.
EndpointDetails	withSubnetIds(String... subnetIds) A list of subnet IDs that are required to host your SFTP server endpoint in your VPC.
EndpointDetails	withVpcEndpointId(String vpcEndpointId) The ID of the VPC endpoint.
EndpointDetails	withVpcId(String vpcId) The VPC ID of the virtual private cloud in which the SFTP server's endpoint will be hosted.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EndpointDetails

public EndpointDetails()

Method Detail

getAddressAllocationIds

public List<String> getAddressAllocationIds()

A list of address allocation IDs that are required to attach an Elastic IP address to your SFTP server's endpoint. This is only valid in the UpdateServer API.

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

Returns:

A list of address allocation IDs that are required to attach an Elastic IP address to your SFTP server's endpoint. This is only valid in the UpdateServer API.

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

setAddressAllocationIds

public void setAddressAllocationIds(Collection<String> addressAllocationIds)

A list of address allocation IDs that are required to attach an Elastic IP address to your SFTP server's endpoint. This is only valid in the UpdateServer API.

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

Parameters:

addressAllocationIds - A list of address allocation IDs that are required to attach an Elastic IP address to your SFTP server's endpoint. This is only valid in the UpdateServer API.

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

withAddressAllocationIds

public EndpointDetails withAddressAllocationIds(String... addressAllocationIds)

A list of address allocation IDs that are required to attach an Elastic IP address to your SFTP server's endpoint. This is only valid in the UpdateServer API.

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

NOTE: This method appends the values to the existing list (if any). Use setAddressAllocationIds(java.util.Collection) or withAddressAllocationIds(java.util.Collection) if you want to override the existing values.

Parameters:

addressAllocationIds - A list of address allocation IDs that are required to attach an Elastic IP address to your SFTP server's endpoint. This is only valid in the UpdateServer API.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withAddressAllocationIds

public EndpointDetails withAddressAllocationIds(Collection<String> addressAllocationIds)

A list of address allocation IDs that are required to attach an Elastic IP address to your SFTP server's endpoint. This is only valid in the UpdateServer API.

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

Parameters:

addressAllocationIds - A list of address allocation IDs that are required to attach an Elastic IP address to your SFTP server's endpoint. This is only valid in the UpdateServer API.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getSubnetIds

public List<String> getSubnetIds()

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

Returns:

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

setSubnetIds

public void setSubnetIds(Collection<String> subnetIds)

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

Parameters:

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

withSubnetIds

public EndpointDetails withSubnetIds(String... subnetIds)

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

NOTE: This method appends the values to the existing list (if any). Use setSubnetIds(java.util.Collection) or withSubnetIds(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withSubnetIds

public EndpointDetails withSubnetIds(Collection<String> subnetIds)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setVpcEndpointId

public void setVpcEndpointId(String vpcEndpointId)

The ID of the VPC endpoint.

Parameters:

vpcEndpointId - The ID of the VPC endpoint.

getVpcEndpointId

public String getVpcEndpointId()

The ID of the VPC endpoint.

Returns:

The ID of the VPC endpoint.

withVpcEndpointId

public EndpointDetails withVpcEndpointId(String vpcEndpointId)

The ID of the VPC endpoint.

Parameters:

vpcEndpointId - The ID of the VPC endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVpcId

public void setVpcId(String vpcId)

The VPC ID of the virtual private cloud in which the SFTP server's endpoint will be hosted.

Parameters:

vpcId - The VPC ID of the virtual private cloud in which the SFTP server's endpoint will be hosted.

getVpcId

public String getVpcId()

The VPC ID of the virtual private cloud in which the SFTP server's endpoint will be hosted.

Returns:

The VPC ID of the virtual private cloud in which the SFTP server's endpoint will be hosted.

withVpcId

public EndpointDetails withVpcId(String vpcId)

The VPC ID of the virtual private cloud in which the SFTP server's endpoint will be hosted.

Parameters:

vpcId - The VPC ID of the virtual private cloud in which the SFTP server's endpoint will be hosted.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public EndpointDetails clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo