Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Transfer.Types.EndpointDetails

Description

Synopsis

Documentation

data EndpointDetails Source #

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.

See: newEndpointDetails smart constructor.

Constructors

EndpointDetails'

Fields

securityGroupIds :: Maybe [Text]
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 :: Maybe [Text]
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.
vpcId :: Maybe Text
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.
addressAllocationIds :: Maybe [Text]
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.
vpcEndpointId :: Maybe Text
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.

Instances

Instances details

Eq EndpointDetails Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointDetails Methods (==) :: EndpointDetails -> EndpointDetails -> Bool # (/=) :: EndpointDetails -> EndpointDetails -> Bool #
Read EndpointDetails Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointDetails Methods readsPrec :: Int -> ReadS EndpointDetails # readList :: ReadS [EndpointDetails] # readPrec :: ReadPrec EndpointDetails # readListPrec :: ReadPrec [EndpointDetails] #
Show EndpointDetails Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointDetails Methods showsPrec :: Int -> EndpointDetails -> ShowS # show :: EndpointDetails -> String # showList :: [EndpointDetails] -> ShowS #
Generic EndpointDetails Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointDetails Associated Types type Rep EndpointDetails :: Type -> Type # Methods from :: EndpointDetails -> Rep EndpointDetails x # to :: Rep EndpointDetails x -> EndpointDetails #
NFData EndpointDetails Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointDetails Methods rnf :: EndpointDetails -> () #
Hashable EndpointDetails Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointDetails Methods hashWithSalt :: Int -> EndpointDetails -> Int # hash :: EndpointDetails -> Int #
ToJSON EndpointDetails Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointDetails Methods toJSON :: EndpointDetails -> Value # toEncoding :: EndpointDetails -> Encoding # toJSONList :: [EndpointDetails] -> Value # toEncodingList :: [EndpointDetails] -> Encoding #
FromJSON EndpointDetails Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointDetails Methods parseJSON :: Value -> Parser EndpointDetails # parseJSONList :: Value -> Parser [EndpointDetails] #
type Rep EndpointDetails Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointDetails type Rep EndpointDetails = D1 ('MetaData "EndpointDetails" "Amazonka.Transfer.Types.EndpointDetails" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "EndpointDetails'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "addressAllocationIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "vpcEndpointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newEndpointDetails :: EndpointDetails Source #

Create a value of EndpointDetails with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:securityGroupIds:EndpointDetails', endpointDetails_securityGroupIds - 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.

$sel:subnetIds:EndpointDetails', endpointDetails_subnetIds - 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.

$sel:vpcId:EndpointDetails', endpointDetails_vpcId - 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.

$sel:addressAllocationIds:EndpointDetails', endpointDetails_addressAllocationIds - 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.

$sel:vpcEndpointId:EndpointDetails', endpointDetails_vpcEndpointId - 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.

endpointDetails_securityGroupIds :: Lens' EndpointDetails (Maybe [Text]) Source #

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.

endpointDetails_subnetIds :: Lens' EndpointDetails (Maybe [Text]) Source #

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.

endpointDetails_vpcId :: Lens' EndpointDetails (Maybe Text) Source #

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.

endpointDetails_addressAllocationIds :: Lens' EndpointDetails (Maybe [Text]) Source #

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.

endpointDetails_vpcEndpointId :: Lens' EndpointDetails (Maybe Text) Source #

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.