1.204.0

interface EndpointDetailsProperty

LanguageType name
.NETAmazon.CDK.AWS.Transfer.CfnServer.EndpointDetailsProperty
Javasoftware.amazon.awscdk.services.transfer.CfnServer.EndpointDetailsProperty
Pythonaws_cdk.aws_transfer.CfnServer.EndpointDetailsProperty
TypeScript @aws-cdk/aws-transfer » CfnServer » EndpointDetailsProperty

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

When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint 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 * as transfer from '@aws-cdk/aws-transfer';
const endpointDetailsProperty: transfer.CfnServer.EndpointDetailsProperty = {
  addressAllocationIds: ['addressAllocationIds'],
  securityGroupIds: ['securityGroupIds'],
  subnetIds: ['subnetIds'],
  vpcEndpointId: 'vpcEndpointId',
  vpcId: 'vpcId',
};

Properties

NameTypeDescription
addressAllocationIds?string[]A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.
securityGroupIds?string[]A list of security groups IDs that are available to attach to your server's endpoint.
subnetIds?string[]A list of subnet IDs that are required to host your server endpoint in your VPC.
vpcEndpointId?stringThe ID of the VPC endpoint.
vpcId?stringThe VPC ID of the virtual private cloud in which the server's endpoint will be hosted.

addressAllocationIds?

Type: string[] (optional)

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.

securityGroupIds?

Type: string[] (optional)

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.

subnetIds?

Type: string[] (optional)

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?

Type: string (optional)

The ID of the VPC endpoint.

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

vpcId?

Type: string (optional)

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 .

← PreviousNext →