Interface EndpointDetails.Builder

All Superinterfaces:
Buildable, CopyableBuilder<EndpointDetails.Builder,EndpointDetails>, SdkBuilder<EndpointDetails.Builder,EndpointDetails>, SdkPojo
Enclosing class:
EndpointDetails
@Mutable @NotThreadSafe public static interface EndpointDetails.Builder extends SdkPojo, CopyableBuilder<EndpointDetails.Builder,EndpointDetails>

  • Method Details

    • addressAllocationIds

      EndpointDetails.Builder addressAllocationIds(Collection<String> 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 to VPC

      • 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 and AddressAllocationIds cannot be updated simultaneously).

      • AddressAllocationIds can't contain duplicates, and must be equal in length to SubnetIds. 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.

      • You can't set address allocation IDs for servers that have an IpAddressType set to DUALSTACK You can only set this property if IpAddressType is set to IPV4.

      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 to VPC

      • 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 and AddressAllocationIds cannot be updated simultaneously).

      • AddressAllocationIds can't contain duplicates, and must be equal in length to SubnetIds. 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.

      • You can't set address allocation IDs for servers that have an IpAddressType set to DUALSTACK You can only set this property if IpAddressType is set to IPV4.

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

    • addressAllocationIds

      EndpointDetails.Builder addressAllocationIds(String... 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 to VPC

      • 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 and AddressAllocationIds cannot be updated simultaneously).

      • AddressAllocationIds can't contain duplicates, and must be equal in length to SubnetIds. 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.

      • You can't set address allocation IDs for servers that have an IpAddressType set to DUALSTACK You can only set this property if IpAddressType is set to IPV4.

      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 to VPC

      • 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 and AddressAllocationIds cannot be updated simultaneously).

      • AddressAllocationIds can't contain duplicates, and must be equal in length to SubnetIds. 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.

      • You can't set address allocation IDs for servers that have an IpAddressType set to DUALSTACK You can only set this property if IpAddressType is set to IPV4.

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

    • subnetIds

      EndpointDetails.Builder subnetIds(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.

    • subnetIds

      EndpointDetails.Builder subnetIds(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.

    • vpcEndpointId

      EndpointDetails.Builder vpcEndpointId(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.

    • vpcId

      EndpointDetails.Builder vpcId(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.

    • securityGroupIds

      EndpointDetails.Builder securityGroupIds(Collection<String> securityGroupIds)

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

      While SecurityGroupIds appears in the response syntax for consistency with CreateServer and UpdateServer operations, this field is not populated in DescribeServer responses. Security groups are managed at the VPC endpoint level and can be modified outside of the Transfer Family service. To retrieve current security group information, use the EC2 DescribeVpcEndpoints API with the VpcEndpointId returned in the response.

      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.

      While SecurityGroupIds appears in the response syntax for consistency with CreateServer and UpdateServer operations, this field is not populated in DescribeServer responses. Security groups are managed at the VPC endpoint level and can be modified outside of the Transfer Family service. To retrieve current security group information, use the EC2 DescribeVpcEndpoints API with the VpcEndpointId returned in the response.

      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.

    • securityGroupIds

      EndpointDetails.Builder securityGroupIds(String... securityGroupIds)

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

      While SecurityGroupIds appears in the response syntax for consistency with CreateServer and UpdateServer operations, this field is not populated in DescribeServer responses. Security groups are managed at the VPC endpoint level and can be modified outside of the Transfer Family service. To retrieve current security group information, use the EC2 DescribeVpcEndpoints API with the VpcEndpointId returned in the response.

      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.

      While SecurityGroupIds appears in the response syntax for consistency with CreateServer and UpdateServer operations, this field is not populated in DescribeServer responses. Security groups are managed at the VPC endpoint level and can be modified outside of the Transfer Family service. To retrieve current security group information, use the EC2 DescribeVpcEndpoints API with the VpcEndpointId returned in the response.

      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.