software.amazon.awscdk.services.transfer

Interface CfnServer.EndpointDetailsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServer.EndpointDetailsProperty.Jsii$Proxy

Enclosing class:

CfnServer

@Stability(value=Stable)
public static interface CfnServer.EndpointDetailsProperty
extends software.amazon.jsii.JsiiSerializable

The virtual private cloud (VPC) endpoint settings that are configured for your server.

When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.transfer.*;
 EndpointDetailsProperty endpointDetailsProperty = EndpointDetailsProperty.builder()
         .addressAllocationIds(List.of("addressAllocationIds"))
         .securityGroupIds(List.of("securityGroupIds"))
         .subnetIds(List.of("subnetIds"))
         .vpcEndpointId("vpcEndpointId")
         .vpcId("vpcId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnServer.EndpointDetailsProperty.Builder A builder for CfnServer.EndpointDetailsProperty
static class	CfnServer.EndpointDetailsProperty.Jsii$Proxy An implementation for CfnServer.EndpointDetailsProperty

Method Summary

Modifier and Type	Method and Description
static CfnServer.EndpointDetailsProperty.Builder	builder()
default List<String>	getAddressAllocationIds() A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.
default List<String>	getSecurityGroupIds() A list of security groups IDs that are available to attach to your server's endpoint.
default List<String>	getSubnetIds() A list of subnet IDs that are required to host your server endpoint in your VPC.
default String	getVpcEndpointId() The ID of the VPC endpoint.
default String	getVpcId() The VPC ID of the virtual private cloud in which the server's endpoint will be hosted.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAddressAllocationIds

@Stability(value=Stable)
 @Nullable
default 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.

getSecurityGroupIds

@Stability(value=Stable)
 @Nullable
default 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.

getSubnetIds

@Stability(value=Stable)
 @Nullable
default 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 .

getVpcEndpointId

@Stability(value=Stable)
 @Nullable
default String getVpcEndpointId()

The ID of the VPC endpoint.

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

getVpcId

@Stability(value=Stable)
 @Nullable
default String getVpcId()

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 .

builder

@Stability(value=Stable)
static CfnServer.EndpointDetailsProperty.Builder builder()

Returns:

a CfnServer.EndpointDetailsProperty.Builder of CfnServer.EndpointDetailsProperty