« blib/lib/Paws/Transfer/DescribedUser.pm
↑ Summary
blib/lib/Paws/Transfer/HomeDirectoryMapEntry.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Transfer::EndpointDetails; | ||
| 3 | use Moose; | ||
| 4 | has AddressAllocationIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has SecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | has SubnetIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 7 | has VpcEndpointId => (is => 'ro', isa => 'Str'); | ||
| 8 | has VpcId => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::Transfer::EndpointDetails | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::Transfer::EndpointDetails object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { AddressAllocationIds => $value, ..., VpcId => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::Transfer::EndpointDetails object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->AddressAllocationIds | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | The virtual private cloud (VPC) endpoint settings that are configured | ||
| 41 | for your file transfer protocol-enabled server. With a VPC endpoint, | ||
| 42 | you can restrict access to your server and resources only within your | ||
| 43 | VPC. To control incoming internet traffic, invoke the C<UpdateServer> | ||
| 44 | API and attach an Elastic IP address to your server's endpoint. | ||
| 45 | |||
| 46 | After May 19, 2021, you won't be able to create a server using | ||
| 47 | C<EndpointType=VPC_ENDPOINT> in your Amazon Web Servicesaccount if your | ||
| 48 | account hasn't already done so before May 19, 2021. If you have already | ||
| 49 | created servers with C<EndpointType=VPC_ENDPOINT> in your Amazon Web | ||
| 50 | Servicesaccount on or before May 19, 2021, you will not be affected. | ||
| 51 | After this date, use C<EndpointType>=C<VPC>. | ||
| 52 | |||
| 53 | For more information, see | ||
| 54 | https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint. | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 AddressAllocationIds => ArrayRef[Str|Undef] | ||
| 60 | |||
| 61 | A list of address allocation IDs that are required to attach an Elastic | ||
| 62 | IP address to your server's endpoint. | ||
| 63 | |||
| 64 | This property can only be set when C<EndpointType> is set to C<VPC> and | ||
| 65 | it is only valid in the C<UpdateServer> API. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 SecurityGroupIds => ArrayRef[Str|Undef] | ||
| 69 | |||
| 70 | A list of security groups IDs that are available to attach to your | ||
| 71 | server's endpoint. | ||
| 72 | |||
| 73 | This property can only be set when C<EndpointType> is set to C<VPC>. | ||
| 74 | |||
| 75 | You can edit the C<SecurityGroupIds> property in the UpdateServer | ||
| 76 | (https://docs.aws.amazon.com/transfer/latest/userguide/API_UpdateServer.html) | ||
| 77 | API only if you are changing the C<EndpointType> from C<PUBLIC> or | ||
| 78 | C<VPC_ENDPOINT> to C<VPC>. To change security groups associated with | ||
| 79 | your server's VPC endpoint after creation, use the Amazon EC2 | ||
| 80 | ModifyVpcEndpoint | ||
| 81 | (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyVpcEndpoint.html) | ||
| 82 | API. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 SubnetIds => ArrayRef[Str|Undef] | ||
| 86 | |||
| 87 | A list of subnet IDs that are required to host your server endpoint in | ||
| 88 | your VPC. | ||
| 89 | |||
| 90 | This property can only be set when C<EndpointType> is set to C<VPC>. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 VpcEndpointId => Str | ||
| 94 | |||
| 95 | The ID of the VPC endpoint. | ||
| 96 | |||
| 97 | This property can only be set when C<EndpointType> is set to | ||
| 98 | C<VPC_ENDPOINT>. | ||
| 99 | |||
| 100 | For more information, see | ||
| 101 | https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 VpcId => Str | ||
| 105 | |||
| 106 | The VPC ID of the VPC in which a server's endpoint will be hosted. | ||
| 107 | |||
| 108 | This property can only be set when C<EndpointType> is set to C<VPC>. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head1 SEE ALSO | ||
| 113 | |||
| 114 | This class forms part of L<Paws>, describing an object used in L<Paws::Transfer> | ||
| 115 | |||
| 116 | =head1 BUGS and CONTRIBUTIONS | ||
| 117 | |||
| 118 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 119 | |||
| 120 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 121 | |||
| 122 | =cut | ||
| 123 |