Interface EndpointDetails.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<EndpointDetails.Builder,
,EndpointDetails> SdkBuilder<EndpointDetails.Builder,
,EndpointDetails> SdkPojo
- Enclosing class:
EndpointDetails
-
Method Summary
Modifier and TypeMethodDescriptionaddressAllocationIds
(String... addressAllocationIds) A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.addressAllocationIds
(Collection<String> addressAllocationIds) A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.securityGroupIds
(String... securityGroupIds) A list of security groups IDs that are available to attach to your server's endpoint.securityGroupIds
(Collection<String> securityGroupIds) A list of security groups IDs that are available to attach to your server's endpoint.A list of subnet IDs that are required to host your server endpoint in your VPC.subnetIds
(Collection<String> subnetIds) A list of subnet IDs that are required to host your server endpoint in your VPC.vpcEndpointId
(String vpcEndpointId) The identifier of the VPC endpoint.The VPC identifier of the VPC in which a server's endpoint will be hosted.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
addressAllocationIds
A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.
An address allocation ID corresponds to the allocation ID of an Elastic IP address. This value can be retrieved from the
allocationId
field from the Amazon EC2 Address data type. One way to retrieve this value is by calling the EC2 DescribeAddresses API.This parameter is optional. Set this parameter if you want to make your VPC endpoint public-facing. For details, see Create an internet-facing endpoint for your server.
This property can only be set as follows:
-
EndpointType
must be set toVPC
-
The Transfer Family server must be offline.
-
You cannot set this parameter for Transfer Family servers that use the FTP protocol.
-
The server must already have
SubnetIds
populated (SubnetIds
andAddressAllocationIds
cannot be updated simultaneously). -
AddressAllocationIds
can't contain duplicates, and must be equal in length toSubnetIds
. For example, if you have three subnet IDs, you must also specify three address allocation IDs. -
Call the
UpdateServer
API to set or change this parameter.
- Parameters:
addressAllocationIds
- A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.An address allocation ID corresponds to the allocation ID of an Elastic IP address. This value can be retrieved from the
allocationId
field from the Amazon EC2 Address data type. One way to retrieve this value is by calling the EC2 DescribeAddresses API.This parameter is optional. Set this parameter if you want to make your VPC endpoint public-facing. For details, see Create an internet-facing endpoint for your server.
This property can only be set as follows:
-
EndpointType
must be set toVPC
-
The Transfer Family server must be offline.
-
You cannot set this parameter for Transfer Family servers that use the FTP protocol.
-
The server must already have
SubnetIds
populated (SubnetIds
andAddressAllocationIds
cannot be updated simultaneously). -
AddressAllocationIds
can't contain duplicates, and must be equal in length toSubnetIds
. For example, if you have three subnet IDs, you must also specify three address allocation IDs. -
Call the
UpdateServer
API to set or change this parameter.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
addressAllocationIds
A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.
An address allocation ID corresponds to the allocation ID of an Elastic IP address. This value can be retrieved from the
allocationId
field from the Amazon EC2 Address data type. One way to retrieve this value is by calling the EC2 DescribeAddresses API.This parameter is optional. Set this parameter if you want to make your VPC endpoint public-facing. For details, see Create an internet-facing endpoint for your server.
This property can only be set as follows:
-
EndpointType
must be set toVPC
-
The Transfer Family server must be offline.
-
You cannot set this parameter for Transfer Family servers that use the FTP protocol.
-
The server must already have
SubnetIds
populated (SubnetIds
andAddressAllocationIds
cannot be updated simultaneously). -
AddressAllocationIds
can't contain duplicates, and must be equal in length toSubnetIds
. For example, if you have three subnet IDs, you must also specify three address allocation IDs. -
Call the
UpdateServer
API to set or change this parameter.
- Parameters:
addressAllocationIds
- A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.An address allocation ID corresponds to the allocation ID of an Elastic IP address. This value can be retrieved from the
allocationId
field from the Amazon EC2 Address data type. One way to retrieve this value is by calling the EC2 DescribeAddresses API.This parameter is optional. Set this parameter if you want to make your VPC endpoint public-facing. For details, see Create an internet-facing endpoint for your server.
This property can only be set as follows:
-
EndpointType
must be set toVPC
-
The Transfer Family server must be offline.
-
You cannot set this parameter for Transfer Family servers that use the FTP protocol.
-
The server must already have
SubnetIds
populated (SubnetIds
andAddressAllocationIds
cannot be updated simultaneously). -
AddressAllocationIds
can't contain duplicates, and must be equal in length toSubnetIds
. For example, if you have three subnet IDs, you must also specify three address allocation IDs. -
Call the
UpdateServer
API to set or change this parameter.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 toVPC
.- 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 toVPC
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 toVPC
.- 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 toVPC
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcEndpointId
The identifier of the VPC endpoint.
This property can only be set when
EndpointType
is set toVPC_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 toVPC_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.
-
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 toVPC
.- 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 toVPC
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 toVPC
.You can edit the
SecurityGroupIds
property in the UpdateServer API only if you are changing theEndpointType
fromPUBLIC
orVPC_ENDPOINT
toVPC
. 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 toVPC
.You can edit the
SecurityGroupIds
property in the UpdateServer API only if you are changing theEndpointType
fromPUBLIC
orVPC_ENDPOINT
toVPC
. 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.
-
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 toVPC
.You can edit the
SecurityGroupIds
property in the UpdateServer API only if you are changing theEndpointType
fromPUBLIC
orVPC_ENDPOINT
toVPC
. 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 toVPC
.You can edit the
SecurityGroupIds
property in the UpdateServer API only if you are changing theEndpointType
fromPUBLIC
orVPC_ENDPOINT
toVPC
. 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.
-