Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Creates a VPC endpoint for a specified service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by AWS, an AWS Marketplace partner, or another AWS account. For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide .
A gateway
endpoint serves as a target for a route in your route table for traffic destined for the AWS service. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint.
An interface
endpoint is a network interface in your subnet that serves as an endpoint for communicating with the specified service. You can specify the subnets in which to create an endpoint, and the security groups to associate with the endpoint network interface.
Use DescribeVpcEndpointServices
to get a list of supported services.
Synopsis
- createVPCEndpoint :: Text -> Text -> CreateVPCEndpoint
- data CreateVPCEndpoint
- cvePolicyDocument :: Lens' CreateVPCEndpoint (Maybe Text)
- cveSecurityGroupIds :: Lens' CreateVPCEndpoint [Text]
- cveClientToken :: Lens' CreateVPCEndpoint (Maybe Text)
- cveSubnetIds :: Lens' CreateVPCEndpoint [Text]
- cveVPCEndpointType :: Lens' CreateVPCEndpoint (Maybe VPCEndpointType)
- cvePrivateDNSEnabled :: Lens' CreateVPCEndpoint (Maybe Bool)
- cveDryRun :: Lens' CreateVPCEndpoint (Maybe Bool)
- cveRouteTableIds :: Lens' CreateVPCEndpoint [Text]
- cveVPCId :: Lens' CreateVPCEndpoint Text
- cveServiceName :: Lens' CreateVPCEndpoint Text
- createVPCEndpointResponse :: Int -> CreateVPCEndpointResponse
- data CreateVPCEndpointResponse
- cversClientToken :: Lens' CreateVPCEndpointResponse (Maybe Text)
- cversVPCEndpoint :: Lens' CreateVPCEndpointResponse (Maybe VPCEndpoint)
- cversResponseStatus :: Lens' CreateVPCEndpointResponse Int
Creating a Request
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 endpoint 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 an endpoint network interface.cveVPCEndpointType
- The type of endpoint. Default: GatewaycvePrivateDNSEnabled
- (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 totrue
:enableDnsHostnames
andenableDnsSupport
. UseModifyVpcAttribute
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 isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.cveRouteTableIds
- (Gateway endpoint) One or more route table IDs.cveVPCId
- The ID of the VPC in which the endpoint will be used.cveServiceName
- The service name. To get a list of available services, use theDescribeVpcEndpointServices
request, or get the name from the service provider.
data CreateVPCEndpoint Source #
Contains the parameters for CreateVpcEndpoint.
See: createVPCEndpoint
smart constructor.
Instances
Request Lenses
cvePolicyDocument :: Lens' CreateVPCEndpoint (Maybe Text) Source #
(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] Source #
(Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.
cveClientToken :: Lens' CreateVPCEndpoint (Maybe Text) Source #
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] Source #
(Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.
cveVPCEndpointType :: Lens' CreateVPCEndpoint (Maybe VPCEndpointType) Source #
The type of endpoint. Default: Gateway
cvePrivateDNSEnabled :: Lens' CreateVPCEndpoint (Maybe Bool) Source #
(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) Source #
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] Source #
(Gateway endpoint) One or more route table IDs.
cveVPCId :: Lens' CreateVPCEndpoint Text Source #
The ID of the VPC in which the endpoint will be used.
cveServiceName :: Lens' CreateVPCEndpoint Text Source #
The service name. To get a list of available services, use the DescribeVpcEndpointServices
request, or get the name from the service provider.
Destructuring the Response
createVPCEndpointResponse Source #
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 Source #
Contains the output of CreateVpcEndpoint.
See: createVPCEndpointResponse
smart constructor.
Instances
Response Lenses
cversClientToken :: Lens' CreateVPCEndpointResponse (Maybe Text) Source #
Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
cversVPCEndpoint :: Lens' CreateVPCEndpointResponse (Maybe VPCEndpoint) Source #
Information about the endpoint.
cversResponseStatus :: Lens' CreateVPCEndpointResponse Int Source #
- - | The response status code.