Class CfnServer.EndpointDetailsProperty
The virtual private cloud (VPC) endpoint settings that are configured for your server.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Transfer
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class EndpointDetailsProperty : Object, CfnServer.IEndpointDetailsProperty
Syntax (vb)
Public Class EndpointDetailsProperty
Inherits Object
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.
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() |
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()
public EndpointDetailsProperty()
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
System.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:
SecurityGroupIds
A list of security groups IDs that are available to attach to your server's endpoint.
public string[] SecurityGroupIds { get; set; }
Property Value
System.String[]
Remarks
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
A list of subnet IDs that are required to host your server endpoint in your VPC.
public string[] SubnetIds { get; set; }
Property Value
System.String[]
Remarks
This property can only be set when EndpointType
is set to VPC
.
VpcEndpointId
The ID of the VPC endpoint.
public string VpcEndpointId { get; set; }
Property Value
System.String
Remarks
This property can only be set when EndpointType
is set to VPC_ENDPOINT
.
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
System.String
Remarks
This property can only be set when EndpointType
is set to VPC
.