Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see the Amazon Web Services PrivateLink Guide.
Synopsis
- data ModifyVpcEndpoint = ModifyVpcEndpoint' {
- addRouteTableIds :: Maybe [Text]
- addSecurityGroupIds :: Maybe [Text]
- addSubnetIds :: Maybe [Text]
- dnsOptions :: Maybe DnsOptionsSpecification
- dryRun :: Maybe Bool
- ipAddressType :: Maybe IpAddressType
- policyDocument :: Maybe Text
- privateDnsEnabled :: Maybe Bool
- removeRouteTableIds :: Maybe [Text]
- removeSecurityGroupIds :: Maybe [Text]
- removeSubnetIds :: Maybe [Text]
- resetPolicy :: Maybe Bool
- vpcEndpointId :: Text
- newModifyVpcEndpoint :: Text -> ModifyVpcEndpoint
- modifyVpcEndpoint_addRouteTableIds :: Lens' ModifyVpcEndpoint (Maybe [Text])
- modifyVpcEndpoint_addSecurityGroupIds :: Lens' ModifyVpcEndpoint (Maybe [Text])
- modifyVpcEndpoint_addSubnetIds :: Lens' ModifyVpcEndpoint (Maybe [Text])
- modifyVpcEndpoint_dnsOptions :: Lens' ModifyVpcEndpoint (Maybe DnsOptionsSpecification)
- modifyVpcEndpoint_dryRun :: Lens' ModifyVpcEndpoint (Maybe Bool)
- modifyVpcEndpoint_ipAddressType :: Lens' ModifyVpcEndpoint (Maybe IpAddressType)
- modifyVpcEndpoint_policyDocument :: Lens' ModifyVpcEndpoint (Maybe Text)
- modifyVpcEndpoint_privateDnsEnabled :: Lens' ModifyVpcEndpoint (Maybe Bool)
- modifyVpcEndpoint_removeRouteTableIds :: Lens' ModifyVpcEndpoint (Maybe [Text])
- modifyVpcEndpoint_removeSecurityGroupIds :: Lens' ModifyVpcEndpoint (Maybe [Text])
- modifyVpcEndpoint_removeSubnetIds :: Lens' ModifyVpcEndpoint (Maybe [Text])
- modifyVpcEndpoint_resetPolicy :: Lens' ModifyVpcEndpoint (Maybe Bool)
- modifyVpcEndpoint_vpcEndpointId :: Lens' ModifyVpcEndpoint Text
- data ModifyVpcEndpointResponse = ModifyVpcEndpointResponse' {
- return' :: Maybe Bool
- httpStatus :: Int
- newModifyVpcEndpointResponse :: Int -> ModifyVpcEndpointResponse
- modifyVpcEndpointResponse_return :: Lens' ModifyVpcEndpointResponse (Maybe Bool)
- modifyVpcEndpointResponse_httpStatus :: Lens' ModifyVpcEndpointResponse Int
Creating a Request
data ModifyVpcEndpoint Source #
Contains the parameters for ModifyVpcEndpoint.
See: newModifyVpcEndpoint
smart constructor.
ModifyVpcEndpoint' | |
|
Instances
Create a value of ModifyVpcEndpoint
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:addRouteTableIds:ModifyVpcEndpoint'
, modifyVpcEndpoint_addRouteTableIds
- (Gateway endpoint) One or more route tables IDs to associate with the
endpoint.
$sel:addSecurityGroupIds:ModifyVpcEndpoint'
, modifyVpcEndpoint_addSecurityGroupIds
- (Interface endpoint) One or more security group IDs to associate with
the network interface.
$sel:addSubnetIds:ModifyVpcEndpoint'
, modifyVpcEndpoint_addSubnetIds
- (Interface and Gateway Load Balancer endpoints) One or more subnet IDs
in which to serve the endpoint. For a Gateway Load Balancer endpoint,
you can specify only one subnet.
ModifyVpcEndpoint
, modifyVpcEndpoint_dnsOptions
- The DNS options for the endpoint.
$sel:dryRun:ModifyVpcEndpoint'
, modifyVpcEndpoint_dryRun
- 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
.
ModifyVpcEndpoint
, modifyVpcEndpoint_ipAddressType
- The IP address type for the endpoint.
ModifyVpcEndpoint
, modifyVpcEndpoint_policyDocument
- (Interface and gateway endpoints) A policy to attach to the endpoint
that controls access to the service. The policy must be in valid JSON
format.
ModifyVpcEndpoint
, modifyVpcEndpoint_privateDnsEnabled
- (Interface endpoint) Indicates whether a private hosted zone is
associated with the VPC.
$sel:removeRouteTableIds:ModifyVpcEndpoint'
, modifyVpcEndpoint_removeRouteTableIds
- (Gateway endpoint) One or more route table IDs to disassociate from the
endpoint.
$sel:removeSecurityGroupIds:ModifyVpcEndpoint'
, modifyVpcEndpoint_removeSecurityGroupIds
- (Interface endpoint) One or more security group IDs to disassociate from
the network interface.
$sel:removeSubnetIds:ModifyVpcEndpoint'
, modifyVpcEndpoint_removeSubnetIds
- (Interface endpoint) One or more subnets IDs in which to remove the
endpoint.
$sel:resetPolicy:ModifyVpcEndpoint'
, modifyVpcEndpoint_resetPolicy
- (Gateway endpoint) Specify true
to reset the policy document to the
default policy. The default policy allows full access to the service.
ModifyVpcEndpoint
, modifyVpcEndpoint_vpcEndpointId
- The ID of the endpoint.
Request Lenses
modifyVpcEndpoint_addRouteTableIds :: Lens' ModifyVpcEndpoint (Maybe [Text]) Source #
(Gateway endpoint) One or more route tables IDs to associate with the endpoint.
modifyVpcEndpoint_addSecurityGroupIds :: Lens' ModifyVpcEndpoint (Maybe [Text]) Source #
(Interface endpoint) One or more security group IDs to associate with the network interface.
modifyVpcEndpoint_addSubnetIds :: Lens' ModifyVpcEndpoint (Maybe [Text]) Source #
(Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
modifyVpcEndpoint_dnsOptions :: Lens' ModifyVpcEndpoint (Maybe DnsOptionsSpecification) Source #
The DNS options for the endpoint.
modifyVpcEndpoint_dryRun :: Lens' ModifyVpcEndpoint (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
.
modifyVpcEndpoint_ipAddressType :: Lens' ModifyVpcEndpoint (Maybe IpAddressType) Source #
The IP address type for the endpoint.
modifyVpcEndpoint_policyDocument :: Lens' ModifyVpcEndpoint (Maybe Text) Source #
(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format.
modifyVpcEndpoint_privateDnsEnabled :: Lens' ModifyVpcEndpoint (Maybe Bool) Source #
(Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.
modifyVpcEndpoint_removeRouteTableIds :: Lens' ModifyVpcEndpoint (Maybe [Text]) Source #
(Gateway endpoint) One or more route table IDs to disassociate from the endpoint.
modifyVpcEndpoint_removeSecurityGroupIds :: Lens' ModifyVpcEndpoint (Maybe [Text]) Source #
(Interface endpoint) One or more security group IDs to disassociate from the network interface.
modifyVpcEndpoint_removeSubnetIds :: Lens' ModifyVpcEndpoint (Maybe [Text]) Source #
(Interface endpoint) One or more subnets IDs in which to remove the endpoint.
modifyVpcEndpoint_resetPolicy :: Lens' ModifyVpcEndpoint (Maybe Bool) Source #
(Gateway endpoint) Specify true
to reset the policy document to the
default policy. The default policy allows full access to the service.
modifyVpcEndpoint_vpcEndpointId :: Lens' ModifyVpcEndpoint Text Source #
The ID of the endpoint.
Destructuring the Response
data ModifyVpcEndpointResponse Source #
See: newModifyVpcEndpointResponse
smart constructor.
ModifyVpcEndpointResponse' | |
|
Instances
newModifyVpcEndpointResponse Source #
Create a value of ModifyVpcEndpointResponse
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:return':ModifyVpcEndpointResponse'
, modifyVpcEndpointResponse_return
- Returns true
if the request succeeds; otherwise, it returns an error.
$sel:httpStatus:ModifyVpcEndpointResponse'
, modifyVpcEndpointResponse_httpStatus
- The response's http status code.
Response Lenses
modifyVpcEndpointResponse_return :: Lens' ModifyVpcEndpointResponse (Maybe Bool) Source #
Returns true
if the request succeeds; otherwise, it returns an error.
modifyVpcEndpointResponse_httpStatus :: Lens' ModifyVpcEndpointResponse Int Source #
The response's http status code.