Network.AWS.EC2.CreateVPCEndpoint

Creates a VPC endpoint for a specified AWS service. An endpoint enables you to create a private connection between your VPC and another AWS service in your account. You can create a gateway endpoint or an interface endpoint.

A gateway endpoint serves as a target for a route in your route table for traffic destined for the AWS service. You can specify the VPC route tables that use the endpoint, and you can optionally specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC.

An interface endpoint is a network interface in your subnet with a private IP address that serves as an entry point for traffic destined to the AWS service. You can specify the subnets in which to create an endpoint, and the security groups to associate with the network interface.

Creating a Request

createVPCEndpoint

Arguments

:: Text

cveVPCId

-> Text

cveServiceName

-> CreateVPCEndpoint

Creates a value of CreateVPCEndpoint with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cvePolicyDocument - (Gateway endpoint) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.
• cveSecurityGroupIds - (Interface endpoint) The ID of one or more security groups to associate with the network interface.
• cveClientToken - Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .
• cveSubnetIds - (Interface endpoint) The ID of one or more subnets in which to create a network interface for the endpoint.
• cveVPCEndpointType - The type of endpoint. If not specified, the default is a gateway endpoint.
• cvePrivateDNSEnabled - (Interface endpoint) Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the region (for example, kinesis.us-east-1.amazonaws.com ) which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service. To use a private hosted zone, you must set the following VPC attributes to true : enableDnsHostnames and enableDnsSupport . Use ModifyVpcAttribute to set the VPC attributes. Default: true
• cveDryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .
• cveRouteTableIds - (Gateway endpoint) One or more route table IDs.
• cveVPCId - The ID of the VPC in which the endpoint will be used.
• cveServiceName - The AWS service name, in the form com.amazonaws.region .service . To get a list of available services, use the DescribeVpcEndpointServices request.

data CreateVPCEndpoint

Contains the parameters for CreateVpcEndpoint.

See: createVPCEndpoint smart constructor.

Instances

Eq CreateVPCEndpoint

Methods

(==) :: CreateVPCEndpoint -> CreateVPCEndpoint -> Bool

(/=) :: CreateVPCEndpoint -> CreateVPCEndpoint -> Bool

Data CreateVPCEndpoint

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateVPCEndpoint -> c CreateVPCEndpoint

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateVPCEndpoint

toConstr :: CreateVPCEndpoint -> Constr

dataTypeOf :: CreateVPCEndpoint -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateVPCEndpoint)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateVPCEndpoint)

gmapT :: (forall b. Data b => b -> b) -> CreateVPCEndpoint -> CreateVPCEndpoint

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateVPCEndpoint -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateVPCEndpoint -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateVPCEndpoint -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateVPCEndpoint -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateVPCEndpoint -> m CreateVPCEndpoint

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateVPCEndpoint -> m CreateVPCEndpoint

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateVPCEndpoint -> m CreateVPCEndpoint

Read CreateVPCEndpoint

Methods

readsPrec :: Int -> ReadS CreateVPCEndpoint

readList :: ReadS [CreateVPCEndpoint]

readPrec :: ReadPrec CreateVPCEndpoint

readListPrec :: ReadPrec [CreateVPCEndpoint]

Show CreateVPCEndpoint

Methods

showsPrec :: Int -> CreateVPCEndpoint -> ShowS

show :: CreateVPCEndpoint -> String

showList :: [CreateVPCEndpoint] -> ShowS

Generic CreateVPCEndpoint

Associated Types

type Rep CreateVPCEndpoint :: * -> *

Methods

from :: CreateVPCEndpoint -> Rep CreateVPCEndpoint x

to :: Rep CreateVPCEndpoint x -> CreateVPCEndpoint

Hashable CreateVPCEndpoint

Methods

hashWithSalt :: Int -> CreateVPCEndpoint -> Int

hash :: CreateVPCEndpoint -> Int

NFData CreateVPCEndpoint

Methods

rnf :: CreateVPCEndpoint -> ()

AWSRequest CreateVPCEndpoint

Associated Types

type Rs CreateVPCEndpoint :: *

Methods

request :: CreateVPCEndpoint -> Request CreateVPCEndpoint

response :: MonadResource m => Logger -> Service -> Proxy * CreateVPCEndpoint -> ClientResponse -> m (Response CreateVPCEndpoint)

ToQuery CreateVPCEndpoint

Methods

toQuery :: CreateVPCEndpoint -> QueryString

ToPath CreateVPCEndpoint

Methods

toPath :: CreateVPCEndpoint -> ByteString

ToHeaders CreateVPCEndpoint

Methods

toHeaders :: CreateVPCEndpoint -> [Header]

type Rep CreateVPCEndpoint

type Rep CreateVPCEndpoint = D1 (MetaData "CreateVPCEndpoint" "Network.AWS.EC2.CreateVPCEndpoint" "amazonka-ec2-1.5.0-8IdXK3SzsETDMW2aFpANS9" False) (C1 (MetaCons "CreateVPCEndpoint'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cvePolicyDocument") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cveSecurityGroupIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_cveClientToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_cveSubnetIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_cveVPCEndpointType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VPCEndpointType)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cvePrivateDNSEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_cveDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_cveRouteTableIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_cveVPCId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cveServiceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))

type Rs CreateVPCEndpoint

type Rs CreateVPCEndpoint = CreateVPCEndpointResponse

Request Lenses

cvePolicyDocument :: Lens' CreateVPCEndpoint (Maybe Text)

(Gateway endpoint) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.

cveSecurityGroupIds :: Lens' CreateVPCEndpoint [Text]

(Interface endpoint) The ID of one or more security groups to associate with the network interface.

cveClientToken :: Lens' CreateVPCEndpoint (Maybe Text)

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .

cveSubnetIds :: Lens' CreateVPCEndpoint [Text]

(Interface endpoint) The ID of one or more subnets in which to create a network interface for the endpoint.

cveVPCEndpointType :: Lens' CreateVPCEndpoint (Maybe VPCEndpointType)

The type of endpoint. If not specified, the default is a gateway endpoint.

cvePrivateDNSEnabled :: Lens' CreateVPCEndpoint (Maybe Bool)

(Interface endpoint) Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the region (for example, kinesis.us-east-1.amazonaws.com ) which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service. To use a private hosted zone, you must set the following VPC attributes to true : enableDnsHostnames and enableDnsSupport . Use ModifyVpcAttribute to set the VPC attributes. Default: true

cveDryRun :: Lens' CreateVPCEndpoint (Maybe Bool)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

cveRouteTableIds :: Lens' CreateVPCEndpoint [Text]

(Gateway endpoint) One or more route table IDs.

cveVPCId :: Lens' CreateVPCEndpoint Text

The ID of the VPC in which the endpoint will be used.

cveServiceName :: Lens' CreateVPCEndpoint Text

The AWS service name, in the form com.amazonaws.region .service . To get a list of available services, use the DescribeVpcEndpointServices request.

Destructuring the Response

createVPCEndpointResponse

Arguments

:: Int

cversResponseStatus

-> CreateVPCEndpointResponse

Creates a value of CreateVPCEndpointResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cversClientToken - Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
• cversVPCEndpoint - Information about the endpoint.
• cversResponseStatus - -- | The response status code.

data CreateVPCEndpointResponse

Contains the output of CreateVpcEndpoint.

See: createVPCEndpointResponse smart constructor.

Instances

Eq CreateVPCEndpointResponse

Methods

(==) :: CreateVPCEndpointResponse -> CreateVPCEndpointResponse -> Bool

(/=) :: CreateVPCEndpointResponse -> CreateVPCEndpointResponse -> Bool

Data CreateVPCEndpointResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateVPCEndpointResponse -> c CreateVPCEndpointResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateVPCEndpointResponse

toConstr :: CreateVPCEndpointResponse -> Constr

dataTypeOf :: CreateVPCEndpointResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateVPCEndpointResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateVPCEndpointResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateVPCEndpointResponse -> CreateVPCEndpointResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateVPCEndpointResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateVPCEndpointResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateVPCEndpointResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateVPCEndpointResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateVPCEndpointResponse -> m CreateVPCEndpointResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateVPCEndpointResponse -> m CreateVPCEndpointResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateVPCEndpointResponse -> m CreateVPCEndpointResponse

Read CreateVPCEndpointResponse

Methods

readsPrec :: Int -> ReadS CreateVPCEndpointResponse

readList :: ReadS [CreateVPCEndpointResponse]

readPrec :: ReadPrec CreateVPCEndpointResponse

readListPrec :: ReadPrec [CreateVPCEndpointResponse]

Show CreateVPCEndpointResponse

Methods

showsPrec :: Int -> CreateVPCEndpointResponse -> ShowS

show :: CreateVPCEndpointResponse -> String

showList :: [CreateVPCEndpointResponse] -> ShowS

Generic CreateVPCEndpointResponse

Associated Types

type Rep CreateVPCEndpointResponse :: * -> *

Methods

from :: CreateVPCEndpointResponse -> Rep CreateVPCEndpointResponse x

to :: Rep CreateVPCEndpointResponse x -> CreateVPCEndpointResponse

NFData CreateVPCEndpointResponse

Methods

rnf :: CreateVPCEndpointResponse -> ()

type Rep CreateVPCEndpointResponse

type Rep CreateVPCEndpointResponse = D1 (MetaData "CreateVPCEndpointResponse" "Network.AWS.EC2.CreateVPCEndpoint" "amazonka-ec2-1.5.0-8IdXK3SzsETDMW2aFpANS9" False) (C1 (MetaCons "CreateVPCEndpointResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cversClientToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_cversVPCEndpoint") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VPCEndpoint))) (S1 (MetaSel (Just Symbol "_cversResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

cversClientToken :: Lens' CreateVPCEndpointResponse (Maybe Text)

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

cversVPCEndpoint :: Lens' CreateVPCEndpointResponse (Maybe VPCEndpoint)

Information about the endpoint.

cversResponseStatus :: Lens' CreateVPCEndpointResponse Int

• - | The response status code.