Package software.amazon.awscdk.services.transfer

Class CfnServer.EndpointDetailsProperty.Builder

java.lang.Object
software.amazon.awscdk.services.transfer.CfnServer.EndpointDetailsProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnServer.EndpointDetailsProperty>
Enclosing interface:
CfnServer.EndpointDetailsProperty
@Stability(Stable) public static final class CfnServer.EndpointDetailsProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnServer.EndpointDetailsProperty>
A builder for CfnServer.EndpointDetailsProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • addressAllocationIds

      @Stability(Stable) public CfnServer.EndpointDetailsProperty.Builder addressAllocationIds(List<String> addressAllocationIds)
      Sets the value of CfnServer.EndpointDetailsProperty.getAddressAllocationIds()
      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:
      this

    • securityGroupIds

      @Stability(Stable) public CfnServer.EndpointDetailsProperty.Builder securityGroupIds(List<String> securityGroupIds)
      Sets the value of CfnServer.EndpointDetailsProperty.getSecurityGroupIds()
      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:
      this

    • subnetIds

      @Stability(Stable) public CfnServer.EndpointDetailsProperty.Builder subnetIds(List<String> subnetIds)
      Sets the value of CfnServer.EndpointDetailsProperty.getSubnetIds()
      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:
      this

    • vpcEndpointId

      @Stability(Stable) public CfnServer.EndpointDetailsProperty.Builder vpcEndpointId(String vpcEndpointId)
      Sets the value of CfnServer.EndpointDetailsProperty.getVpcEndpointId()
      Parameters:
      vpcEndpointId - The ID of the VPC endpoint.

      This property can only be set when EndpointType is set to VPC_ENDPOINT .

      Returns:
      this

    • vpcId

      @Stability(Stable) public CfnServer.EndpointDetailsProperty.Builder vpcId(String vpcId)
      Sets the value of CfnServer.EndpointDetailsProperty.getVpcId()
      Parameters:
      vpcId - The VPC ID of the virtual private cloud in which the server's endpoint will be hosted.

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

      Returns:
      this

    • build

      @Stability(Stable) public CfnServer.EndpointDetailsProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnServer.EndpointDetailsProperty>
      Returns:
      a new instance of CfnServer.EndpointDetailsProperty
      Throws:
      NullPointerException - if any required attribute was not provided