Class CfnServer.EndpointDetailsProperty

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

Inheritance

object

CfnServer.EndpointDetailsProperty

Implements

CfnServer.IEndpointDetailsProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Transfer

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnServer.EndpointDetailsProperty : CfnServer.IEndpointDetailsProperty

Syntax (vb)

Public Class CfnServer.EndpointDetailsProperty Implements CfnServer.IEndpointDetailsProperty

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Transfer;

             var endpointDetailsProperty = new EndpointDetailsProperty {
                 AddressAllocationIds = new [] { "addressAllocationIds" },
                 SecurityGroupIds = new [] { "securityGroupIds" },
                 SubnetIds = new [] { "subnetIds" },
                 VpcEndpointId = "vpcEndpointId",
                 VpcId = "vpcId"
             };

Synopsis

Constructors

EndpointDetailsProperty()

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

Properties

AddressAllocationIds	A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.
SecurityGroupIds	A list of security groups IDs that are available to attach to your server's endpoint.
SubnetIds	A list of subnet IDs that are required to host your server endpoint in your VPC.
VpcEndpointId	The ID of the VPC endpoint.
VpcId	The VPC ID of the virtual private cloud in which the server's endpoint will be hosted.

Constructors

EndpointDetailsProperty()

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

public EndpointDetailsProperty()

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Transfer;

             var endpointDetailsProperty = new EndpointDetailsProperty {
                 AddressAllocationIds = new [] { "addressAllocationIds" },
                 SecurityGroupIds = new [] { "securityGroupIds" },
                 SubnetIds = new [] { "subnetIds" },
                 VpcEndpointId = "vpcEndpointId",
                 VpcId = "vpcId"
             };

Properties

AddressAllocationIds

A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.

public string[]? AddressAllocationIds { get; set; }

Property Value

string[]

Remarks

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:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-addressallocationids

SecurityGroupIds

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

public string[]? SecurityGroupIds { get; set; }

Property Value

string[]

Remarks

While <code>SecurityGroupIds</code> appears in the response syntax for consistency with <code>CreateServer</code> and <code>UpdateServer</code> operations, this field is not populated in <code>DescribeServer</code> 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 <code>DescribeVpcEndpoints</code> API with the <code>VpcEndpointId</code> 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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-securitygroupids

SubnetIds

A list of subnet IDs that are required to host your server endpoint in your VPC.

public string[]? SubnetIds { get; set; }

Property Value

string[]

Remarks

This property can only be set when <code>EndpointType</code> is set to <code>VPC</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-subnetids

VpcEndpointId

The ID of the VPC endpoint.

public string? VpcEndpointId { get; set; }

Property Value

string

Remarks

This property can only be set when <code>EndpointType</code> is set to <code>VPC_ENDPOINT</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-vpcendpointid

VpcId

The VPC ID of the virtual private cloud in which the server's endpoint will be hosted.

public string? VpcId { get; set; }

Property Value

string

Remarks

This property can only be set when <code>EndpointType</code> is set to <code>VPC</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-vpcid

Implements

CfnServer.IEndpointDetailsProperty