EndpointDetails (AWS Java SDK for AWS Transfer for SFTP 1.12.544 API)

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 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 Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EndpointDetails()

Constructors
Constructor and Description
`EndpointDetails()`

Method Summary

All Methods Instance Methods Concrete Methods
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 server's endpoint.
`List<String>`	`getSecurityGroupIds()` A list of security groups IDs that are available to attach to your server's endpoint.
`List<String>`	`getSubnetIds()` A list of subnet IDs that are required to host your server endpoint in your VPC.
`String`	`getVpcEndpointId()` The identifier of the VPC endpoint.
`String`	`getVpcId()` The VPC identifier of the VPC in which a 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 server's endpoint.
`void`	`setSecurityGroupIds(Collection<String> securityGroupIds)` A list of security groups IDs that are available to attach to your server's endpoint.
`void`	`setSubnetIds(Collection<String> subnetIds)` A list of subnet IDs that are required to host your server endpoint in your VPC.
`void`	`setVpcEndpointId(String vpcEndpointId)` The identifier of the VPC endpoint.
`void`	`setVpcId(String vpcId)` The VPC identifier of the VPC in which a 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 server's endpoint.
`EndpointDetails`	`withAddressAllocationIds(String... addressAllocationIds)` A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.
`EndpointDetails`	`withSecurityGroupIds(Collection<String> securityGroupIds)` A list of security groups IDs that are available to attach to your server's endpoint.
`EndpointDetails`	`withSecurityGroupIds(String... securityGroupIds)` A list of security groups IDs that are available to attach to your server's endpoint.
`EndpointDetails`	`withSubnetIds(Collection<String> subnetIds)` A list of subnet IDs that are required to host your server endpoint in your VPC.
`EndpointDetails`	`withSubnetIds(String... subnetIds)` A list of subnet IDs that are required to host your server endpoint in your VPC.
`EndpointDetails`	`withVpcEndpointId(String vpcEndpointId)` The identifier of the VPC endpoint.
`EndpointDetails`	`withVpcId(String vpcId)` The VPC identifier of the VPC in which a 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 server's endpoint.
    
    This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.
    
    Returns:
    
    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.
  - setAddressAllocationIds
```
public void setAddressAllocationIds(Collection<String> addressAllocationIds)
```
    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.
    
    Parameters:
    
    addressAllocationIds - 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.
  - withAddressAllocationIds
```
public EndpointDetails withAddressAllocationIds(String... addressAllocationIds)
```
    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.
    
    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 server's endpoint.
    
    This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.
    
    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 server's endpoint.
    
    This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.
    
    Parameters:
    
    addressAllocationIds - 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.
    
    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 server endpoint in your VPC.
    
    This property can only be set when EndpointType is set to VPC.
    
    Returns:
    
    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.
  - setSubnetIds
```
public void setSubnetIds(Collection<String> subnetIds)
```
    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.
    
    Parameters:
    
    subnetIds - 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.
  - withSubnetIds
```
public EndpointDetails withSubnetIds(String... subnetIds)
```
    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.
    
    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 server endpoint in your VPC.
    
    This property can only be set when EndpointType is set to 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 server endpoint in your VPC.
    
    This property can only be set when EndpointType is set to VPC.
    
    Parameters:
    
    subnetIds - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVpcEndpointId
```
public void setVpcEndpointId(String vpcEndpointId)
```
    The identifier 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.
    
    Parameters:
    
    vpcEndpointId - The identifier 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.
  - getVpcEndpointId
```
public String getVpcEndpointId()
```
    The identifier 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.
    
    Returns:
    
    The identifier 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.
  - withVpcEndpointId
```
public EndpointDetails withVpcEndpointId(String vpcEndpointId)
```
    The identifier 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.
    
    Parameters:
    
    vpcEndpointId - The identifier 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVpcId
```
public void setVpcId(String vpcId)
```
    The VPC identifier of the VPC in which a server's endpoint will be hosted.
    
    This property can only be set when EndpointType is set to VPC.
    
    Parameters:
    
    vpcId - The VPC identifier of the VPC in which a server's endpoint will be hosted.
    
    This property can only be set when EndpointType is set to VPC.
  - getVpcId
```
public String getVpcId()
```
    The VPC identifier of the VPC in which a server's endpoint will be hosted.
    
    This property can only be set when EndpointType is set to VPC.
    
    Returns:
    
    The VPC identifier of the VPC in which a server's endpoint will be hosted.
    
    This property can only be set when EndpointType is set to VPC.
  - withVpcId
```
public EndpointDetails withVpcId(String vpcId)
```
    The VPC identifier of the VPC in which a server's endpoint will be hosted.
    
    This property can only be set when EndpointType is set to VPC.
    
    Parameters:
    
    vpcId - The VPC identifier of the VPC in which a server's endpoint will be hosted.
    
    This property can only be set when EndpointType is set to VPC.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSecurityGroupIds
```
public List<String> getSecurityGroupIds()
```
    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.
    
    Returns:
    
    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.
  - setSecurityGroupIds
```
public void setSecurityGroupIds(Collection<String> securityGroupIds)
```
    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.
    
    Parameters:
    
    securityGroupIds - 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.
  - withSecurityGroupIds
```
public EndpointDetails withSecurityGroupIds(String... securityGroupIds)
```
    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.
    
    NOTE: This method appends the values to the existing list (if any). Use setSecurityGroupIds(java.util.Collection) or withSecurityGroupIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    securityGroupIds - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSecurityGroupIds
```
public EndpointDetails withSecurityGroupIds(Collection<String> securityGroupIds)
```
    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.
    
    Parameters:
    
    securityGroupIds - 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.
    
    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

Class EndpointDetails

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EndpointDetails

Method Detail

getAddressAllocationIds

setAddressAllocationIds

withAddressAllocationIds

withAddressAllocationIds

getSubnetIds

setSubnetIds

withSubnetIds

withSubnetIds

setVpcEndpointId

getVpcEndpointId

withVpcEndpointId

setVpcId

getVpcId

withVpcId

getSecurityGroupIds

setSecurityGroupIds

withSecurityGroupIds

withSecurityGroupIds

toString

equals

hashCode

clone

marshall