NAME
Paws::Transfer::EndpointDetails
USAGE
This class represents one of two things:
Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::Transfer::EndpointDetails object:
$service_obj->Method(Att1 => { AddressAllocationIds => $value, ..., VpcId => $value });
Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::Transfer::EndpointDetails object:
$result = $service_obj->Method(...);
$result->Att1->AddressAllocationIds
DESCRIPTION
The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the UpdateServer
API and attach an Elastic IP address to your server's endpoint.
After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT
in your Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT
in your Amazon Web Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use EndpointType
=VPC
.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
ATTRIBUTES
AddressAllocationIds => ArrayRef[Str|Undef]
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 => ArrayRef[Str|Undef]
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 (https://docs.aws.amazon.com/transfer/latest/userguide/API_UpdateServer.html) 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 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyVpcEndpoint.html) API.
SubnetIds => ArrayRef[Str|Undef]
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 => Str
The ID of the VPC endpoint.
This property can only be set when EndpointType
is set to VPC_ENDPOINT
.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
VpcId => Str
The VPC ID of the VPC in which a server's endpoint will be hosted.
This property can only be set when EndpointType
is set to VPC
.
SEE ALSO
This class forms part of Paws, describing an object used in Paws::Transfer
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues