EndpointDetails (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.transfer.model.EndpointDetails

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EndpointDetails.Builder,EndpointDetails>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class EndpointDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EndpointDetails.Builder,EndpointDetails>
```
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 March 31, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your AWS account if your account hasn't already done so before March 31, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your AWS account on or before March 31, 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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface EndpointDetails.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`EndpointDetails.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`addressAllocationIds()` A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.
`static EndpointDetails.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAddressAllocationIds()` Returns true if the AddressAllocationIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasSecurityGroupIds()` Returns true if the SecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasSubnetIds()` Returns true if the SubnetIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroupIds()` A list of security groups IDs that are available to attach to your server's endpoint.
`static Class<? extends EndpointDetails.Builder>`	`serializableBuilderClass()`
`List<String>`	`subnetIds()` A list of subnet IDs that are required to host your server endpoint in your VPC.
`EndpointDetails.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`vpcEndpointId()` The ID of the VPC endpoint.
`String`	`vpcId()` The VPC ID of the VPC in which a server's endpoint will be hosted.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasAddressAllocationIds
```
public final boolean hasAddressAllocationIds()
```
    Returns true if the AddressAllocationIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - addressAllocationIds
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAddressAllocationIds() to see if a value was sent in this field.
    
    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.
  - hasSubnetIds
```
public final boolean hasSubnetIds()
```
    Returns true if the SubnetIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - subnetIds
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSubnetIds() to see if a value was sent in this field.
    
    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.
  - vpcEndpointId
```
public final String vpcEndpointId()
```
    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.
    
    Returns:
    
    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.
  - vpcId
```
public final String vpcId()
```
    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.
    
    Returns:
    
    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.
  - hasSecurityGroupIds
```
public final boolean hasSecurityGroupIds()
```
    Returns true if the SecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - securityGroupIds
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSecurityGroupIds() to see if a value was sent in this field.
    
    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.
  - toBuilder
```
public EndpointDetails.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<EndpointDetails.Builder,EndpointDetails>
  - builder
```
public static EndpointDetails.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends EndpointDetails.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class EndpointDetails

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasAddressAllocationIds

addressAllocationIds

hasSubnetIds

subnetIds

vpcEndpointId

vpcId

hasSecurityGroupIds

securityGroupIds

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields